System Monitoring Library Windows driver software for Classembly Devices

Transcription

1 IFCPMGR.WIN System Monitoring Library Windows driver software for Classembly Devices

2 Contents Chapter 1 Introduction Overview Features...3 Chapter 2 Product Specifications Functional Specifications Product Composition...5 Chapter 3 Programming Guide Installation Class Library Programming Guide...7 Chapter 4 Reference List of DLL Function Reference Callback Function Structure Return Values Chapter 5 Sample Programs Execution Procedure Compiling Files List of Sample Programs Chapter 6 Utility Programs Brightness and Volume Control Utility program Interface Utility Chapter 7 Terms of Use 135 2

3 Chapter 1 Introduction 1.1 Overview System monitoring library monitors Interface Classembly Devices(R) by an application program running on Windows. The application program links a provided dynamic link library (DLL) and monitors the system through the application programming interface (API). 1.2 Features - Starting, stopping, and time-out time of the watchdog timer (WDT) are freely configurable by software. - If the WDT is not cleared within the specified time-out time, either a CPU reset or an interrupt event can be generated. - Temperatures of the CPU and printed circuit board (PCB) can be retrieved. - An interrupt event is generated when the temperature of CPU or PCB exceeds the specified upper or lower limit. - A voltage of a power supply can be retrieved. - An interrupt event is generated when abnormal voltage of the power supply is detected. - Multi-process processing is supported. One or more programs can simultaneously monitor the system. - Sample programs for WDT, temperature monitoring, power supply voltage monitoring, interrupt event notification, RAS output, digital input/output, and key matrix input are included. - An RAS signal is asserted when an abnormal status is detected by configuring the conditions beforehand. The application program can also control the output. - Digital input/output function is supported. - Brightness control and volume control are supported. - Illuminance can be retrieved. - Brightness can be automatically adjusted according to illuminance. - By connecting an optional battery module, the operation at power failure can be configured. The status of the battery module can be retrieved. - Status and information of the battery can be simulated. - Ready-to-use utilities for WDT control, temperature monitoring, power voltage monitoring, RAS output, digital input/output, battery monitoring, and RAID information are included. The utilities save logs for purposes of failure analysis and prediction. 3

4 Chapter 2 Product Specifications 2.1 Functional Specifications Function WDT (watchdog - Time-out time: 1 second to 255 seconds (in every 1 second) timer) -Action of time-out: CPU reset or interrupt event notification Temperature monitoring - Target: CPU temperature and PCB temperature - Upper/lower limit: -60 degrees C to 125 degrees C (in every 1 degree C) Power supply voltage monitoring - Target: power supply voltage -Abnormal voltage of power supply: out of the range from 7 Vdc through + 27 Vdc (high-voltage products: out of the range from 10 Vdc through 37 Vdc) Interrupt event - WDT is timed-out. - A CPU temperature is over the upper limit. - A CPU temperature is below the lower limit. - A PCB temperature is over the upper limit. - A PCB temperature is below the lower limit. - A power supply voltage is abnormal. RAS output* - Output control by a program - A RAS signal is asserted when the following errors occur. -- WDT is timed-out. -- A CPU temperature is over the upper limit. -- A CPU temperature is below the lower limit. -- A PCB temperature is over the upper limit. -- A PCB temperature is below the lower limit. -- A power supply voltage is abnormal. Others* - Digital input/output, key matrix input - Brightness control - Volume control - Illuminance retrieval Battery* (Option) - Target: battery status - Interval time between events at power failure Time between occurrence of power failure and start of shutdown: The configurable range is from 0 second through 255 seconds (in every 1 second). If 0 is specified, shutdown or forced power off does not occur. Time between start of shutdown and forced power off: The configurable range is from 0 second through 255 seconds (in every 1 second). If 0 is specified, forced power off does not occur. - Status simulation function RAID(*) - RAID status is retrieved - Change of RAID status is retrieved - The utility program displays the status and saves logs. Some models does not support the functions described above. Refer to the manual for supported functions. 4

5 2.2 Product Composition Item File Name Description Latest information README.HTM Latest information Installer SETUP.EXE Installation program Sample programs wdt Watchdog timer sample program temperature Temperature monitoring sample program power Power supply voltage monitoring sample program event WDT interrupt event notification sample program rasout RAS output sample program dio Digital input/output sample program bat Battery module monitoring sample program matrix Key matrix input sample program illuminance Illuminance monitoring sample program IFCCPMGR Class library source for Visual C#.NET and Visual Basic.NET Utility programs BVConfig.EXE Brightness and volume control utility IFUtil.exe Interface Utility IF*.DLL Interface Utility library IF*.ini Configuration file for Interface Utility DLL IFCPMGR.DLL Dynamic link library file IFCPMGR.LIB Import library file Device drivers IFCPMGR.SYS Driver for Windows 2000 and later versions IFCPDIO.SYS Driver for Windows 2000 and later versions Header files IFCPMGR.H Header file for Visual C++ IFCPMGR.BAS Header file for Visual Basic Help HELP.PDF Help (PDF file) Note: * Sample programs for Visual C#.NET and Visual Basic.NET are built with Visual C#.NET 2003 and Visual Basic.NET 2003, respectively. 5

6 Chapter 3 Programming Guide 3.1 Installation Refer to README.HTM for installation. 3.2 Class Library This product includes the source files of the class library. Creating the class library from the source files makes it easier to define DLL functions. (To customize DLL function call, refer to the class library sources.) 1. Creating a Class Library You need to prepare the class library before you use the DLL functions on.net. Visual C#.NET 1. Start Visual Studio. 2. Open the following project file. <installation destination> interface IFCPMGR samples CS_NET IFCCPMGR IFCCPMGR.csproj After building the project file, IFCCPMGR.DLL is created in the bin folder. Visual Basic.NET 1. Start Visual Studio. 2. Open the following project file. <installation destination> interface IFCPMGR samples VB_NET IFCCPMGR IFCCPMGR.vbproj After building the project file, IFCCPMGR.DLL is created in the bin folder 2. Adding Class Library Reference Visual C#.NET and Visual Basic.NET 1. Start Visual Studio. 2. Select Project > Add Reference. 3. Click the Browse button. 4. Specify the class library DLL to refer. <installation destination> interface IFCPMGR samples CS_NET IFCCPMGR bin Release ifccpmgr.dll <installation destination> interface IFCPMGR samples VB_NET IFCCPMGR bin Relaase ifccpmgr.dll 5. The DLL file will be displayed in Selected Components. 6. Click OK. 7. Add the namespace of InterfaceCorpDllWrap as below at the header of your source file to call the DLL functions. Visual C#.NET using InterfaceCorpDllWrap; Visual Basic.NET Imports InterfaceCorpDllWrap 6

7 3.3 Programming Guide This section explains basic control instructions. The examples are written in C WDT Follow the instructions below to use the WDT. 1. Specify a time-out time of the WDT and an action at the time-out error (CPU reset or interrupt event notification). 2. Start the WDT. 3. Clear the WDT before it reaches the time-out time. Use the CmSetWDTConfig function to specify a time-out time of the WDT and an action at the time-out error. UINT Ret; // CPU is reset if the value is not cleared for 50 s. Ret = CmSetWDTConfig(50, CM_WDT_ACT_RESET Use the CmStartWDT function to start the WDT. Ret = CmStartWDT( Use the CmClearWDT function to clear the WDT. Ret = CmClearWDT( Use the CmStopWDT function to stop the WDT. Ret = CmStopWDT( An interrupt event is generated at time-out error of WDT as well as CPU reset. Refer to Interrupt Event Handling for details. The table below describes the difference between interrupt event and CPU reset. WDT Processes Interrupt event CPU reset Applications The purpose of using interrupt event is to detect that a user program stops due to failure of the user program. Create a monitoring process separately from the user program that periodically clears the WDT. Register a WDT interrupt event in the monitoring process. When the user program cannot clear the WDT within the time-out time, the WDT interrupt event is generated in the monitoring process. So the monitoring process can detect that a failure occurred in the user program. The purpose of using CPU reset is to automatically recover the system from a fatal error like freeze. 7

8 3.3.2 Temperature Monitoring The CmGetTemp function retrieves a temperature of the CPU and PCB. UINT Ret; int CpuTemp; int BrdTemp; // CPU temperature is retrieved Ret = CmGetTemp(CM_TEMP_TARGET_CPU, &CpuTemp // PCB temperature is retrieved Ret = CmGetTemp(CM_TEMP_TARGET_BRD, &BrdTemp The retrieved temperatures may be negative. The unit is degree Celsius. * For Atom N2800 model, the CPU temperature can be retrieved in the range from 0 degrees C to 100 degrees C, and the accuracy is as follows. Termerature range Accuracy 60 degrees C to 100 degrees C < +/- 5 degrees C 25 degrees C to 60 degrees C < +/- 10 degrees C 0 degrees C to 25 degrees C The error can be greater than +/- 10 degrees C. Therefore, use a retrieved temperature only to indicate that the temperature is lower than 25 degrees C. By configuring the upper and lower limits of temperature, the function notifies an interrupt event when the temperature is out of the range. Refer to Interrupt Event Handling for details. For Sho-ene Classembly Devices Add-In model, Atom N2800 model, and BayTrail model, when the temperatures of any of CPU cores are out of the specified temperature range, the program generates an interrupt event. When the upper and lower limit temperature values are configured by the Interface Utility, the settings are loaded at start of the system. Refer to Temperature for more details. When a write-filter is enabled on storage, commit is needed to reflect the changes. When a write-protection is enabled on storage, disable the write-protection before change of settings is made. 8

9 3.3.3 Power Supply Voltage Monitoring The CmGetPower function retrieves a voltage of a power supply. UINT Ret; float Power; // A voltage of power supply is retrieved. Ret = CmGetPower(CM_POWER_TARGET_EXT, &Power The function generates an interrupt event when the power supply voltage is abnormal. Refer to Interrupt Event Handling for details. 9

10 3.3.4 Interrupt Event Handling Follow the instructions below to use interrupt events. 1. Configure conditions of each interrupt event (WDT time-out error, and upper/lower limit temperatures). 2. Register handling methods of the interrupt events including signal event, message, and callback function by the CmSetEvent function. 3. Configure an interrupt event mask by the CmSetEventMask function to enable the events. When the condition of the interrupt event source is satisfied, the interrupt event will be generated. The following example shows a setting that a callback function is called at event occurrence. (Enabling WDT time-out error, CPU temperature upper/lower limit, and power supply voltage error) // Callback function void CALLBACK UserCallback(PVOID User) { UINT Ret; UINT Factor; // Event source is retrieved Ret = CmGetEventFactor(&Factor // Processing each event } int main(void) { UINT Ret; CM_EVENT_REQ EventReq; // 0 degrees C for lower limit and 50 degrees C for upper limit of CPU temperature //are configured Ret = CmSetTempLimit(CM_TEMP_TARGET_CPU, 0, 50 // Event registration ZeroMemory(&EventReq, sizeof(cm_event_req) EventReq.CallBackProc = (LPCMCALLBACK)UserCallback; Ret = CmSetEvent(&EventReq // Event mask configuration (WDT, Upper/lower limit of CPU temperature, // power supply voltage) Ret = CmSetEventMask(CM_EVENT_WDS CM_EVENT_CPTHS CM_EVENT_CPTLS CM_EVENT_V27VA } 10

11 After the events are used, mask the events by the SetEventMask function, clear the event sources by the CmGetEventFactor function, and then release the interrupt events by the CmKillEvent function. UINT Ret; UINT Factor; // All interrupts are disabled Ret = CmSetEventMask(0 // Event source is cleared Ret = CmGetEventFactor(&Factor // Interrupts are released Ret = CmKillEvent( Refer to Chapter 5 Sample Programs to use functions other than the callback function. 11

12 3.3.5 RAS Output The RAS signal is asserted when an abnormal condition is detected. This function is available only on the hardware that supports RAS output function. Refer to the manual for supported functions. By setting the types of error detections and the pin status beforehand, the RAS signal is automatically asserted when an abnormal condition is detected. UINT Ret; // RAS output is initialized under the condition of relay off Ret = CmControlRO(CM_RO_OFF // RAS output is set to relay on when WDT and PCB temperature exceed // the upper limit Ret = CmSetROConfig(CM_ROCONF_WDS CM_ROCONF_CPTHS, CM_RO_ON The CmControlRO function can freely control the RAS output. When the system is turned on, RAS output turns the relay off. When the RAS output conditions are configured by the Interface Utility, the settings are loaded at start of the system. Refer to RasOut for more details. When a write-filter is enabled on storage, commit is needed to reflect the changes. When a write-protection is enabled on storage, disable the write-protection before change of settings is made. 12

13 3.3.6 Battery Module An action in the event of power failure can be configured and the battery status can be retrieved when an optional battery module is connected. The feature is enabled only when the battery module is connected. The interval time between occurrence of power failure and start of shutdown and between start of shutdown and forced power off are configurable in every 1 second by the CmSetPowerOffTime function. UINT Ret; // Power failure shutdown start: 16 seconds // Shutdown start forced shutdown: 180 seconds Ret = CmSetPowerOffTime(16, 180 At the factory default setting, the interval time between occurrence of power failure and start of shutdown is 16 seconds, and between start of shutdown and forced power off is 180 seconds. When the interval time between occurrence of power failure and start of shutdown and between start of shutdown and forced shutdown are configured by the Interface Utility, the settings are loaded at start of the system. Refer to Battery for more details. When a write-filter is enabled on storage, commit is needed to reflect the changes. When a write-protection is enabled on storage, disable the write-protection before change of settings is made. The battery status can be retrieved by the CmGetBatStatus function. UINT Ret; UINT Status; // Retrieving the battery status Ret = CmGetBatStatus(&Status The CmSetBatSimStatus function simulates status of the battery module. When the simulation function is enabled, the CmGetBatStatus function retrieves simulated status set by the CmSetBatSimStatus function instead of the actual status of the battery module. UINT Ret; UINT Status; // Retrieving the current battery status Ret = CmGetBatStatus(&Status // Enabling the simulation function of battery (ERR bit simulation) Ret = CmSetBatSimStatus(CM_BAT_SIM_ON, (Status 0x80) // Disabling the simulation function of battery Ret = CmSetBatSimStatus(CM_BAT_SIM_OFF, 0 The simulation function just simulates status and does not affect actual behaviors. For example, even if the simulation function sets the battery status to discharging, shutdown and/or forced power off do not occur after the interval time configured by the CmSetPowerOffTime function elapsed. When the operating system restarts with the battery function enabled, the simulation function is disabled. 13

14 Chapter 4 Reference 4.1 List of DLL Function No Function Description WDT 1 CmSetWDTConfig Configures a time-out time and an action at the time-out error. 2 CmGetWDTConfig Retrieves a time-out time and an action at the time-out error. 3 CmStartWDT Starts the WDT. 4 CmStopWDT Stops the WDT. 5 CmClearWDT Clears the WDT. Temperature monitoring 6 CmGetTemp Retrieves the current temperature of a specified target. 7 CmSetTempLimit Configures upper and lower limits of monitoring temperature of a specified target. 8 CmGetTempLimit Retrieves upper and lower limits of monitoring temperature of a specified target. 9 CmSetTempLimitEx Configures upper and lower limits and hysteresis of monitoring temperature of a specified target. 10 CmGetTempLimitEx Retrieves upper and lower limits and hysteresis of monitoring temperature of a specified target. Power supply voltage monitoring 11 CmGetPower Retrieves a voltage of a power supply. 12 CmSetPowerLimit Configures upper and lower limits of monitoring voltage of power supply of a specified target. 13 CmGetPowerLimit Retrieves upper and lower limits of monitoring voltage of power supply of a specified target. 14 CmSetDigitalFilter Configures a digital filter to detect an error of a voltage of power supply. 15 CmGetDigitalFilter Retrieves settings of a digital filter to detect an error of a voltage of power supply. Interrupt event 16 CmSetEvent Registers interrupt events. 17 CmKillEvent Deletes interrupt events. 18 CmSetEventMask Configures an event mask. 19 CmGetEventMask Retrieves an event mask. 20 CmGetEventFactor Retrieves an event source. Status 21 CmGetSpecifiedStatus Retrieves only requested status. 22 CmGetRaidStatus Retrieves a RAID status. RAS output 23 CmControlRO Controls RAS output status. 24 CmSetROConfig Configures abnormal conditions of automatic RAS output and RAS output status under the abnormal conditions. 25 CmGetROConfig Retrieves abnormal conditions of automatic RAS output and RAS output status under the abnormal conditions. Digital input/output, key matrix input 26 CmInputUP Reads digital input pins. 27 CmOutputUP Writes digital output pins. 28 CmSetModeUP Configures an operation mode of general-purpose digital inputs/outputs and key matrix inputs 29 CmGetModeUP Retrieves an operation mode of general-purpose digital inputs/outputs and key matrix inputs 14

15 No Function Description Adjustment 30 CmSetBrightness Configures a brightness level. 31 CmGetBrightness Retrieves a brightness level. 32 CmSetVolume Configures a volume level. 33 CmGetVolume Retrieves a volume level. Battery 34 CmGetBatStatus Retrieves a battery status. 35 CmSetPowerOffTime Configures the interval time between occurrence of power failure and shutdown/forced power off. 36 CmGetPowerOffTime Retrieves the interval time between occurrence of power failure and shutdown/forced power off. 37 CmSetBatSimStatus Configures the battery simulation function. 38 CmGetBatSimStatus Retrieves battery simulation settings. Illuminance 39 CmGetIlluminance Retrieves illuminance. 15

16 4.2 Reference 1. CmSetWDTConfig Description The function configures a time-out time of the WDT and an action at the time-out error. Syntax UINT CmSetWDTConfig( UINT Cycle, UINT Action Declare Function CmSetWDTConfig Lib "ifcpmgr.dll"( _ ByVal Cycle As Long, _ ByVal Action As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmSetWDTConfig( uint Cycle, uint Action.NET Declare Function CmSetWDTConfig Lib "ifcpmgr.dll"(_ ByVal Cycle As Integer, _ ByVal Action As Integer _ )As Integer Parameters Cycle The parameter specifies a time-out time of the WDT. The time-out time ranges 1 through 255 in second. The default value is 30. When the WDT is enabled by BIOS, the default value is set by BIOS. Action The parameter specifies an action at the time-out error. Specify a value in the following table. Code Value Description CM_WDT_ACT_INTERRUPT 0 Generates an interrupt event at the time-out error CM_WDT_ACT_RESET 1 Generates a CPU reset at the time-out error The default setting is CM_WDT_ACT_INTERRUPT. When the WDT is enabled by BIOS, the value is CM_WDT_ACT_RESET. 16

17 Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INTERNAL C h Internal error IFCM_ERROR_INVALID_PARAMETER C h Invalid input parameter IFCM_ERROR_INVALID_HANDLE C h Internal error Refer to 4.5 Return Values for details if the function returns a value other than 0. Comments - When this function is called while the WDT is running, the WDT restarts with the new time-out time. - When this function is called in a different process, the latest settings of the time-out time and action are effective. - Settings of the WDT set by BIOS are loaded at start of the system when BIOS enables the WDT. Examples Setting the time-out time to 50 seconds and the action to CPU reset UINT Ret; Ret = CmSetWDTConfig(50, CM_WDT_ACT_RESET Dim Ret As Long Ret = CmSetWDTConfig(50, CM_WDT_ACT_RESET) uint Ret; Ret = IFCCPMGR.CmSetWDTConfig(50, IFCCPMGR.CM_WDT_ACT_RESET.NET Dim Ret As Integer Ret = IFCCPMGR.CmSetWDTConfig(50, IFCCPMGR.CM_WDT_ACT_RESET) 17

18 2. CmGetWDTConfig Description The function retrieves a time-out time of the WDT and an action at the time-out error. Syntax UINT CmGetWDTConfig( UINT* pcycle, UINT* paction Declare Function CmGetWDTConfig Lib "ifcpmgr.dll"( _ ByRef pcycle As Long, _ ByRef paction As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmGetWDTConfig( out uint pcycle, out uint paction.net Declare Function CmGetWDTConfig Lib "ifcpmgr.dll"(_ ByRef pcycle As Integer, _ ByRef paction As Integer _ )As Integer Parameters pcycle The parameter points to a variable to receive a time-out time of the WDT. paction The parameter points to a variable to receive an action at the time-out error The parameter can retrieve the same values as the CmSetWDTConfig function can configure. 18

19 Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INTERNAL C h Internal error IFCM_ERROR_NULL_POINTER C h NULL pointer detection IFCM_ERROR_INVALID_HANDLE C h Internal error Refer to 4.5 Return Values for details if the function returns a value other than 0. Examples Retrieving a time-out time of the WDT and action at the time-out error UINT Ret; UINT Cycle; UINT Action; Ret = CmGetWDTConfig(&Cycle, &Action Dim Ret As Long Dim Cycle As Long Dim Action As Long Ret = CmGetWDTConfig(Cycle, Action) uint Ret; uint Cycle; uint Action; Ret = IFCCPMGR.CmGetWDTConfig(out Cycle, out Action.NET Dim Ret As Integer Dim Cycle As Integer Dim Action As Integer Ret = IFCCPMGR.CmGetWDTConfig(Cycle, Action) 19

20 3. CmStartWDT Description The CmStartWDT function starts the WDT. Syntax UINT CmStartWDT(void Declare Function CmStartWDT Lib "ifcpmgr.dll"() As Long [DllImport("ifcpmgr.dll")] public static extern uint CmStartWDT(.NET Declare Function CmStartWDT Lib "ifcpmgr.dll"() As Integer Parameters None Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INTERNAL C h Internal error IFCM_ERROR_ALREADY C h Already in progress IFCM_ERROR_INVALID_HANDLE C h Internal error Refer to 4.5 Return Values for details if the function returns a value other than 0. Comment When this function is called after the WDT stops, the WDT starts from the beginning. Examples Starting WDT UINT Ret; Ret = CmStartWDT( Dim Ret As Long Ret = CmStartWDT() uint Ret; Ret = IFCCPMGR.CmStartWDT(.NET Dim Ret As Integer Ret = IFCCPMGR.CmStartWDT() 20

21 4. CmStopWDT Description The function stops the WDT. Syntax UINT CmStopWDT(void Declare Function CmStopWDT Lib "ifcpmgr.dll"() As Long [DllImport("ifcpmgr.dll")] public static extern uint CmStopWDT(.NET Declare Function CmStopWDT Lib "ifcpmgr.dll"() As Integer Parameters None Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INTERNAL C h Internal error IFCM_ERROR_NOT_YET C h Not in progress yet IFCM_ERROR_INVALID_HANDLE C h Internal error Refer to 4.5 Return Values for details if the function returns a value other than 0. Examples Stopping WDT UINT Ret; Ret = CmStopWDT( Dim Ret As Long Ret = CmStopWDT() uint Ret; Ret = IFCCPMGR.CmStopWDT(.NET Dim Ret As Integer Ret = IFCCPMGR.CmStopWDT() 21

22 5. CmClearWDT Description The function clears the WDT. The WDT restarts with the current time-out time. Syntax UINT CmClearWDT(void Declare Function CmClearWDT Lib "ifcpmgr.dll"() As Long [DllImport("ifcpmgr.dll")] public static extern uint CmClearWDT(.NET Declare Function CmClearWDT Lib "ifcpmgr.dll"() As Integer Parameters None Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INTERNAL C h Internal error IFCM_ERROR_NOT_YET C h Not in progress yet IFCM_ERROR_INVALID_HANDLE C h Internal error Refer to 4.5 Return Values for details if the function returns a value other than 0. Examples Clearing WDT UINT Ret; Ret = CmClearWDT( Dim Ret As Long Ret = CmClearWDT() uint Ret; Ret = IFCCPMGR.CmClearWDT(.NET Dim Ret As Integer Ret = IFCCPMGR.CmClearWDT() 22

23 6. CmGetTemp Description The function retrieves a temperature of a specified target. Syntax UINT CmGetTemp( UINT Target, INT* ptemp Declare Function CmGetTemp Lib "ifcpmgr.dll"( _ ByVal Target As Long, _ ByRef ptemp As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmGetTemp( uint Target, out int ptemp.net Declare Function CmGetTemp Lib "ifcpmgr.dll"(_ ByVal Target As Integer, _ ByRef ptemp As Integer _ )As Integer Parameters Target The parameter specifies a target to retrieve its temperature. Specify a value from the following table. Code Value Description CM_TEMP_TARGET_CPU 0 Retrieves a temperature of the CPU. In a product with a multi-core CPU, the value shows a temperature of core 1. CM_TEMP_TARGET_BRD 1 Retrieves a temperature of the PCB. CM_TEMP_TARGET_CPU2 3 Retrieves a temperature of core 2. (Only for multi-core CPU products) CM_TEMP_TARGET_CPU3 4 Retrieves a temperature of core 3. (Only for multi-core CPU products) CM_TEMP_TARGET_CPU4 5 Retrieves a temperature of core 4. (Only for multi-core CPU products) ptemp This parameter points to a variable to receive a temperature. The retrieved temperature may be negative. The unit is degree C. 23

24 Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INTERNAL C h Internal error IFCM_ERROR_INVALID_PARAMETER C h Invalid input parameter IFCM_ERROR_NULL_POINTER C h NULL pointer detection IFCM_ERROR_INVALID_HANDLE C h Internal error IFCM_ERROR_NOT_SUPPORT C h Not supported Refer to 4.5 Return Values for details if the function returns a value other than 0.! Caution For Atom N2800 model, the CPU temperature can be retrieved in the range from 0 degrees C through 100 degrees C, and the accuracy is as follows. Temperature Range Accuracy 60 degrees C to 100 degrees C < +/- 5 degrees C 25 degrees C to 60 degrees C < +/- 10 degrees C 0 degrees C to 25 degrees C The error can be greater than +/- 10 degrees C. Therefore, use the value only to indicate that the temperature is lower than 25 degrees C. Return Values Retrieving a current temperature of CPU UINT Ret; INT CpuTemp; Ret = CmGetTemp(CM_TEMP_TARGET_CPU, &CpuTemp Dim Ret As Long Dim CpuTemp As Long Ret = CmGetTemp(CM_TEMP_TARGET_CPU, CpuTemp) uint Ret; int CpuTemp; Ret = IFCCPMGR.CmGetTemp(IFCCPMGR.CM_TEMP_TARGET_CPU, out CpuTemp.NET Dim Ret As Integer Dim CpuTemp As Integer Ret = IFCCPMGR.CmGetTemp(IFCCPMGR.CM_TEMP_TARGET_CPU, CpuTemp) 24

25 7. CmSetTempLimit Description The function configures upper and lower limits of monitoring temperature of a specified target. When the temperature becomes out of the specified range, an interrupt event is generated. Syntax UINT CmSetTempLimit( UINT Target, INT LowerLimit, INT UpperLimit Declare Function CmSetTempLimit Lib "ifcpmgr.dll"( _ ByVal Target As Long, _ ByVal LowerLimit As Long, _ ByVal UpperLimit As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmSetTempLimit ( uint Target, int LowerLimit, int UpperLimit.NET Declare Function CmSetTempLimit Lib "ifcpmgr.dll"(_ ByVal Target As Integer, _ ByVal LowerLimit As Integer, _ ByVal UpperLimit As Integer _ )As Integer Parameters Target The parameter specifies a target to monitor the temperature. Specify a value from the table below. Code Value Description CM_TEMP_TARGET_CPU 0 Configures a monitoring temperature of the CPU. CM_TEMP_TARGET_BRD 1 Configures a monitoring temperature of the PCB LowerLimit The parameter specifies a lower limit of the monitoring temperature: -60 LowerLimit < UpperLimit The default value for the CPU and PCB is -60 (degrees C). UpperLimit The parameter specifies an upper limit of the monitoring temperature: LowerLimit < UpperLimit 125 The default value for the CPU and PCB is 125 (degrees C). 25

26 Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INTERNAL C h Internal error IFCM_ERROR_INVALID_PARAMETER C h Invalid input parameter IFCM_ERROR_INVALID_HANDLE C h Internal error Refer to 4.5 Return Values for details if the function returns a value other than 0. Comments - When this function is called in a different process, the latest settings are effective. - For a product with a multi-core CPU, an error is detected when a temperature of either core in the CPU becomes out of the range. (In other words, no error is detected when the temperature of every core is within the range) - When a write-filter is enabled on storage, commit is needed to reflect the changes. When a write-protection is enabled on storage, disable the write-protection before change of settings is made.! Caution The values that can be specified here are values that this software can monitor. The specified values are not guaranteed temperature of the hardware. Examples Setting lower and upper limits of monitoring temperature of PCB to 0 degrees C and 50 degrees C, respectively UINT Ret; Ret = CmSetTempLimit(CM_TEMP_TARGET_BRD, 0, 50 Dim Ret As Long Ret = CmSetTempLimit(CM_TEMP_TARGET_BRD, 0, 50) uint Ret; Ret = IFCCPMGR.CmSetTempLimit(IFCCPMGR.CM_TEMP_TARGET_BRD, 0, 50.NET Dim Ret As Integer Ret = IFCCPMGR.CmSetTempLimit(IFCCPMGR.CM_TEMP_TARGET_BRD, 0, 50) 26

27 8. CmGetTempLimit Description The function retrieves upper and lower limits of monitoring temperature of a specified target. Syntax UINT CmGetTempLimit( UINT Target, INT* plowerlimit, INT* pupperlimit Declare Function CmGetTempLimit Lib "ifcpmgr.dll"( _ ByVal Target As Long, _ ByRef plowerlimit As Long, _ ByRef pupperlimit As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmGetTempLimit ( uint Target, out int plowerlimit, out int pupperlimit.net Declare Function CmGetTempLimit Lib "ifcpmgr.dll"(_ ByVal Target As Integer, _ ByRef plowerlimit As Integer, _ ByRef pupperlimit As Integer _ )As Integer Parameters Target The parameter specifies a target to retrieve its monitoring temperatures. Specify a value from the table below. Code Value Description CM_TEMP_TARGET_CPU 0 Retrieves a monitoring temperature of the CPU. CM_TEMP_TARGET_BRD 1 Retrieves a monitoring temperature of the PCB. plowerlimit The parameter points to variable to receive the lower limit of the monitoring temperature. Lower-limit temperature: -60 retrieved value < UpperLimit (degrees C) pupperlimit The parameter points to variable to receive the upper limit of the monitoring temperature. Upper-limit temperature: LowerLimit < retrieved value 125 (degrees C) 27

28 Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INTERNAL C h Internal error IFCM_ERROR_NULL_POINTER C h NULL pointer detection IFCM_ERROR_INVALID_HANDLE C h Internal error Refer to 4.5 Return Values for details if the function returns a value other than 0. Examples Retrieving upper and lower limit temperatures of the PCB UINT Ret; INT LowerLimit; INT UpperLimit; Ret = CmGetTempLimit(CM_TEMP_TARGET_BRD, &LowerLimit, &UpperLimit Dim Ret As Long Dim LowerLimit As Long Dim UpperLimit As Long Ret = CmGetTempLimit(CM_TEMP_TARGET_BRD, LowerLimit, UpperLimit) uint Ret; int LowerLimit; int UpperLimit; Ret = IFCCPMGR.CmGetTempLimit(IFCCPMGR.CM_TEMP_TARGET_BRD, out LowerLimit, out UpperLimit.NET Dim Ret As Integer Dim LowerLimit As Integer Dim UpperLimit As Integer Ret = IFCCPMGR.CmGetTempLimit(IFCCPMGR.CM_TEMP_TARGET_BRD, LowerLimit, UpperLimit) 28

29 9. CmSetTempLimitEx Description The function configures upper and lower limits of monitoring temperature of a specified target. The hysteresis for the temperature can be configured. When the temperature becomes out of the specified range, an interrupt event is generated. Syntax UINT CmSetTempLimitEx( UINT Target, INT LowerLimit, INT UpperLimit, INT LHysteresis, INT UHysteresis Declare Function CmSetTempLimitEx Lib "ifcpmgr.dll"( _ ByVal Target As Long, _ ByVal LowerLimit As Long, _ ByVal UpperLimit As Long, _ ByVal LHysteresis As Long, _ ByVal UHysteresis As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmSetTempLimitEx ( uint Target, int LowerLimit, int UpperLimit, int LHysteresis, int UHysteresis.NET Declare Function CmSetTempLimitEx Lib "ifcpmgr.dll"(_ ByVal Target As Integer, _ ByVal LowerLimit As Integer, _ ByVal UpperLimit As Integer, _ ByVal LHysteresis As Integer, _ ByVal UHysteresis As Integer _ )As Integer 29

30 Parameters Target The parameter specifies a target to monitor its temperature. Specify a value from the table below. Code Value Description CM_TEMP_TARGET_CPU 0 Configures a monitoring temperature of the CPU. CM_TEMP_TARGET_BRD 1 Configures a monitoring temperature of the PCB LowerLimit The parameter specifies a lower limit of the monitoring temperature: -60 LowerLimit < UpperLimit The default value for the CPU and PCB is -60 (degrees C). UpperLimit The parameter specifies an upper limit of the monitoring temperature: LowerLimit < UpperLimit 125 The default value for the CPU and PCB is 125 (degrees C). LHysteresis The parameter specifies a hysteresis between the lower limit of monitoring temperature and an error recovery temperature. The unit is degrees C. The value is from 0 through 31 and the default value is 0. *1 At the default setting, a lower temperature error recovers immediately when a temperature exceeds the lower-limit temperature. Degrees C LHysteresis LowerLimit Temperature error period t UHysteresis The parameter specifies a hysteresis between the upper limit of monitoring temperature and an error recovery temperature. The unit is degrees C. The value is from 0 through 31 and the default value is 0.*1 At the default setting, an upper temperature error recovers immediately when a temperature goes below the upper limit temperature. Degrees C UpperLimit UHysteresis Temperature error period t Note: *1 The function is applicable only to the Atom E3840 model. 30

31 Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INTERNAL C h Internal error IFCM_ERROR_INVALID_PARAMETER C h Invalid input parameter IFCM_ERROR_INVALID_HANDLE C h Internal error Refer to 4.5 Return Values for details if the function returns a value other than 0. Comments - When this function is called in a different process, the latest settings of upper and lower limits are effective. - For a product with a multi-core CPU, an error is detected when a temperature of either core in the CPU becomes out of the range. (In other words, no error is detected when the temperature of every core is within the range) - When a write-filter is enabled on storage, commit is needed to reflect the changes. When a write-protection is enabled on storage, disable the write-protection before change of settings is made.! Caution The values that can be specified here are values that this software can monitor. The specified values are not guaranteed temperature of the hardware. Examples Setting lower and upper limits of monitoring temperatures of PCB to 0 degrees C and 50 degrees C, respectively UINT Ret; Ret = CmSetTempLimitEx(CM_TEMP_TARGET_BRD, 0, 50, 5, 5 Dim Ret As Long Ret = CmSetTempLimitEx(CM_TEMP_TARGET_BRD, 0, 50, 5, 5) uint Ret; Ret = IFCCPMGR.CmSetTempLimitEx(IFCCPMGR.CM_TEMP_TARGET_BRD, 0, 50, 5, 5.NET Dim Ret As Integer Ret = IFCCPMGR.CmSetTempLimitEx(IFCCPMGR.CM_TEMP_TARGET_BRD, 0, 50, 5, 5) 31

32 10. CmGetTempLimitEx Description The function retrieves upper and lower limits of monitoring temperatures of a specified target. Syntax UINT CmGetTempLimitEx( UINT Target, INT* plowerlimit, INT* pupperlimit, INT* plhysteresis, INT* puhysteresis Declare Function CmGetTempLimitEx Lib "ifcpmgr.dll"( _ ByVal Target As Long, _ ByRef plowerlimit As Long, _ ByRef pupperlimit As Long, _ ByRef plhysteresis As Long, _ ByRef puhysteresis As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmGetTempLimitEx ( uint Target, out int plowerlimit, out int pupperlimit, out int plhysteresis, out int puhysteresis.net Declare Function CmGetTempLimitEx Lib "ifcpmgr.dll"(_ ByVal Target As Integer, _ ByRef plowerlimit As Integer, _ ByRef pupperlimit As Integer, _ ByRef plhysteresis As Integer, _ ByRef puhysteresis As Integer _ )As Integer 32

33 Parameters Target The parameter specifies a target to retrieve its monitoring temperatures. Specify a value from the table below. Code Value Description CM_TEMP_TARGET_CPU 0 Retrieves a monitoring temperature of the CPU. CM_TEMP_TARGET_BRD 1 Retrieves a monitoring temperature of the PCB. plowerlimit The parameter points to variable to receive the lower limit of the monitoring temperature. Lower-limit temperature: -60 retrieved value < UpperLimit (degrees C) pupperlimit The parameter points to variable to receive the upper limit of the monitoring temperature. Upper-limit temperature: LowerLimit < retrieved value 125 (degrees C) plhysteresis The parameter points to a variable to receive a hysteresis of a lower temperature error. *1 puhysteresis The parameter points to a variable to receive a hysteresis of an upper temperature error. A value from 0 through 31 can be retrieved. The unit is degrees C. *1 Note: *1 In Classembly Devices(R) other than BayTrail model, the parameter retrieves 0. Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INTERNAL C h Internal error IFCM_ERROR_NULL_POINTER C h NULL pointer detection IFCM_ERROR_INVALID_HANDLE C h Internal error Refer to 4.5 Return Values for details if the function returns a value other than 0. 33

34 Examples Retrieving upper and lower limit temperatures of the PCB UINT Ret; INT LowerLimit; INT UpperLimit; INT LHysteresis; INT UHysteresis; Ret = CmGetTempLimitEx(CM_TEMP_TARGET_BRD, &LowerLimit, &UpperLimit, &LHysteresis, &UHysteresis Dim Ret As Long Dim LowerLimit As Long Dim UpperLimit As Long Dim LHysteresis As Long Dim UHysteresis As Long Ret = CmGetTempLimitEx(CM_TEMP_TARGET_BRD, LowerLimit, UpperLimit, _ LHysteresis, UHysteresis) uint Ret; int LowerLimit; int UpperLimit; int LHysteresis; int UHysteresis; Ret = IFCCPMGR.CmGetTempLimitEx(IFCCPMGR.CM_TEMP_TARGET_BRD, out LowerLimit, out LHysteresis, out UHysteresis.NET Dim Ret As Integer Dim LowerLimit As Integer Dim UpperLimit As Integer Dim LHysteresis As Long Dim UHysteresis As Long Ret = IFCCPMGR.CmGetTempLimitEx(IFCCPMGR.CM_TEMP_TARGET_BRD, _ LowerLimit, UpperLimit, LHysteresis, UHysteresis) 34

35 11. CmGetPower Description The function retrieves a power supply voltage. Syntax UINT CmGetPower( UINT Target, float* ppower Declare Function CmGetPower Lib "ifcpmgr.dll"( _ ByVal Target As Long, _ ByRef ppower As Single _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmGetPower( uint Target, out float ppower.net Declare Function CmGetPower Lib "ifcpmgr.dll"(_ ByVal Target As Integer, _ ByRef ppower As Single _ )As Integer Parameters Target The parameter specifies a target to retrieve its voltage. Only the following values are applicable. Code Value Description CM_POWER_TARGET_EXT 0 Retrieves a voltage. ppower The parameter points to a variable to receive the voltage value. The unit is Vdc. Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INTERNAL C h Internal error IFCM_ERROR_INVALID_PARAMETER C h Invalid input parameter IFCM_ERROR_NULL_POINTER C h NULL pointer detection IFCM_ERROR_INVALID_HANDLE C h Internal error Refer to 4.5 Return Values for details if the function returns a value other than 0. 35

36 Return Values Retrieving a voltage of power supply UINT Ret; float Power; Ret = CmGetPower(CM_POWER_TARGET_EXT, &Power Dim Ret As Long Dim Power As Single Ret = CmGetPower(CM_POWER_TARGET_EXT, Power) uint Ret; float Power; Ret = IFCCPMGR.CmGetPower(IFCCPMGR.CM_POWER_TARGET_EXT, out Power.NET Dim Ret As Integer Dim Power As Single Ret = IFCCPMGR.CmGetPower(IFCCPMGR.CM_POWER_TARGET_EXT, Power) 36

37 12. CmSetPowerLimit Description The function configures upper and lower limits of monitoring voltages of a specified target. When a voltage of the target exceeds the upper or lower limit, an interrupt event can be notified. The function also specifies hysteresis between an error occurrence and error recovery. This function is provided for Classembly Devices with Atom E3840 processor. Syntax UINT CmSetPowerLimit( UINT Target, INT LowerLimit, INT UpperLimit, INT LHysteresis, INT UHysteresis Declare Function CmSetPowerLimit Lib "ifcpmgr.dll"( _ ByVal Target As Long, _ ByVal LowerLimit As Long, _ ByVal UpperLimit As Long, _ ByVal LHysteresis As Long, _ ByVal UHysteresis As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmSetPowerLimit ( uint Target, int LowerLimit, int UpperLimit, int LHysteresis, int UHysteresis.NET Declare Function CmSetPowerLimit Lib "ifcpmgr.dll"(_ ByVal Target As Integer, _ ByVal LowerLimit As Integer, _ ByVal UpperLimit As Integer, _ ByVal LHysteresis As Integer, _ ByVal UHysteresis As Integer _ )As Integer 37

38 Parameters Target The parameter specifies a target to configure its monitoring parameters. Specify the following value. Code Value Description CM_POWER_TARGET_EXT 0 Sets the monitoring parameters of the power supply. LowerLimit The parameter specifies a lower-limit of the monitoring voltage. The lower limit value is found by multiplying 0.22 (V) by the setting value. Configurable range: 30 < setting value < UpperLimit Default value: 30 Example) If the setting value is 30, the lower-limit value is calculated by the following equation: = 6.60 (V). UpperLimit The parameter specifies an upper-limit of the monitoring voltage. The upper limit value is found by multiplying 0.22 (V) by the setting value. Configurable range: LowerLimit < setting value < 170 Default value: 170 Example) If the setting value is 170, the lower-limit value is calculated by the following equation: = 37.4 (V). LHysteresis The parameter specifies a hysteresis between the lower limit of the monitoring voltage and an error recovery voltage. The value is from 0 through 31. The hysteresis is found by multiplying 0.22 (V) by the setting value. The default value is 0. For example, when the setting value is 1, the hysteresis is 0.22 (V). At the default setting, a lower voltage error recovers immediately when a voltage goes over the lower limit voltage. V LHysteresis LowerLimit Voltage error period t 38

39 UHysteresis The parameter specifies a hysteresis between the upper limit of the monitoring voltage and an error recovery voltage. The value is from 0 through 31. The hysteresis is found by multiplying 0.22 (V) by the setting value. The default value is 0. For example, when the setting value is 1, the hysteresis is 0.22 (V). At the default setting, an upper voltage error recovers immediately when a voltage goes below the upper limit voltage. V UpperLimit UHysteresis Voltage error period t Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INTERNAL C h Internal error IFCM_ERROR_INVALID_PARAMETER C h Invalid input parameter IFCM_ERROR_INVALID_HANDLE C h Internal error IFCM_ERROR_NOT_SUPPORT C h Not supported Refer to 4.5 Return Values for details if the function returns a value other than 0. Comment - When this function is called in a different process, the latest settings of the upper and lower limits and error range are effective. Examples Setting the lower and upper limit to 6.60 V and 37.4 V, respectively. After occurrence of the lower-limit error, the program recovers when the value exceeds 8.8 (V). After occurrence of the upper-limit error, the program recovers when the value becomes lower than 35.2 (V). UINT Ret; Ret = CmSetPowerLimit(CM_POWER_TARGET_EXT, 30, 170, 10, 10 Dim Ret As Long Ret = CmSetPowerLimit(CM_POWER_TARGET_EXT, 30, 170, 10, 10) uint Ret; Ret = IFCCPMGR.CmSetPowerLimit(IFCCPMGR.CM_POWER_TARGET_EXT, 30, 170, 10, 10.NET Dim Ret As Integer Ret = IFCCPMGR.CmSetPowerLimit(IFCCPMGR.CM_POWER_TARGET_EXT, 30, 170,_ 10, 10) 39

40 13. CmGetPowerLimit Description The function retrieves the upper and lower limits of monitoring voltages of a specified target. It also retrieves the hysteresis between an error occurrence and error recovery. Syntax UINT CmGetPowerLimit( UINT Target, INT* plowerlimit, INT* pupperlimit, INT* plhysteresis, INT* puhysteresis Declare Function CmGetPowerLimit Lib "ifcpmgr.dll"( _ ByVal Target As Long, _ ByRef plowerlimit As Long, _ ByRef pupperlimit As Long, _ ByRef plhysteresis As Long, _ ByRef puhysteresis As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmGetPowerLimit ( uint Target, out int plowerlimit, out int pupperlimit, out int plhysteresis, out int puhysteresis.net Declare Function CmGetPowerLimit Lib "ifcpmgr.dll"(_ ByVal Target As Integer, _ ByRef plowerlimit As Integer, _ ByRef pupperlimit As Integer, _ ByRef plhysteresis As Integer, _ ByRef puhysteresis As Integer _ )As Integer 40

41 Parameters Target The parameter specifies a target to retrieve its monitoring parameters. Specify the following value. Code Value Description CM_POWER_TARGET_EXT 0 Retrieves the monitoring parameters of the power supply. plowerlimit The parameter points to a variable to receive a lower limit of monitoring voltage. pupperlimit The parameter points to a variable to receive an upper limit of monitoring voltage. plhysteresis The parameter points to a variable to receive a hysteresis of a lower voltage error. puhysteresis The parameter points to a variable to receive a hysteresis of an upper voltage error. Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INTERNAL C h Internal error IFCM_ERROR_NULL_POINTER C h NULL pointer detection IFCM_ERROR_INVALID_HANDLE C h Internal error IFCM_ERROR_NOT_SUPPORT C h Not supported Refer to 4.5 Return Values for details if the function returns a value other than 0. 41

42 Examples Retrieving the upper and lower limits and hysteresis of monitoring voltage. UINT Ret; INT LowerLimit; INT UpperLimit; INT LHysteresis; INT UHysteresis; Ret = CmGetPowerLimit(CM_POWER_TARGET_EXT, &LowerLimit, &UpperLimit, &LHysteresis, &UHysteresis Dim Ret As Long Dim LowerLimit As Long Dim UpperLimit As Long Dim LHysteresis As Long Dim UHysteresis As Long Ret = CmGetPowerLimit(CM_POWER_TARGET_EXT, LowerLimit, UpperLimit, _ LHysteresis, UHysteresis) uint Ret; int LowerLimit; int UpperLimit; int LHysteresis; int UHysteresis; Ret = IFCCPMGR.CmGetPowerLimit(IFCCPMGR.CM_POWER_TARGET_EXT, out LowerLimit, out LHysteresis, out UHysteresis.NET Dim Ret As Integer Dim LowerLimit As Integer Dim UpperLimit As Integer Dim LHysteresis As Long Dim UHysteresis As Long Ret = IFCCPMGR.CmGetPowerLimit(IFCCPMGR.CM_POWER_TARGET_EXT,_ LowerLimit, UpperLimit_LHysteresis, UHysteresis) 42

43 14. CmSetDigitalFilter Description The function configures a filter time of the digital filter. Syntax UINT CmSetDigitalFilter ( UINT Target, INT DigitalFilter Declare Function CmSetDigitalFilter Lib "ifcpmgr.dll"( _ ByVal Target As Long, _ ByVal DigitalFilter As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmSetDigitalFilter ( uint Target, int DigitalFilter.NET Declare Function CmSetDigitalFilter Lib "ifcpmgr.dll"(_ ByVal Target As Integer, _ ByVal DigitalFilter As Integer _ )As Integer Parameters Target The parameter specifies a target to set its digital filter. Code Value Description CM_POWER_TARGET_EXT 0 Digital filter to detect an error of voltage of the power supply. DigitalFilter This parameter specifies a filter time to detect an error. When an error status continues for the time, the error is detected. The unit of the time is ms. 0 : No filter 1 through 255 : Filter time Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INTERNAL C h Internal error IFCM_ERROR_INVALID_PARAMETER C h Invalid input parameter IFCM_ERROR_INVALID_HANDLE C h Internal error IFCM_ERROR_NOT_SUPPORT C h Not supported Refer to 4.5 Return Values for details if the function returns a value other than 0. 43

44 Comment - When this function is called in a different process, the latest setting of the filter value is effective. Examples Judging the status as error when the error continues for 50 ms UINT Ret; Ret = CmSetDigitalFilter(CM_POWER_TARGET_EXT, 50 Dim Ret As Long Ret = CmSetDigitalFilter(CM_POWER_TARGET_EXT, 50) uint Ret; Ret = IFCCPMGR.CmSetDigitalFilter(IFCCPMGR.CM_POWER_TARGET_EXT, 50.NET Dim Ret As Integer Ret = IFCCPMGR.CmSetDigitalFilter(IFCCPMGR.CM_POWER_TARGET_EXT, 50) 44

45 15. CmGetDigitalFilter Description The function retrieves a filter time of the digital filter. Syntax UINT CmGetDigitalFilter ( UINT Target, INT* pdigitalfilter Declare Function CmGetDigitalFilter Lib "ifcpmgr.dll"( _ ByVal Target As Long, _ ByRef pdigitalfilter As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmGetDigitalFilter ( uint Target, out int pdigitalfilter.net Declare Function CmGetDigitalFilter Lib "ifcpmgr.dll"(_ ByVal Target As Integer, _ ByRef pdigitalfilter As Integer _ )As Integer Parameters Target This parameter specifies a target to retrieve a filter time of the digital filter. Code Value Description CM_POWER_TARGET_EXT 0 Digital filter to detect an error of voltage of the power supply. pdigitalfilter The parameter points to a variable to receive a filter time of the digital filter. Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INTERNAL C h Internal error IFCM_ERROR_NULL_POINTER C h NULL pointer detection IFCM_ERROR_INVALID_HANDLE C h Internal error IFCM_ERROR_NOT_SUPPORT C h Not supported Refer to 4.5 Return Values for details if the function returns a value other than 0. 45

46 Examples Retrieving the setting value of a digital filter UINT Ret; INT DigtalFilter; Ret = CmGetDigitalFilter(CM_TEMP_TARGET_CPU, &CmGetDigitalFilter Dim Ret As Long Dim DigtalFilter As Long Ret = CmGetDigitalFilter(CM_TEMP_TARGET_CPU, CmGetDigitalFilter) uint Ret; int DigtalFilter; Ret = IFCCPMGR.CmGetDigitalFilter(IFCCPMGR.CM_TEMP_TARGET_CPU, out CmGetDigitalFilter.NET Dim Ret As Integer Dim DigtalFilter As Integer Ret = IFCCPMGR.CmGetDigitalFilter(IFCCPMGR.CM_TEMP_TARGET_CPU, CmGetDigitalFilter) 46

47 16. CmSetEvent Description The function registers notification methods of interrupt event: event signal, message, and function callback. Syntax UINT CmSetEvent( PCM_EVENT_REQ pevent Declare Function CmSetEvent Lib "ifcpmgr.dll"( _ ByRef pevent As CM_EVENT_REQ _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmSetEvent( ref pevent CM_EVENT_REQ.NET Declare Function CmSetEvent Lib "ifcpmgr.dll"(_ ByRef pevent As CM_EVENT_REQ _ )As Integer Parameters pevent The parameter points to a variable that contains a setting of event handling. Refer to CM_EVENT_REQ for details. Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_ALREADY C h Event is already registered IFCM_ERROR_NULL_POINTER C h NULL pointer detection IFCM_ERROR_NOT_ALLOCATE C h Memory allocation error IFCM_ERROR_INVALID_HANDLE C h Internal error Refer to 4.5 Return Values for details if the function returns a value other than 0. Comment An event can be registered per program. Refer to "4.3 Callback Function" for more details on the callback functions. 47

48 ! Caution Callback functions can be handled only in C. Use event signal or message for other languages. Examples Registering a signal event UINT Ret; CM_EVENT_REQ EventReq; EventReq.Signal = CreateEvent(NULL, TRUE, FALSE, NULL EventReq.Wnd = NULL; EventReq.Msg = WM_NULL; EventReq.CallBackProc = NULL; EventReq.User = NULL; Ret = CmSetEvent(&EventReq Dim Ret As Long Dim EventReq As CM_EVENT_REQ EventReq.Signal = CreateEvent(0, True, False, 0) EventReq.Wnd = 0 EventReq.Msg = 0 EventReq.CallBackProc = 0 EventReq.User = 0 Ret = CmSetEvent(EventReq) uint Ret; IFCCPMGR.CM_EVENT_REQ EventReq = new IFCCPMGR.CM_EVENT_REQ( EventReq.Signal = IFCCPMGR.CreateEvent(IntPtr.Zero, true, false, null EventReq.Wnd = IntPtr.Zero; EventReq.Msg = 0; EventReq.CallBackProc = IntPtr.Zero; EventReq.User = IntPtr.Zero; Ret = IFCCPMGR.CmSetEvent(ref EventReq.NET Dim Ret As Integer Dim EventReq As IFCCPMGR.CM_EVENT_REQ = New IFCCPMGR.CM_EVENT_REQ EventReq.Signal = IFCCPMGR.CreateEvent(IntPtr.Zero, True, False, Nothing) EventReq.Wnd = IntPtr.Zero EventReq.Msg = 0 EventReq.CallBackProc = IntPtr.Zero EventReq.User = IntPtr.Zero Ret = IFCCPMGR.CmSetEvent(EventReq) 48

49 17. CmKillEvent Description The function releases registered interrupt events. Syntax UINT CmKillEvent(void Declare Function CmKillEvent Lib "ifcpmgr.dll"() As Long [DllImport("ifcpmgr.dll")] public static extern uint CmKillEvent(.NET Declare Function CmKillEvent Lib "ifcpmgr.dll"() As Integer Parameters None Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_NOT_YET C h Not in progress yet IFCM_ERROR_INVALID_HANDLE C h Internal error Refer to 4.5 Return Values for details if the function returns a value other than 0. Examples Releasing registered interrupt events UINT Ret; Ret = CmKillEvent( Dim Ret As Long Ret = CmKillEvent() uint Ret; Ret = IFCCPMGR.CmKillEvent(.NET Dim Ret As Integer Ret = IFCCPMGR.CmKillEvent() 49

50 18. CmSetEventMask Description The function configures a mask of interrupt events to enable or disable each event. Syntax UINT CmSetEventMask( UINT Mask Declare Function CmSetEventMask Lib "ifcpmgr.dll"( _ ByVal Mask As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmSetEventMask( uint Mask.NET Declare Function CmSetEventMask Lib "ifcpmgr.dll"(_ ByVal Mask As Integer _ )As Integer Parameters Mask The parameter specifies a mask of interrupt events. A value of 0 disables all events. The default value is 0. One or more values can be ORed. Notes: - CM_EVENT_FALL_SIGx cannot be ORed with CM_EVENT_RISE_SIGx. - CM_EVENT_FALL_SIGx and CM_EVENT_RISE_SIGx are available only on the products that support interrupt functions of digital input. However CM_EVENT_RISE_SIGx is not available on Sho-ene Classembly Devices Extended Temperature Model. Code Value Description CM_EVENT_WDS 1h Enables an event that the WDT is timed out. CM_EVENT_CPTHS 2h Enables an event that is generated when a temperature of CPU goes over the upper limit. CM_EVENT_CPTLS 4h Enables an event that is generated when a temperature of CPU goes below the lower limit. CM_EVENT_LCTHS 8h Enables an event that is generated when a temperature of PCB goes over the upper limit. CM_EVENT_LCTLS 10h Enables an event that is generated when a temperature of PCB goes below the lower limit. CM_EVENT_V27VA 80h Enables an event that a voltage of power supply is abnormal. CM_EVENT_FALL_SIG9 100h Enables an event that is generated when MIN9 is turned on. CM_EVENT_FALL_SIG10 200h Enables an event that is generated when MIN10 is turned on. 50

51 Code Value Description CM_EVENT_FALL_SIG11 400h Enables an event that is generated when MIN11 is turned on. CM_EVENT_FALL_SIG12 800h Enables an event that is generated when MIN12 is turned on. CM_EVENT_FALL_SIG h Enables an event that is generated when MIN13 is turned on. CM_EVENT_FALL_SIG h Enables an event that is generated when MIN14 is turned on. CM_EVENT_FALL_SIG h Enables an event that is generated when MIN15 is turned on. CM_EVENT_FALL_SIG h Enables an event that is generated when MIN16 is turned on. CM_EVENT_FALL_SIG h Enables an event that is generated when DIN1/MIN1 is turned on. CM_EVENT_RISE_SIG h Enables an event that is generated when DIN1 is turned off. CM_EVENT_FALL_SIG h Enables an event that is generated when DIN2/MIN2 is turned on. CM_EVENT_RISE_SIG h Enables an event that is generated when DIN2 is turned off. CM_EVENT_FALL_SIG h Enables an event that is generated when DIN3/MIN3 is turned on. CM_EVENT_RISE_SIG h Enables an event that is generated when DIN3 is turned off. CM_EVENT_FALL_SIG h Enables an event that is generated when DIN4/MIN4 is turned on. CM_EVENT_RISE_SIG h Enables an event that is generated when DIN4 is turned off. CM_EVENT_FALL_SIG h Enables an event that is generated when MIN5 is turned on. CM_EVENT_FALL_SIG h Enables an event that is generated when MIN6 is turned on. CM_EVENT_FALL_SIG h Enables an event that is generated when MIN7 is turned on. CM_EVENT_FALL_SIG h Enables an event that is generated when MIN8 is turned on. CM_EVENT_RAID_RECOVER h Enables an event that is generated when recovery of RAID volume is detected. CM_EVENT_RAID_FAIL h Enables an event that is generated when failure of RAID volume is detected. Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INVALID_PARAMETER C h Invalid input parameter IFCM_ERROR_INVALID_HANDLE C h Internal error IFCM_ERROR_NOT_SUPPORT C h Not supported Refer to 4.5 Return Values for details if the function returns a value other than 0. 51

52 Comments - An event mask can be independently configured per program. (In different programs, different event masks can be used.) However, on a product that supports the interrupt functions of digital input, CM_EVENT_RISE_SIGx and CM_EVENT_FALL_SIGx cannot be specified on the same pin at the same time even the pin is used in different programs. - When the same event is enabled in one or more programs, the event that is generated is notified to all the programs. Examples Enabling the WDT event and the error event of power supply voltage UINT Ret; Ret = CmSetEventMask(CM_EVENT_WDS CM_EVENT_V27VA Dim Ret As Long Ret = CmSetEventMask(CM_EVENT_WDS Or CM_EVENT_V27VA) uint Ret; Ret = IFCCPMGR.CmSetEventMask(IFCCPMGR.CM_EVENT_WDS IFCCPMGR.CM_EVENT_V27VA.NET Dim Ret As Integer Ret = IFCCPMGR.CmSetEventMask(IFCCPMGR.CM_EVENT_WDS Or IFCCPMGR.CM_EVENT_V27VA) 52

53 19. CmGetEventMask Description The function retrieves a mask of interrupt events. Syntax UINT CmGetEventMask( UINT* pmask Declare Function CmGetEventMask Lib "ifcpmgr.dll"( _ ByRef pmask As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmGetEventMask( out uint pmask.net Declare Function CmGetEventMask Lib "ifcpmgr.dll"(_ ByRef pmask As Integer _ )As Integer Parameters pmask The parameter points to a variable to receive an event mask value. The parameter retrieves a value configured by the CmSetEventMask function. Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_NULL_POINTER C h NULL pointer detection IFCM_ERROR_INVALID_HANDLE C h Internal error Refer to 4.5 Return Values for details if the function returns a value other than 0. 53

54 Examples Retrieving the current interrupt mask value UINT Ret; UINT Mask; Ret = CmGetEventMask(&Mask Dim Ret As Long Dim Mask As Long Ret = CmGetEventMask(Mask) uint Ret; uint Mask; Ret = IFCCPMGR.CmGetEventMask(out Mask.NET Dim Ret As Integer Dim Mask As Integer Ret = IFCCPMGR.CmGetEventMask(Mask) 54

55 20. CmGetEventFactor Description The function retrieves sources of interrupt events. Syntax UINT CmGetEventFactor( UINT* pfactor Declare Function CmGetEventFactor Lib "ifcpmgr.dll"( _ ByRef pfactor As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmGetEventFactor( out uint pfactor.net Declare Function CmGetEventFactor Lib "ifcpmgr.dll"(_ ByRef pfactor As Integer _ )As Integer Parameters pfactor This parameter points to a variable to receive event sources. The parameter retrieves values in the table below. One or more sources may be detected. Code Value Description CM_EVENT_WDS 1h WDT time-out error occurs CM_EVENT_CPTHS 2h CPU temperature goes over the upper limit CM_EVENT_CPTLS 4h CPU temperature goes below the lower limit CM_EVENT_LCTHS 8h PCB temperature goes over the upper limit CM_EVENT_LCTLS 10h PCB temperature goes below the lower limit CM_EVENT_V27VA 80h A voltage of power supply is abnormal CM_EVENT_FALL_SIG9 100h An event that is generated when MIN9 is turned on. CM_EVENT_FALL_SIG10 200h An event that is generated when MIN10 is turned on. CM_EVENT_FALL_SIG11 400h An event that is generated when MIN11 is turned on. CM_EVENT_FALL_SIG12 800h An event that is generated when MIN12 is turned on. CM_EVENT_FALL_SIG h An event that is generated when MIN13 is turned on. CM_EVENT_FALL_SIG h An event that is generated when MIN14 is turned on. CM_EVENT_FALL_SIG h An event that is generated when MIN15 is turned on. 55

56 Code Value Description CM_EVENT_FALL_SIG h An event that is generated when MIN16 is turned on. CM_EVENT_FALL_SIG h An event that is generated when DIN1/MIN1 is turned on. CM_EVENT_RISE_SIG h Enables an event that is generated when DIN1 is turned off. CM_EVENT_FALL_SIG h An event that is generated when DIN2/MIN2 is turned on. CM_EVENT_RISE_SIG h Enables an event that is generated when DIN2 is turned off. CM_EVENT_FALL_SIG h An event that is generated when DIN3/MIN3 is turned on. CM_EVENT_RISE_SIG h Enables an event that is generated when DIN3 is turned off. CM_EVENT_FALL_SIG h An event that is generated when DIN4/MIN4 is turned on. CM_EVENT_RISE_SIG h Enables an event that is generated when DIN4 is turned off. CM_EVENT_FALL_SIG h An event that is generated when MIN5 is turned on. CM_EVENT_FALL_SIG h An event that is generated when MIN6 is turned on. CM_EVENT_FALL_SIG h An event that is generated when MIN7 is turned on. CM_EVENT_FALL_SIG h An event that is generated when MIN8 is turned on. CM_EVENT_RAID_ RECOVER h An event that is generated when recovery of RAID volume is detected. CM_EVENT_RAID_FAIL h An event that is generated when failure of RAID volume is detected. Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_NULL_POINTER C h NULL pointer detection IFCM_ERROR_INVALID_HANDLE C h Internal error Refer to 4.5 Return Values for details if the function returns a value other than 0.! Caution Retrieve the event source by using this function after the interrupt event is notified by the following methods - signal event - message and/or - callback function. If a source of the interrupt event is not retrieved by using this function, the next interrupt event of the same source will not be notified. 56

57 Comments - After the function retrieves the sources of interrupt events, the sources are cleared. When no source is left, the function returns 0 as the source (0 is stored in the variable pointed by pfactor.) - When the same source of interrupt event is satisfied several times before retrieving the interrupt source, the satisfied sources are consolidated into one event. Example) Assume that the CPU temperature goes over the upper limit, and the CPU temperature goes over the upper limit again before the function retrieves the source of the first event. In this case, this function returns CM_EVENT_CPTHS for the source. When this function is called again, the function returns 0 as the source. The interrupt event will occur only once. - Each event source on every program is independent. Assume that two programs (program A and program B) enable WDT event. When WDT is timed out, the event is notified to both programs. Program A retrieves the source of the event. The event source for program A is cleared. However, the event source for program B is still remained because program B does not retrieve the source. The next WDT event will be notified to program A, but not be notified to program B. 57

58 Examples Retrieving event sources in the message handler LRESULT CEventDlg::OnMessage(WPARAM wparam, LPARAM lparam) { unsigned int Ret; unsigned int Factor; } Ret = CmGetEventFactor(&Factor Public Sub OnMessage() Dim Ret As Long Dim Factor As Long Ret = CmGetEventFactor(Factor) End Sub private void OnMessage(IntPtr WParam, IntPtr LParam) { uint Ret; uint Factor; Ret = IFCCPMGR.CmGetEventFactor(out Factor }.NET Public Sub OnMessage(ByVal WParam As IntPtr, ByVal LParam As IntPtr) Dim Ret As Integer Dim Factor As Integer Ret = IFCCPMGR.CmGetEventFactor(Factor) End Sub 58

59 21. CmGetSpecifiedStatus Description The function retrieves the specified status. Syntax UINT CmGetSpecifiedStatus( UINT* pstatus Declare Function CmGetSpecifiedStatus Lib "ifcpmgr.dll"( _ ByRef pstatus As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmGetSpecifiedStatus( ref uint pstatus.net Declare Function CmGetSpecifiedStatus Lib "ifcpmgr.dll"(_ ByRef pstatus As Integer _ )As Integer Parameters pstatus This parameter points to a variable to receive statuses. Specify 1 to the following bits to receive statuses corresponding to the bits. The function returns a status in each bit. Specify 0 for the reserved bits. When the function is successfully completed, the specified bit contains the status. A bit not specified contains 0. bit31,bit30 bit29 bit28 through bit14 bit13 bit12,bit11 bit10 bit9 bit8 bit7 through bit0 Reserved RAIDV1 Reserved IO Reserved FAN RAS0 WDTE Reserved WDTE: Operating status of the WDT is retrieved. 0: WDT enabled 1: WDT disabled RASO: RAS output status is retrieved. 0: relay off 1: relay on FAN: Operating status of fan is retrieved. 0: Fan stop 1: Fan operating IO: Operating status of I/O part is retrieved. 0: I/O stop 1: I/O operating This bit is supported only in Atom Z520T model of TOUGHCON Classembly Devices(R). RAIDV1: Status of RAID volume is retrieved. 0: Failure 1: Normal 59

60 Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INTERNAL C h Internal error IFCM_ERROR_NULL_POINTER C h NULL pointer detection IFCM_ERROR_INVALID_HANDLE C h Internal error Refer to 4.5 Return Values for details if the function returns a value other than 0. Examples Retrieving status of current WDT and RAS output status UINT Ret; UINT Status; Status = 0x ; Ret = CmGetSpecifiedStatus(&Status Dim Ret As Long Dim Status As Long Status = &H300 Ret = CmGetSpecifiedStatus(Status) uint Ret; uint Status; Status = 0x ; Ret = IFCCPMGR.CmGetSpecifiedStatus(ref Status.NET Dim Ret As Integer Dim Status As Integer Status = &H300 Ret = IFCCPMGR.CmGetSpecifiedStatus(Status) 60

61 22. CmGetRaidStatus Description The function retrieves a status of RAID. Syntax UINT CmGetRaidStatus( UINT Target, UINT* pstatus Declare Function CmGetRaidStatus Lib "ifcpmgr.dll"( _ ByVal Target As Long, _ ByRef pstatus As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmGetRaidStatus( uint Target, out uint pstatus.net Declare Function CmGetRaidStatus Lib "ifcpmgr.dll"(_ ByVal Target As Integer, _ ByRef pstatus As Integer _ )As Integer Parameters Target The parameter specifies a target to retrieve its status. Specify a value from the following table. Code Value Description CM_RAID_TARGET_VOLUME 0h Retrieves a status of the RAID volume. CM_RAID_TARGET_REBUILDING 100h Retrieves a progress of RAID1 rebuild. pstatus The parameter points to a variable to receive a status of the target. - Values retrieved when CM_RAID_TARGET_VOLUME is specified in Target Code Value Description CM_RAID_NORMAL 0h The RAID is successfully operating. CM_RAID_BROKEN 1h The RAID is damaged and the RAID volume cannot be used. CM_RAID_DEGRADE 2h The RAID1 failed and the system is not protected. CM_RAID_REBUILDING 3h RAID1 is being rebuilt. 61

62 - Values retrieved when CM_RAID_TARGET_REBUILDING is specified in Target Value Description 0 through 99 Retrieves a progress of RAID1 rebuild. The unit is %. * Retrieve the progress if CM_RAID_REBUILDING is retrieved when CM_RAID_TARGET_VOLUME is specified in Target. Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INTERNAL C h Internal error IFCM_ERROR_INVALID_PARAMETER C h Invalid input parameter IFCM_ERROR_NULL_POINTER C h NULL pointer detection IFCM_ERROR_INVALID_HANDLE C h Internal error Refer to 4.5 Return Values for details if the function returns a value other than 0. Examples Retrieving the status of the RAID volume or progress of rebuilding if RAID1 is being rebuilt UINT Ret; UINT Status; UINT Rebuilding; Ret = CmGetRaidStatus(CM_RAID_TARGET_VOLUME, &Status if (Status == CM_RAID_REBUILDING) { Ret = CmGetRaidStatus(CM_RAID_TARGET_REBUILDING, &Rebuilding } Dim Ret As Long Dim Status As Long Dim Rebuilding As Long Ret = CmGetRaidStatus(CM_RAID_TARGET_VOLUME, Status) If Status = CM_RAID_REBUILDING Then Ret = CmGetRaidStatus(CM_RAID_TARGET_REBUILDING, Rebuilding) End If uint Ret; uint Status; uint Rebuilding; Ret = IFCCPMGR.CmGetRaidStatus(IFCCPMGR.CM_RAID_TARGET_VOLUME, ref Status if (Status == IFCCPMGR.CM_RAID_REBUILDING) { Ret = IFCCPMGR.CmGetRaidStatus(IFCCPMGR.CM_RAID_TARGET_REBUILDING, out Rebuilding } 62

63 .NET Dim Ret As Integer Dim Status As Integer Dim Rebuilding As Integer Ret = IFCCPMGR.CmGetRaidStatus(IFCCPMGR.CM_RAID_TARGET_VOLUME, Status) If Status = CM_RAID_REBUILDING Then Ret = IFCCPMGR.CmGetRaidStatus(IFCCPMGR.CM_RAID_TARGET_REBUILDING, Rebuilding) End If 63

64 23. CmControlRO Description The function controls the RAS output. This function is available only on the products that support the RAS output function. Refer to the manual for supported functions. Syntax UINT CmControlRO( UINT Ctrl Declare Function CmControlRO Lib "ifcpmgr.dll"( _ ByVal Ctrl As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmControlRO( uint Ctrl.NET Declare Function CmControlRO Lib "ifcpmgr.dll"(_ ByVal Ctrl As Integer _ )As Integer Parameters Ctrl The parameter specifies a status of the RAS output. Code (*) Value Description CM_RO_OFF 0 Turns off the relay of the RAS output. CM_RO_ON 1 Turns on the relay of the RAS output * CM_RO_LOW and CM_RO_HIGH are also available for compatibility with the older versions. Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INTERNAL C h Internal error IFCM_ERROR_INVALID_PARAMETER C h Invalid input parameter IFCM_ERROR_INVALID_HANDLE C h Internal error Refer to 4.5 Return Values for details if the function returns a value other than 0. Comment When the power supply of the system is turned on, the relay of the RAS output is turned off. When the power supply is in standby status even during start or shutdown of the operating system, RAS output status is maintained. 64

65 Examples Turning on the relay of RAS output unsigned int Ret; Ret = CmControlRO(CM_RO_ON Dim Ret As Long Ret = CmControlRO(CM_RO_ON) uint Ret; Ret = IFCCPMGR.CmControlRO(IFCCPMGR.CM_RO_ON.NET Dim Ret As Integer Ret = IFCCPMGR.CmControlRO(IFCCPMGR.CM_RO_ON) 65

66 24. CmSetROConfig Description The function configures conditions of automatic RAS output and status of RAS output under abnormal conditions. This function is available only on the hardware that supports RAS output function. Refer to the manual for supported functions. Syntax UINT CmSetROConfig( UINT Enable, UINT Ctrl Declare Function CmSetROConfig Lib "ifcpmgr.dll"( _ ByVal Enable As Long, _ ByVal Ctrl As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmSetROConfig( uint Enable, uint Ctrl.NET Declare Function CmSetROConfig Lib "ifcpmgr.dll"(_ ByVal Enable As Integer, _ ByVal Ctrl As Integer _ )As Integer Parameters Enable The parameter specifies error conditions to assert the RAS output. Specify a value from the table below. Use OR operation to set multiple conditions. The default value is 0. Code Value Description CM_ROCONF_WDS 1h Asserts RAS output at the time-out error of the WDT. CM_ROCONF_CPTHS 2h Asserts RAS output when CPU temperature goes over the upper limit. CM_ROCONF_CPTLS 4h Asserts RAS output when CPU temperature goes below the lower limit. CM_ROCONF_LCTHS 8h Asserts RAS output when PCB temperature goes over the upper limit. CM_ROCONF_LCTLS 10h Asserts RAS output when PCB temperature goes below the lower limit. CM_ROCONF_V27VA 80h Asserts RAS output when power supply voltage is abnormal. 66

67 Ctrl The parameter specifies a status of RAS output under abnormal conditions. Specify a value from the table below. The default value is CM_RO_OFF. Code* Value Description CM_RO_OFF 0 Turns off relay of RAS output at detection of error. CM_RO_ON 1 Turns on relay of RAS output at detection of error. CM_RO_OFF_ON 2 Turns off relay of RAS output at detection of error. When the error specified by the Enable parameter recovers, the parameter turns on relay of RAS output. CM_RO_ON_OFF 3 Turns on relay of RAS output at detection of error. When the error specified by the Enable parameter recovers, the parameter turns off relay of RAS output. CM_RO_LOW and CM_RO_HIGH are supported for compatibility of older versions. CM_RO_OFF_ON and CM_RO_ON_OFF are applicable only to the Classembly Devices(R) with BayTrail processor. Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INTERNAL C h Internal error IFCM_ERROR_INVALID_PARAMETER C h Invalid input parameter IFCM_ERROR_INVALID_HANDLE C h Internal error Refer to 4.5 Return Values for details if the function returns a value other than 0. Comment When the conditions of automatic RAS output are configured by the Interface Utility, the settings are loaded at start of the system. Refer to RasOut for details. When a write-filter is enabled on storage, commit is needed to reflect the changes. When a write-protection is enabled on storage, disable the write-protection before change of settings is made. Examples Turning on relay of RAS output at error of WDT and/or power supply voltage. UINT Ret; Ret = CmSetROConfig(CM_ROCONF_WDS CM_ROCONF_V27VA, CM_RO_ON Dim Ret As Long Ret = CmSetROConfig(CM_ROCONF_WDS Or CM_ROCONF_V27VA, CM_RO_ON) uint Ret; Ret = IFCCPMGR.CmSetROConfig(IFCCPMGR.CM_ROCONF_WDS IFCCPMGR.CM_ROCONF_V27VA,IFCCPMGR.CM_RO_ON.NET Dim Ret As Integer Ret = IFCCPMGR.CmSetROConfig(IFCCPMGR.CM_ROCONF_WDS Or IFCCPMGR.CM_ROCONF_V27VA, IFCCPMGR.CM_RO_ON) 67

68 25. CmGetROConfig Description The function retrieves conditions of automatic RAS output and status of RAS output under abnormal conditions. This function is available only on the hardware that supports RAS output function. Refer to the manual for supported functions. Syntax UINT CmGetROConfig( UINT* penable, UINT* pctrl Declare Function CmGetROConfig Lib "ifcpmgr.dll"( _ ByRef penable As Long, _ ByRef pctrl As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmGetROConfig( out uint penable, out uint pctrl.net Declare Function CmGetROConfig Lib "ifcpmgr.dll"(_ ByRef penable As Integer, _ ByRef pctrl As Integer _ )As Integer Parameters penable The parameter points to a variable to receive error conditions to assert the RAS output. The parameter retrieves a value from the table below. One or more values can be ORed. Code Value Description CM_ROCONF_WDS 1h Asserts RAS output at the time-out error of the WDT. CM_ROCONF_CPTHS 2h Asserts RAS output when CPU temperature goes over the upper limit. CM_ROCONF_CPTLS 4h Asserts RAS output when CPU temperature goes below the lower limit. CM_ROCONF_LCTHS 8h Asserts RAS output when PCB temperature goes over the upper limit. CM_ROCONF_LCTLS 10h Asserts RAS output when PCB temperature goes below the lower limit. CM_ROCONF_V27VA 80h Asserts RAS output when abnormal power supply voltage is abnormal. 68

69 pctrl The parameter points to a variable to receive a status of the RAS output under abnormal conditions. The parameter retrieves a value from the table below. Code (*) Value Description CM_RO_OFF 0 Turns off relay of RAS output at detection of error. CM_RO_ON 1 Turns on relay of RAS output at detection of error. CM_RO_OFF_ON 2 Turns off relay of RAS output at detection of error. When the error specified by the Enable parameter recovers, the parameter turns on relay of RAS output. CM_RO_ON_OFF 3 Turns on relay of RAS output at detection of error. When the error specified by the Enable parameter recovers, the parameter turns off relay of RAS output. CM_RO_LOW and CM_RO_HIGH are supported for compatibility of older versions. CM_RO_OFF_ON and CM_RO_ON_OFF are applicable only to the Classembly Devices(R) with BayTrail processor. Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INTERNAL C h Internal error IFCM_ERROR_NULL_POINTER C h NULL pointer detection IFCM_ERROR_INVALID_HANDLE C h Internal error Refer to 4.5 Return Values for details if the function returns a value other than 0. Examples Retrieving conditions of RAS output and settings of RAS output at error. UINT Ret; UINT Enable; UINT Ctrl; Ret = CmGetROConfig(&Enable, &Ctrl Dim Ret As Long Dim Enable As Long Dim Ctrl As Long Ret = CmGetROConfig(Enable, Ctrl) uint Ret; uint Enable; uint Ctrl; Ret = IFCCPMGR.CmGetROConfig(out Enable, out Ctrl.NET Dim Ret As Integer Dim Enable As Integer Dim Ctrl As Integer Ret = IFCCPMGR.CmGetROConfig(Enable, Ctrl) 69

70 26. CmInputUP Description The function reads statuses of digital input and key matrix input pins. This function is available only on the hardware that supports digital input/output function. Refer to the manual for supported functions. Syntax UINT CmInputUP( UINT* pdata Declare Function CmInputUP Lib "ifcpmgr.dll"( _ ByRef pdata As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmInputUP( out uint pdata.net Declare Function CmInputUP Lib "ifcpmgr.dll"(_ ByRef pdata As Integer _ )As Integer Parameters pdata The parameter points to a variable to receive statuses of digital input pins and key matrix input pins. The table below shows status of each pin. bit31 through bit16 Reserved (Do not use.) bit15 Bit14 bit13 bit12 bit11 bit10 bit9 bit8 MIN16 MIN15 MIN14 MIN13 MIN12 MIN11 MIN10 MIN9 bit7 bit6 bit5 bit4 bit3 bit2 bit1 bit0 MIN8 MIN7 MIN6 MIN5 DIN4/MIN4 DIN3/MIN3 DIN2/MIN2 DIN1/MIN1 0: An external circuit is open, 1: An external circuit is closed. * The values in bit 15 through bit 4 are valid only in the key matrix input mode. 70

71 Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INTERNAL C h Internal error IFCM_ERROR_NULL_POINTER C h NULL pointer detection IFCM_ERROR_INVALID_HANDLE C h Internal error IFCM_ERROR_NOT_SUPPORT C h Not supported Refer to 4.5 Return Values for details if the function returns a value other than 0. Comment Key matrix input is available in Sho-ene Classembly Devices Extended Temperature Model and Touch Panel Classembly Devices Extended Temperature Model. Matrix input pins (MIN1 through MIN16) are connected as follows. (Refer to the manual for example connections and circuit diagrams.) Refer to 28 CmSetModeUP and DIO to switch digital input/output modes. Matrix input (4 inputs x 4 outputs) IN1 IN2 IN3 IN4 OUT1 MIN1 MIN2 MIN3 MIN4 OUT2 MIN5 MIN6 MIN7 MIN8 OUT3 MIN9 MIN10 MIN11 MIN12 OUT4 MIN13 MIN14 MIN15 MIN16 Matrix input (4 inputs x 3 outputs) IN1 IN2 IN3 IN4 OUT1 MIN1 MIN2 MIN3 MIN4 OUT2 MIN5 MIN6 MIN7 MIN8 OUT3 MIN9 MIN10 MIN11 MIN12 Matrix input (4 inputs x 2 outputs) IN1 IN2 IN3 IN4 OUT1 MIN1 MIN2 MIN3 MIN4 OUT2 MIN5 MIN6 MIN7 MIN8 71

72 Examples Reading digital input pins and key matrix input pins unsigned int Ret; unsigned int Data; Ret = CmInputUP(&Data Dim Ret As Long Dim Data As Long Ret = CmInputUP(Data) uint Ret; uint Data; Ret = IFCCPMGR.CmInputUP(out Data.NET Dim Ret As Integer Dim Data As Integer Ret = IFCCPMGR.CmInputUP(Data) 72

73 27. CmOutputUP Description The function controls digital output pins. This function is available only on the hardware that supports digital input/output function. Refer to the manual for supported functions. Syntax UINT CmOutputUP( UINT Data Declare Function CmOutputUP Lib "ifcpmgr.dll"( _ ByVal Data As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmOutputUP( uint Data.NET Declare Function CmOutputUP Lib "ifcpmgr.dll"(_ ByVal Data As Integer _ )As Integer Parameters Data The parameter specifies data of digital output pins. The table below shows the correspondence of each bit and output pin. bit31 through bit4 bit3 bit2 bit1 bit0 Reserved (Specify 0.) DOUT4 DOUT3 DOUT2 DOUT1 0: An external circuit is open, 1: An external circuit is closed. Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INTERNAL C h Internal error IFCM_ERROR_INVALID_HANDLE C h Internal error IFCM_ERROR_NOT_SUPPORT C h Not supported IFCM_ERROR_INVALID_MODE C000000Ah Setting error Refer to 4.5 Return Values for details if the function returns a value other than 0. 73

74 ! Caution Examples Turning on DOUT1 When key matrix input is used on Sho-ene Classembly Devices Extended Temperature model, available pins are limited as follows. Key matrix input (4 inputs 4 outputs): This function is not available. Key matrix input (4 inputs 3 outputs): Only DOUT 4 is available. Key matrix input (4 inputs 2 outputs): Only DOUT3 and DOUT 4 are available. When key matrix input is used on Touch Panel Classembly Devices Extended Temperature model, available pins are limited as follows. Key matrix input (4 inputs 3 outputs): This function is not available. Key matrix input (4 inputs 2 outputs): Only DOUT 3 is available. unsigned int Ret; Ret = CmOutputUP(0x Dim Ret As Long Ret = CmOutputUP(&H1) uint Ret; Ret = IFCCPMGR.CmOutputUP(0x NET Dim Ret As Integer Ret = IFCCPMGR.CmOutputUP(&H1) 74

75 28. CmSetModeUP Description The function configures an operation mode of digital input/output pins and key matrix input pins. This function is applicable to the Sho-ene Classembly Devices Extended Temperature model and Touch Panel Classembly Devices Extended Temperature model. Syntax UINT CmSetModeUP( UINT Mode Declare Function CmSetModeUP Lib "ifcpmgr.dll"( _ ByVal Mode As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmSetModeUP( uint Mode.NET Declare Function CmSetModeUP Lib "ifcpmgr.dll"(_ ByVal Mode As Integer _ )As Integer Parameters Mode The parameter specifies an operation mode of digital input/output pins and key matrix input pins. The following modes are configurable. The default mode is CM_IN_OUT. Refer to 26 CmInputUP, 27 CmOutputUP. Code Value Description CM_IN_OUT 0 Sets to digital input/output CM_MATRIX_IN( *1 ) 1 Sets to key matrix input (4 inputs 4 outputs). MIN1 through MIN16 are available. No digital output pin is available. CM_MATRIX_IN_4X3 2 Sets to key matrix input (4 inputs 3 outputs). MIN1 through MIN12 are available. DOUT4 (digital output pin) is available *2. CM_MATRIX_IN_4X2 3 Sets to key matrix input (4 inputs 2 outputs). MIN1 through MIN8 are available. DOUT3 and DOUT4 (digital output pins) are available *2. Notes: - *1 The code is not supported on Touch Panel Classembly Devices Extended Temperature model. - *2 DOUT4 is not supported on Touch Panel Classembly Devices Extended Temperature model. 75

76 Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INTERNAL C h Internal error IFCM_ERROR_INVALID_PARAMETER C h Invalid input parameter IFCM_ERROR_INVALID_HANDLE C h Internal error IFCM_ERROR_NOT_SUPPORT C h Not supported Refer to 4.5 Return Values for details if the function returns a value other than 0. Comment When the operation mode of digital input/output pins and key matrix input pins is configured by the Interface Utility, the settings are loaded at start of the system. Refer to DIO for more details. When a write-filter is enabled on storage, commit is needed to reflect the changes. When a write-protection is enabled on storage, disable the write-protection before change of settings is made. Examples Setting to key matrix input (4 inputs 4 outputs) UINT Ret; Ret = CmSetModeUP(CM_MATRIX_IN Dim Ret As Long Ret = CmSetModeUP(CM_MATRIX_IN) uint Ret; Ret = IFCCPMGR.CmSetModeUP(IFCCPMGR.CM_MATRIX_IN.NET Dim Ret As Integer Ret = IFCCPMGR.CmSetModeUP(IFCCPMGR.CM_MATRIX_IN) 76

77 29. CmGetModeUP Description The function retrieves an operation mode of digital input/output pins and key matrix input pins. This function is applicable to the Sho-ene Classembly Devices Extended Temperature model and Touch Panel Classembly Devices Extended Temperature model. Syntax UINT CmGetModeUP( UINT* pmode Declare Function CmGetModeUP Lib "ifcpmgr.dll"( _ ByVal pmode As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmGetModeUP( Out uint pmode.net Declare Function CmGetModeUP Lib "ifcpmgr.dll"(_ ByRef pmode As Integer _ )As Integer Parameters pmode This parameter points to a variable to receive an operation mode of the digital input/output pins and key matrix input pins. The values configured by the CmSetModeUP function are retrieved. Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INTERNAL C h Internal error IFCM_ERROR_NULL_POINTER C h NULL pointer detection IFCM_ERROR_INVALID_HANDLE C h Internal error IFCM_ERROR_NOT_SUPPORT C h Not supported Refer to 4.5 Return Values for details if the function returns a value other than 0. 77

78 Examples Retrieving an operation mode of the input/output pins and key matrix input pins UINT Ret; UINT Mode; Ret = CmGetModeUP(&Mode Dim Ret As Long Dim Mode As Long Ret = CmGetModeUP(Mode) uint Ret; uint Mode; Ret = IFCCPMGR.CmGetModeUP(out Mode.NET Dim Ret As Integer Dim Mode As Integer Ret = IFCCPMGR.CmGetModeUP(Mode) 78

79 30. CmSetBrightness Description The function configures brightness level. This function is available only on the hardware that supports brightness control function. Refer to the manual for supported functions. Syntax UINT CmSetBrightness( UINT Brightness Declare Function CmSetBrightness Lib "ifcpmgr.dll"( _ ByVal Brightness As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmSetBrightness ( uint Brightness.NET Declare Function CmSetBrightness Lib "ifcpmgr.dll"(_ ByVal Brightness As Integer _ )As Integer 79

80 Parameters Brightness The parameter specifies brightness level. The following values can be specified. Product Description Atom E3845 model Normal 26 through 255 setting Pass a value to the parameter directly. Extended setting High-Speed Power-Saving (Atom N2800) model Extended Temperature (Intel Atom E680T (E640)) model Normal setting Extended setting Normal setting Extended setting Other models 1 through 16 The larger value means the brighter screen. 0 through 255 Pass a value by ORing with CM_BRIGHTNESS_EX. (value: h) To store a value from 0 through 25 in a ROM, pass the value by ORing with CM_BRIGHTNESS_SAVE (value: h). If a value from 0 through 25 is set without specifying CM_BRIGHTNESS_SAVE, a value of 26 is stored. * The brightness levels from 1 through 25 can be specified but the operation is not guaranteed. It would be better to fully test the settings on your environment before deployment. * When 0 is specified, the screen will be blank. * he CM_BRIGHTNESS_EX bit can be used only for settings. It cannot be retrieved. 26 through 255 Pass a value to the parameter directly. 0 through 255 Pass a value by ORing with CM_BRIGHTNESS_EX. (value: h) * The brightness levels from 1 through 25 can be specified but the operation is not guaranteed. It would be better to fully test the settings on your environment before deployment. * When 0 is specified, the screen will be blank. * In High-Speed Power-Saving (Atom N2800) model, the CM_BRIGHTNESS_EX bit can be used only for settings. It cannot be retrieved. 1 through 16 Pass a value to the parameter directly. 0 through 255 Pass a value by ORing with CM_BRIGHTNESS_EX. (value: h) In the Extended setting, the brightness level can be darker than level 1 of the normal setting. * The brightness levels from 1 through 13 can be specified but the operation is not guaranteed. It would be better to fully test the settings on your environment before deployment. * When 0 is specified, the screen will be blank. 80

81 Comments - When software adjustment is disabled by the DIP switch, the settings configured by this function are ignored. Touch Panel Classembly Devices Extended Temperature model has no DIP switch. - The settings configured by this function are stored in the non-volatile memory 5 seconds later. The settings are loaded from it and are configured as the default values at start of the system. Touch Panel Classembly Devices Extended Temperature model has no non-volatile memory. Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INVALID_PARAMETER C h Invalid input parameter IFCM_ERROR_INVALID_HANDLE C h Internal error IFCM_ERROR_NOT_SUPPORT C h Not supported Refer to 4.5 Return Values for details if the function returns a value other than 0. Examples Setting the brightness level to 2 unsigned int Ret; Ret = CmSetBrightness(2 Dim Ret As Long Ret = CmSetBrightness(2) uint Ret; Ret = IFCCPMGR.CmSetBrightness(2.NET Dim Ret As Integer Ret = IFCCPMGR.CmSetBrightness(2) 81

82 31. CmGetBrightness Description The function retrieves a brightness level. This function is available only on the hardware that supports brightness control function. Refer to the manual for supported functions. Syntax UINT CmGetBrightness ( UINT* pbrightness Declare Function CmGetBrightness Lib "ifcpmgr.dll"( _ ByRef pbrightness As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmGetBrightness ( out uint pbrightness.net Declare Function CmGetBrightness Lib "ifcpmgr.dll"(_ ByRef pbrightness As Integer _ )As Integer Parameters pbrightness The parameter points to variable to receive the brightness level. The larger value means the brighter screen. Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_NULL_POINTER C h NULL pointer detection IFCM_ERROR_INVALID_HANDLE C h Internal error IFCM_ERROR_NOT_SUPPORT C h Not supported Refer to 4.5 Return Values for details if the function returns a value other than 0. Comment The High-Speed Power-Saving (Intel Atom N2800) model does not retrieve CM_BRIGHTNESS_EX bit (value: h) even if the extended setting is used. 82

83 Examples Retrieving a brightness level UINT Ret; UINT Bright; Ret = CmGetBrightness(&Bright Dim Ret As Long Dim Bright As Long Ret = CmGetBrightness(&Bright) uint Ret; uint Bright; Ret = IFCCPMGR.CmGetBrightness(out Bright.NET Dim Ret As Integer Dim Bright As Integer Ret = IFCCPMGR.CmGetBrightness(Bright) 83

84 32. CmSetVolume Description The function configures a volume level. This function is available only on the hardware that supports volume control function. Refer to the manual for supported functions. Syntax UINT CmSetVolume ( UINT Volume Declare Function CmSetVolume Lib "ifcpmgr.dll"( _ ByVal Volume As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmSetVolume( uint Volume.NET Declare Function CmSetVolume Lib "ifcpmgr.dll"(_ ByVal Volume As Integer _ )As Integer Parameters Volume The parameter specifies a volume level. Value Description 0 Mute 1 Minute 2 Low 3 Middle 4 High In Touch Panel Classembly Devices Extended Temperature model, only the following values can be specified. Value Description 0 Mute 1 Output ON Refer to the manual for volume control when output ON is specified. 84

85 Comments - When software adjustment is disabled by the DIP switch, the settings configured by this function are ignored. Touch Panel Classembly Devices Extended Temperature model has no DIP switch. - The settings configured by this function are stored in the non-volatile memory 5 seconds later. The settings are loaded from it and are configured as the default values at start of the system. Touch Panel Classembly Devices Extended Temperature model has no volatile memory. Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INVALID_PARAMETER C h Invalid input parameter IFCM_ERROR_INVALID_HANDLE C h Internal error IFCM_ERROR_NOT_SUPPORT C h Not supported Refer to 4.5 Return Values for details if the function returns a value other than 0. Examples Setting volume to low unsigned int Ret; Ret = CmSetVolume(2 Dim Ret As Long Ret = CmSetVolume(2) uint Ret; Ret = IFCCPMGR.CmSetVolume(2.NET Dim Ret As Integer Ret = IFCCPMGR.CmSetVolume(2) 85

86 33. CmGetVolume Description The function retrieves a volume level. This function is available only on the hardware that supports volume control function. Refer to the manual for supported functions. Syntax UINT CmGetVolume ( UINT* pvolume Declare Function CmGetVolume Lib "ifcpmgr.dll"( _ ByRef pvolume As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmGetVolume ( out uint pvolume.net Declare Function CmGetVolume Lib "ifcpmgr.dll"(_ ByRef pvolume As Integer _ )As Integer Parameters pvolume The parameter points to variable to receive a volume level. Value Description 0 Mute 1 Minute 2 Low 3 Middle 4 High In Touch Panel Classembly Devices Extended Temperature model, only the following values can be retrieved. Value Description 0 Mute 1 Output ON Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_NULL_POINTER C h NULL pointer detection IFCM_ERROR_INVALID_HANDLE C h Internal error IFCM_ERROR_NOT_SUPPORT C h Not supported Refer to 4.5 Return Values for details if the function returns a value other than 0. 86

87 Examples Retrieving a volume level UINT Ret; UINT Volume; Ret = CmGetVolume(&Volume Dim Ret As Long Dim Volume As Long Ret = CmGetVolume(&Volume) uint Ret; uint Volume; Ret = IFCCPMGR.CmGetVolume(out Volume.NET Dim Ret As Integer Dim Volume As Integer Ret = IFCCPMGR.CmGetVolume(Volume) 87

88 34. CmGetBatStatus Description The function retrieves a battery status. This function is available only when a battery module is connected. Syntax UINT CmGetBatStatus( UINT* pstatus Declare Function CmGetBatStatus Lib "ifcpmgr.dll"( _ ByRef pstatus As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmGetBatStatus( out uint pstatus.net Declare Function CmGetBatStatus Lib "ifcpmgr.dll"(_ ByRef pstatus As Integer _ )As Integer 88

89 Parameters pstatus This parameter points to a variable to receive the battery status. * BLALM and RSOC2 through RSOC0 change according to a type of the battery module bit31 through bit8 Reserved bit7 bit6 bit5 bit4 bit3 bit2 bit1 bit0 ERR BLALM LALM DCHG CHG RSOC2 RSOC1 RSOC0 ERR : Battery error 0: No error occurs. 1: Battery error occurs. * Contact our Customer Support Center in case of battery error. BLALM : Low battery level alarm 0: Normal 1: The battery level is equal to or less than 20%. LALM : Lifetime alarm 0: Normal 1: Lifetime alarm is generated. * Replace the battery module when lifetime alarm is generated. DCHG : Discharge status 0: Not discharging 1: Discharging CHG : Charge status 0: Not charging 1: Charging RSOC2, RSOC1, RSOC0 : Battery level 111: 100% to 80% 011: 79% to 30% 001: 29% to 1% 000: 0 % JPS-BUSTC/JPS-BUETCA/JPS-BUETC2/JPS-BUSTC2 BLALM : Low battery level alarm 0: Normal 1: The battery level is equal to or less than 30%. RSOC2, : Battery level RSOC1 11: 100% to 80% 01: 79% to 30% 00: 29% to 0% RSOC0 : Connection status of external battery (External battery input pin (BU_IN2)) Ignore this bit when no external battery is used. 0: Not connected 1: Connected 89

90 Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INTERNAL C h Internal error IFCM_ERROR_NULL_POINTER C h NULL pointer detection IFCM_ERROR_INVALID_HANDLE C h Internal error IFCM_ERROR_NOT_LINKED C h Battery module connection error Refer to 4.5 Return Values for details if the function returns a value other than 0. Comments We provide optional battery modules. Contact our Customer Support Center for more information. BLALM and RSOC2 through RSOC0 change according to a type of the battery module. Examples Retrieving the current battery status UINT Ret; UINT Status; Ret = CmGetBatStatus(&Status Dim Ret As Long Dim Status As Long Ret = CmGetBatStatus(Status) uint Ret; uint Status; Ret = IFCCPMGR.CmGetBatStatus(out Status.NET Dim Ret As Integer Dim Status As Integer Ret = IFCCPMGR.CmGetBatStatus(Status) 90

91 35. CmSetPowerOffTime Description The function configures interval times between occurrence of power failure and shutdown/forced power off. This function is available only when a battery module is connected. Syntax UINT CmSetPowerOffTime( UINT Shutdown, UINT PowerOff Declare Function CmSetPowerOffTime Lib "ifcpmgr.dll"( _ ByVal Shutdown As Long, _ ByVal PowerOff As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmSetPowerOffTime( uint Shutdown, uint PowerOff.NET Declare Function CmSetPowerOffTime Lib "ifcpmgr.dll"(_ ByVal Shutdown As Integer, _ ByVal PowerOff As Integer _ )As Integer Parameters Shutdown The parameter specifies the interval time between occurrence of power failure and start of shutdown. The configurable range is from 0 through 255 seconds in every 1 second. The default setting is 16 seconds. If 0 is specified, the system is not shut down or forced power off. PowerOff The parameter specifies the interval time between start of shutdown and forced power off. The configurable range is from 0 through 255 seconds in every 1 second. The default setting is 180 seconds. If 0 is specified, the system is not forcibly powered off. 91

92 Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INTERNAL C h Internal error IFCM_ERROR_INVALID_PARAMETER C h Invalid input parameter IFCM_ERROR_INVALID_HANDLE C h Internal error IFCM_ERROR_NOT_LINKED C h Battery module connection error Refer to 4.5 Return Values for details if the function returns a value other than 0. Comments - If this function is executed after a power failure, the system start shutdown after the newly configured time. - If this function is executed by two or more application programs, the latest specified time is effective. - Even if the operating system is restarted or shut down, the settings remain as long as the power is in standby status. - We provide optional battery modules. Contact our Customer Support Center for more information. - When the interval time between occurrence of power failure and shutdown/forced shutdown are configured by the Interface Utility, the settings are loaded at start of the system. Refer to Battery for more details. When a write-filter is enabled on storage, commit is needed to reflect the changes. When a write-protection is enabled on storage, disable the write-protection before change of settings is made. Examples Configuring the interval time between occurrence of power failure and start of shutdown to 16 seconds, and between start of shutdown and forced power off to 180 seconds UINT Ret; Ret = CmSetPowerOffTime(16, 180 Dim Ret As Long Ret = CmSetPowerOffTime(16, 180) uint Ret; Ret = IFCCPMGR.CmSetPowerOffTime(16, 180.NET Dim Ret As Integer Ret = IFCCPMGR.CmSetPowerOffTime(16, 180) 92

93 36. CmGetPowerOffTime Description The function retrieves the interval times between occurrence of power failure and shutdown/forced power off. This function is available only when a battery module is connected. Syntax UINT CmGetPowerOffTime( UINT* pshutdown, UINT* ppoweroff Declare Function CmGetPowerOffTime Lib "ifcpmgr.dll"( _ ByRef pshutdown As Long, _ ByRef ppoweroff As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmGetPowerOffTime( out uint pshutdown, out uint ppoweroff.net Declare Function CmGetPowerOffTime Lib "ifcpmgr.dll"(_ ByRef pshutdown As Integer, _ ByRef ppoweroff As Integer _ )As Integer Parameters pshutdown The parameter points to a variable to receive the interval time between occurrence of power failure and start of shutdown. A value that is configurable by the CmSetPowerOffTime function can be retrieved. ppoweroff The parameter points to a variable to receive the interval time between start of shutdown and forced power off. A value that is configurable by the CmSetPowerOffTime function can be retrieved. Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INTERNAL C h Internal error IFCM_ERROR_NULL_POINTER C h NULL pointer detection IFCM_ERROR_INVALID_HANDLE C h Internal error IFCM_ERROR_NOT_LINKED C h Battery module connection error Refer to 4.5 Return Values for details if the function returns a value other than 0. 93

94 Comment - We provide optional battery modules. Contact our Customer Support Center for more information. Examples Retrieving the interval time between occurrence of power failure and start of shutdown and between start of shutdown and forced power off UINT Ret; UINT Shutdown; UINT PowerOff; Ret = CmGetPowerOffTime(&Shutdown, &PowerOff Dim Ret As Long Dim Shutdown As Long Dim PowerOff As Long Ret = CmGetPowerOffTime(Shutdown, PowerOff) uint Ret; uint Shutdown; uint PowerOff; Ret = IFCCPMGR.CmGetPowerOffTime(out Shutdown, out PowerOff.NET Dim Ret As Integer Dim Shutdown As Integer Dim PowerOff As Integer Ret = IFCCPMGR.CmGetPowerOffTime(Shutdown, PowerOff) 94

95 37. CmSetBatSimStatus Description The function configures the simulation function for status of a battery module. When battery simulation is enabled, the CmGetBatStatus function returns a simulated status of a battery specified by this function. Syntax UINT CmSetBatSimStatus( UINT Simulation, UINT SimStatus Declare Function CmSetBatSimStatus Lib "ifcpmgr.dll"( _ ByVal Simulation As Long, _ ByVal SimStatus As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmSetBatSimStatus( uint Simulation, uint SimStatus.NET Declare Function CmSetBatSimStatus Lib "ifcpmgr.dll"(_ ByVal Simulation As Integer, _ ByVal SimStatus As Integer _ )As Integer Parameters Simulation The parameter enables or disables the simulation function of a battery. The following values can be specified. The default value is CM_BAT_SIM_OFF. Code Value Description CM_BAT_SIM_OFF 0 The simulation function of a battery is disabled. CM_BAT_SIM_ON 1 The simulation function of a battery is enabled. SimStatus The parameter specifies a simulation status. The parameter is enabled when CM_BAT_SIM_ON is specified in the Simulation parameter. The setting values are the same as the values that the CmGetBatStatus function can retrieve. 95

96 Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INVALID_PARAMETER C h Invalid input parameter IFCM_ERROR_INVALID_HANDLE C h Internal error Refer to 4.5 Return Values for details if the function returns a value other than 0. Comments The CmSetBatSimStatus function simulates only the status that the CmGetBatStatus function returns. The real battery statuses are not affected. For example, even if the battery status is set to discharging, shutdown and/or forced power off do not occur after the interval time configured by the CmSetPowerOffTime function elapsed. When the operating system restarts, the simulation function is disabled. Examples Simulating the ERR bit of a battery UINT Ret; UINT Status; Ret = CmGetBatStatus(&Status Ret = CmSetBatSimStatus(CM_BAT_SIM_ON, (Status 0x80) Dim Ret As Long Dim Status As Long Ret = CmGetBatStatus(Status) Ret = CmSetBatSimStatus(CM_BAT_SIM_ON, (Status Or &H80)) uint Ret; uint Status; Ret = IFCCPMGR.CmGetBatStatus(out Status Ret = IFCCPMGR.CmSetBatSimStatus(IFCCPMGR.CM_BAT_SIM_ON, (Status 0x80).NET Dim Ret As Integer Dim Status As Integer Ret = IFCCPMGR.CmGetBatStatus(Status) Ret = IFCCPMGR.CmSetBatSimStatus(IFCCPMGR.CM_BAT_SIM_ON, (Status Or_ &H80)) 96

97 38. CmGetBatSimStatus Description The function retrieves the settings of the battery simulation. Syntax UINT CmGetBatSimStatus( UINT* psimulation, UINT* psimstatus Declare Function CmGetBatSimiStatus Lib "ifcpmgr.dll"( _ ByRef psimulation As Long, _ ByRef psimstatus As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmGetBatSimStatus( out uint psimulation, out uint psimstatus.net Declare Function CmGetBatSimStatus Lib "ifcpmgr.dll"(_ ByRef psimulation As Integer, _ ByRef psimstatus As Integer _ )As Integer Parameters psimulation The parameter points to a variable to receive settings of the simulation function of the battery. The values configured by the CmSetBatSimStatus can be retrieved. psimstatus The parameter points to a variable to receive the simulation status value. Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_NULL_POINTER C h NULL pointer detection IFCM_ERROR_INVALID_HANDLE C h Internal error Refer to 4.5 Return Values for details if the function returns a value other than 0. 97

98 Comment - We provide optional battery modules. Contact our Customer Support Center for more information. Examples Retrieving the settings of the battery simulation UINT Ret; UINT Simulation; UINT SimStatus; Ret = CmGetBatSimStatus(&Simulation, &SimStatus Dim Ret As Long Dim Simulation As Long Dim SimStatus As Long Ret = CmGetBatSimStatus(Simulation, SimStatus) uint Ret; uint Simulation; uint SimStatus; Ret = IFCCPMGR.CmGetBatSimStatus(out Simulation, out SimStatus.NET Dim Ret As Integer Dim Simulation As Integer Dim SimStatus As Integer Ret = IFCCPMGR.CmGetBatSimStatus(Simulation, SimStatus) 98

99 39. CmGetIlluminance Description The function retrieves an illuminance. This function is available only on the hardware that supports illuminance retrieval function. Refer to the manual for supported functions. Syntax UINT CmGetIlluminance( UINT* pillumi Declare Function CmGetIlluminance Lib "ifcpmgr.dll"( _ ByRef pillumi As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint CmGetIlluminance( out uint pillumi.net Declare Function CmGetIlluminance Lib "ifcpmgr.dll"(_ ByRef pilllumi As Integer _ )As Integer Parameters pillumi This parameter points to a variable to receive an illuminance. The unit is lx (lux). A value from 0 through can be retrieved. Return Values This function returns the following return values. Code Value Description IFCM_ERROR_SUCCESS 0 Successful completion IFCM_ERROR_INTERNAL C h Internal error IFCM_ERROR_NULL_POINTER C h NULL pointer detection IFCM_ERROR_INVALID_HANDLE C h Internal error IFCM_ERROR_NOT_SUPPORT C h Not supported Refer to 4.5 Return Values for details if the function returns a value other than 0. 99

100 Examples Retrieving an illuminance UINT Ret; UINT Illumi; Ret = CmGetIlluminance(&Illumi Dim Ret As Long Dim Illumi As Long Ret = CmGetIlluminance(Illumi) uint Ret; uint Illumi; Ret = IFCCPMGR.CmGetIlluminance(out Illumi.NET Dim Ret As Integer Dim Illumi As Integer Ret = IFCCPMGR.CmGetIlluminance(Illumi). 100

101 4.3 Callback Function Description The callback function is supported only in C. Syntax void CALLBACK UserCallBack( PVOID User Parameters User The value specified by the User member of the CM_EVENT_REQ structure is passed to this parameter. Refer to CM_EVENT_REQ for details. Examples Refer to Interrupt Event Handling for details. 101

102 4.4 Structure CM_EVENT_REQ The structure is used to register interrupt events. typedef struct _CM_EVENT_REQ{ HANDLE Signal; HWND Wnd; UINT Msg; LPCMCALLBACK CallBackProc; PVOID User; } CM_EVENT_REQ, *PCM_EVENT_REQ; Type CM_EVENT_REQ Signal As Long Wnd As Long Msg As Long CallBackProc As Long User As Long End Type [StructLayout(LayoutKind.Sequential)] public struct CM_EVENT_REQ { public IntPtr Signal; putlic IntPtr Wnd; public int Msg; public IntPtr CallBackProc; putlib IntPtr User; }.NET <StructLayout(LayoutKind.Sequential)> Structure CM_EVENT_REQ Dim Signal As IntPtr Dim Wnd As IntPtr Dim Msg As Integer Dim CallBackProc As IntPtr Dim User As IntPtr End Structure 102

103 Member Signal Wnd Msg CallBackProc User Descriptions The member specifies a handle of an event object that is signaled when an interrupt event is generated. If you do not use any event objects, specify NULL for C, 0 for Visual Basic, and IntPtr.Zero for Visual C#.NET and Visual Basic.NET. The member specifies a handle of a window to which a message specified by the Msg member is posted. If you do not use messaging, specify NULL for C, 0 for Visual Basic, and IntPtr.Zero for Visual C#.NET and Visual Basic.NET. The member specifies a message code to be sent when an interrupt event is generated. If you do not use message post, specify WM_NULL for C, and 0 for Visual Basic, Visual C#.NET, and Visual Basic.NET. The member points to a callback function to be called when an interrupt event is generated. The callback function is supported only in C. Specify 0 for Visual Basic, and IntPtr.Zero for Visual C#.NET and Visual Basic.NET. When you do not use the callback function in C, specify NULL. The member specifies a user data to be passed to the callback function. The specified data is the first argument of the callback function. Specify 0 for Visual Basic, and IntPtr.Zero for Visual C#.NET and Visual Basic.NET. 103

104 4.5 Return Values Error Code Value Description Comments/Solutions IFCM_ERROR_SUCCESS 0 Successful completion - IFCM_ERROR_INTERNAL C h ( ) Internal error Internal error during hardware control. Contact and tell us how the error occurred. IFCM_ERROR_INVALID_ C h Invalid input parameter Check the configurable range to PARAMETER IFCM_ERROR_ALREADY IFCM_ERROR_NOT_YET IFCM_ERROR_NULL_POI NTER IFCM_ERROR_NOT_ ALLOCATE IFCM_ERROR_INVALID_ HANDLE IFCM_ERROR_NOT_ SUPPORT IFCM_ERROR_NOT_ LINKED IFCM_ERROR_INVALID_ MODE ( ) C h ( ) C h ( ) C h ( ) C h ( ) C h ( ) C h ( ) C h ( ) C000000Ah ( ) - WDT has already been in operation. - Events have already been registered. - WDT has not been in operation yet. - Any events have not registered yet. NULL pointer detection Memory allocation failed. Internal error Not supported Battery module connection error Setting error configure parameters. - Execute while WDT stops. - Execute under the condition that any events are not registered. - Execute while WDT is working. - Execute under the condition that events are registered. NULL is passed to the argument. Specify a valid variable. Refrain from consuming memory space. Internal error during initializing DLL. Check that IFCPMGR is running normally with Device Manager. The function is not supported. Refer to the manual to check that the function is supported. Check that the battery module is correctly connected. The function you specified is not available in the current mode. Check the settings of the CmSetModeUP function. 104

105 Chapter 5 Sample Programs 5.1 Execution Procedure This product provides executable files of the sample programs. Double-click each executable file (*.exe) to start. To use the sample programs for Visual C#.NET or Visual Basic.NET,.NET Framework 1.1 or later version is required. (event_clr for Visual C++.NET requires 2.0 or later versions.) 5.2 Compiling Files This product provides sample program files. Compile the source code and create executable file to start. Visual C Start Visual Studio. 2. Select File > Open Workspace. 3. Open the makefile, *.dsp. 4. Build the project file. 5. Run the executable file, *.exe. Visual C++.NET (Microsoft Visual C++.NET 2003 through 2008) 1. Start Visual Studio. 2. Select File > Open > Project. 3. Open the makefile, *.vcproj. 4. Build the project file. 5. Run the executable file, *.exe. Visual C++.NET (Microsoft Visual C++.NET 2010 and later versions) 1. Start Visual Studio. 2. Select File > Open > Project. 3. Open the project file, *.vcxproj. 4. Build the project file. 5. Run the executable file, *.exe. The *.vcxproj file is created with Visual Studio To use the file in a later version than Visual Studio 2010, configure as follows. 1. In Visual Studio, select Project > Properties > Configuration Properties > General. 2. Select Platform Toolset and then select toolset you want from the drop-down list. For example, if you use Visual Studio 2012, select Visual Studio 2012(v110) from the drop-down menu. 1. Start Visual Basic. 2. Open the project file, *.vbp. 3. Build the project file. 4. Run the executable file, *exe. 1. Start Visual Studio. 2. Select File > Open > Project. 3. Open the project file, *.csproj. 4. Build the project file. 5. Run the executable file, *.exe. 105

106 .NET 1. Start Visual Studio. 2. Select File > Open > Project. 3. Open the project file, *.vbproj. 4. Build the project file. 5. Run the executable file, *.exe. Note: The class library will be automatically built at the same time as opening the project files. 106

107 5.3 List of Sample Programs Sample program Description wdt The sample program configures a time-out time of the WDT to 5 seconds and an action of the time-out to CPU reset. The sample program clears the WDT every 3 seconds. The sample program exits after it clears the WDT five times. temperature The sample program retrieves and displays temperatures of CPU and PCB every 3 seconds. The sample program exits after it displays the temperatures five times. power The sample program retrieves and displays a power supply voltage every 3 seconds. The sample program exits after it displays the power supply voltage five times. event The sample program notifies a time-out events of the WDT by signaling an event, calling a callback function (applicable only in Visual C++), and posting a message. It works as follows; - set a time-out time of the WDT to 3 second and an action of the time-out to interrupt event with the Initialize WDT button, - register a signal event with the Signal button, - register a callback functions with the Callback button, - registers a message handlers with the Message button, and - execute post-processes such as deleting the events with the Kill Event button. * We provide sample programs of MFC(event_mfc) and CLR(event_clr) for Visual C++. Use CLR in Visual C or later versions. rasout The sample program outputs the RAS signal automatically in the abnormal status. It sets the time-out time of the WDT to 3 seconds and sets RAS output to relay on at the occurrence of a WDT error. (The sample program is applicable to only hardware that supports the RAS output function.) dio This sample program reads/writes digital input/output. After the sample program writes digital output, it waits for a second and reads digital input and then displays the input data. It shifts output data. It repeats above 4 times (The sample program is applicable to only hardware that supports the digital input/output function.) bat The sample program retrieves battery status every 3 seconds and displays it five times. If low battery alarm is generated during discharging, the sample program shuts down the system. The sample program exits after it displays the status five times. matrix The sample program configures the key matrix of 4 input 4 output and displays the input status every second. The sample program exits after it displays the status five times. illuminance The sample program retrieves illuminance every 3 seconds and displays it five times. 107

108 Chapter 6 Utility Programs 6.1 Brightness and Volume Control Utility program Click the Start button, point to Programs, point to Interface IFCPMGR, and then click Brightness and Volume Control Utility program. The following dialog box appears. This function is available only on the hardware that supports brightness and volume control function. Refer to the manual for supported functions. Move the left slider to adjust brightness. A larger number means a higher brightness level. * This utility cannot set the brightness level to 0 in products other than Atom E3845 model. * For High-Speed Power-Saving (Intel Atom N2800) model, Extended Temperature (Intel Atom E680T (E640)) model, and Atom E3845 model, extended brightness settings are available by selecting the extension check box. For Atom E3845 model, values from 0 through 25 can be stored in the ROM by selecting the extension save check box. * Refer to the Brightness parameter of the CmSetBrightness function for the configurable range and notes. Move the right slider to adjust volume. A larger number means a louder sound. * Only the following values are configurable in Touch Panel Classembly Devices Extended Temperature Model. 0 (Mute) 1 (output ON). 108

109 6.2 Interface Utility Interface Utility provides the following operations. Log - Monitoring log information - Configuring a log file WDT - Enabling/disabling log recording of the WDT - Checking the status of the WDT - Setting and checking the time-out time and action - Starting, stopping, and clearing the WDT Temperature - Enabling/disabling log recording of temperature - Setting the saving cycle of temperature log information - Monitoring temperature information - Setting and checking the upper-limit/lower-limit values Power - Enabling/disabling log recording of voltage - Setting the saving cycle of voltage log information - Monitoring voltage information RasOut - Checking the RAS output status - Setting and checking the RAS output conditions - Controlling RAS output on/off DIO - Monitoring digital input pin - Controlling digital output pin - Setting and checking digital input/output and key matrix input Illuminance - Monitoring illuminance - Configuring automatic adjustment of brightness Battery - Displaying battery status - Displaying an interval time to shutdown/forced power off - Configuring an interval time to shutdown/forced power off - Outputting information about starting and closing the utility, and changing settings of the utility in the event log Information - Displaying version information of the utility and the address of our web site Note: This utility program is applicable only for the OS installed devices. 109

110 6.2.1 Starting the Utility This utility automatically starts when the operating system starts. To see if the utility is running, check the system tray. The following icon appears when the utility is running. In case the utility is closed, run IFUtil.exe in the <installation destination> interface IFCPMGR bin folder Commands Right click Interface Utility icon in the system tray to open the command menu. Command Open Exit Description This command opens Interface Utility to control functions. This command closes Interface Utility. After clicking this command, the icon in the system tray disappears and the utility exits. 110

111 6.2.3 Functions The pictures displayed on your screen may be different from the pictures below depending on the model you use Log Click the Log tab to open the following dialog box. 111

112 Item Monitor Description By clicking the Monitor button, the following Log Monitor window appears. You can run processes even when the Log Monitor window is open. New records are appended at the bottom of the text box. Item Log File Clear Close Description The path of a log file appears in the Log File box. No path appears when log recording is disabled. Click Clear to delete the records in the text box. The records in the log file on the disk will not be deleted. Click Close to close the Log Monitor window. 112

113 Item File(*) No save No log limit Description The File area specifies a log file to be saved. Click OK or Apply to save the changes. The logs can be displayed on the Log Monitor window without saving the log file. No log file is saved. Log records are appended in the existing log file. Click [ ] to open the Save As dialog box. Select or enter a file name in the dialog box. The path of the log file appears in the File name box. Click the OK or Apply button to start to save log records in the log file. 113

114 Item New file every day Description A new log file is created daily. The file name includes the date of creation. For example, the utility creates a log file whose file name is log on August 12, The file name of the log file appears that is currently used in the Log Monitor window. Click [ ] to specify a folder where the log files are saved. The path of the folder appears in the Folder box. OK Cancel Apply Help Click OK or Apply to start to save log records in the log file. Click OK to save the changes and close the window. Click Cancel to discard the changes and close the window. Click Apply to save the changes. The window will not be closed. Click Help to open the Help file of System Monitoring Library. * Administrator privilege is required to save the settings. When a write-filter is enabled on storage, commit is needed to reflect the changes. When a write-protection is enabled on storage, disable the write-protection before change of settings is made. 114

115 WDT Click the WDT tab to open the following dialog box. Item Description Enable WDT log * Select the Enable WDT log check box to enable to output log records of the WDT. The log information includes; - start/stop of the WDT, - change of time-out time and action, - WDT interrupt generation. Click OK or Apply to save the changes. Note: If the settings are often changed and/or WDT is successively started/stopped in a short interval, not all the log may be output. Status This item shows the operating status of the WDT. -STOP: WDT stops. - RUN: WDT is running. Config This item configures the time-out time and action at the time-out of the WDT. Click OK or Apply to save the changes. Cycle This item configures period of WDT. The configurable range is from 1 through 255. Action This item configures the action when the time-out occurs. - Reset: Reset the CPU - Interrupt: An interrupt occurs Control The Control area includes the following commands to control the WDT. Start Click Start to start the WDT. Stop Click Stop to stop the WDT. Clear Click Clear to clear the WDT. OK Click OK to save the changes and close the window. Cancel Click Cancel to discard the changes and close the window. Apply Click Apply to save the changes. The window will not be closed. Help Click Help to open the Help file of System Monitoring Library. 115

116 * Administrator privileges are required to save the settings. When a write-filter is enabled on storage, commit is needed to reflect the changes. When a write-protection is enabled on storage, disable the write-protection before change of settings is made. When WDT interrupt is generated, a message appears on the icon in the system tray. If log output is enabled, the information is output in the log. 116

117 Temperature Click the Temperature tab to open the following dialog box. Item Enable temperature log* Temperature log cycle* CPU UpperLimit(*) LowerLimit(*) History graph Description Select the Enable temperature log check box to enable to output log records of temperature. The log information includes; - change of upper-limit/lower-limit values, - abnormal temperature/recovery, - temperature data (only when the Temperature log cycle is enabled). Click OK or Apply to save the changes. Note: * If the settings are often changed or abnormal temperature / recovery successively occurs in a short interval, not all the log may be output. Select Temperature log cycle to output temperature data at the specified rate. The rate is configurable from 1 second to 3600 seconds by second. The temperature data log will not be output when the check box is cleared. Click OK or Apply to save the changes. The CPU area contains information of the CPU temperature. Click OK or Apply to save the changes. For Sho-ene Classembly Devices(R) Extended Temperature models, temperatures of two cores are shown. The left is CPU core 1 and the other is CPU core 2. Enter the upper limit temperature in Upper Limit. Enter the lower limit temperature in Lower Limit. The graph shows a trend of CPU temperature. Colors of the line indicate the temperature ranges. Higher than the upper-limit temperature: red High temperature: orange Medium temperature: yellow-green Low temperature: light blue Lower than the lower-limit temperature: white 117

118 Item Current temperature Board UpperLimit(*) LowerLimit(*) History graph Current temperature OK Cancel Apply Help Description The present CPU temperature is shown under the graph. The color changes depending on the current temperature. Higher than the upper-limit temperature: red High temperature: orange Medium temperature: green Lowe temperature: blue Lower than lower limit temperature: black The Board area contains information of the PCB temperature. Click OK or Apply to save the changes Enter the upper-limit temperature in Upper Limit. Enter the lower-limit temperature in Lower Limit. The graph shows a trend of the PCB temperature. Colors of the line indicate the temperature ranges. Higher than the upper-limit temperature: red High temperature: orange Medium temperature: yellow-green Lowe temperature: light blue Lower than the lower-limit temperature: white The current PCB temperature is shown under the graph. The color changes depending on the current temperature. Higher than the upper-limit temperature: red High temperature: orange Medium temperature: green Lowe temperature: blue Lower than lower-limit temperature: black Click OK to save the changes and close the window. Click Cancel to discard the changes and close the window. Click Apply to save the changes. The window will not be closed. Click Help to open the Help file of System Monitoring Library. * Administrator privileges are required to save the settings. When a write-filter is enabled on storage, commit is needed to reflect the changes. When a write-protection is enabled on storage, disable the write-protection before change of settings is made. When abnormal temperature is detected, the following message appears on the icon in the system tray. Example: The PCB temperature is over the upper limit temperature. When the temperature changed from abnormal to normal temperature range, the following message appears on the icon in the system tray. Example: The PCB temperature recovers to the normal temperature range. If log output is enabled, the information is output in the log. 118

119 ! Caution This utility program does not support settings for temperature hysteresis in the Classembly Devices(R) with BayTrail processor. To configure the hysteresis upper and lower limit temperatures, use the CmSetTempLimitEx function. 119

120 Power Click the Power tab to open the following dialog box. Item Description Enable power log* Select the Enable power log check box to enable to output log records of voltage. The log information includes; - abnormal voltage/recovery - voltage data (only when the Power log cycle check box is selected). Click OK or Apply to save the changes. Note: * If the settings are often changed or abnormal voltage/ recovery successively occurs in a short interval, not all the log may be output. Power log cycle* Select the Power log cycle check box to output voltage data at the specified rate. The rate is configurable from 1 second to 3600 seconds by second. The voltage data log will not be output when the check box is cleared. Click OK or Apply to save the changes. External The External area contains information of the external power supply. History graph The graph shows a trend of external power supply. The yellow dotted line indicates the upper and lower limit voltages. The color of the graph line changes depending on the status of the external power supply. Normal: green Abnormal: red Current voltage The current voltage of external power supply is shown on the right side of the graph. Colors of the value indicate the status of external power supply. Normal: green Abnormal: red OK Click OK to save the changes and close the window. Cancel Click Cancel to discard the changes and close the window. Apply Click Apply to save the changes The window will not be closed. Help Click Help to open the Help file of System Monitoring Library. * Administrator privileges are required to save the settings. When a write-filter is enabled on storage, commit is needed to reflect the changes. When a write-protection is enabled on storage, disable the write-protection before change of settings is made. 120

121 When abnormal voltage is detected, the following message appears from the icon in the system tray. Example: detection of abnormal external voltages When the voltage changed from abnormal to normal voltage range, the following message appears from the icon in the system tray. Example: detection of recovery of the external power supply If log output is enabled, the messages above are output in the log.! Caution This utility does not support settings for monitoring voltages in the Classembly Devices(R) with BayTrail processor. To configure monitoring voltages, use the CmSetPowerLimit function. After the setting is made by the function, restart the utility program to reflect settings of the monitoring voltages. 121

122 RasOut Click the RasOut tab to open the following dialog box. This function is available only on the hardware that supports RAS output function. Refer to the manual for supported functions. 122

123 Item Status Config(*) Description The Status area contains the status of RAS output. OFF means the RAS output is off, and ON means the RAS output is on. Configure conditions of automatic RAS output when an error is detected. Click the OK or Apply button to save the changes. Select ON or OFF to set RAS output status at error detection, and select check boxes below to select conditions. When the selected conditions are detected, RAS output turns on or off according to the setting. If you select the check box of when WDT cycle is completed, the utility program asserts RAS output when the WDT is timed out. If you select the check box of when CPU temperature is over the upper limit, the utility program asserts RAS output when the CPU temperature goes over the upper limit set by using the CmSetTempLimit function or the Temperature tab. If you select the check box of when CPU temperature is under the lower limit, the utility program asserts RAS output when the CPU temperature goes below the lower limit set by using the CmSetTempLimit function or the Temperature tab. If you select the check box of when board temperature is over the upper limit, the utility program asserts RAS output when the PCB temperature goes over the upper limit set by using the CmSetTempLimit function or the Temperature tab. If you select the check box of when board temperature is under the lower limit, the utility program asserts RAS output when the PCB temperature goes below the lower limit set by using the CmSetTempLimit function or the Temperature tab. If you select the check box of when power supply voltage is abnormal, the utility program asserts RAS output when the external power supply voltage is abnormal. Control The Control area contains the ON and OFF buttons to control the RAS output. ON The button turns on the RAS output. OFF The button turns off the RAS output. OK Click OK to save the changes and close the window. Cancel Click Cancel to discard the changes and close the window. Apply Click Apply to save the changes The window will not be closed. Help Click Help to open the Help file of System Monitoring Library. * Administrator privileges are required to save the settings. When a write-filter is enabled on storage, commit is needed to reflect the changes. When a write-protection is enabled on storage, disable the write-protection before change of settings is made.! Caution The settings of CM_RO_OFF_ON and CM_RO_ON_OFF in the CmSetROConfig function are not supported on the Classembly Devices(R) with BayTrail processor. 123

124 DIO Click the DIO tab to open the following dialog box. This function is available only on the hardware that supports digital input/output function. Refer to the manual for supported functions. ON OFF at the top of the dialog box is an explanatory note and the colors indicate the statuses when a digital input pin is on and off. Item Description Digital Input The Digital Input area indicates the status of digital input pins. The number in each square is a pin number of DIN or MIN. Refer to CmInputUP Mode(*) Digital input/output and key matrix input are switched here. This option is supported only on Sho-ene Classembly Devices Extended Temperature model. Select one mode from the four, and click the OK or Apply button. General-purpose: digital input/output Matrix (4 4): key matrix input (4 input 4 output) Matrix (4 3): key matrix input (4 input 3 output) Matrix (4 2): key matrix input (4 input 2 output) The available pins are displayed in the dialog box according to the mode. Digital Output The number in each square is a pin number of DOUT. Status of ON and OFF are switched by clicking the square. Configure on/off status of each pin and click the Output button to output data that the squares indicate. (The square does not indicate the current status of digital output.) Output Click the Output button to output data that the squares indicate. OK Click OK to save the changes and close the window. Cancel Click Cancel to discard the changes and close the window. Apply Click Apply to save the changes The window will not be closed. Help Click Help to open the Help file of System Monitoring Library. * Administrator privileges are required to save the settings. When a write-filter is enabled on storage, commit is needed to reflect the changes. When a write-protection is enabled on storage, disable the write-protection before change of settings is made. 124

125 Illuminance Click the Illuminance tab to open the following dialog box. This function is available only on the hardware that supports illuminance retrieval function. Refer to the manual for supported functions. Item Illuminance Auto brightness adjustment When the illuminance is higher than illuminance x [lx], the maximum brightness is set to brightness x When the illuminance is lower than illuminance y [lx], the minimum brightness is set to brightness y The brightness between maximum and minimum values is automatically set in proportion to the illuminance. OK Cancel Apply Help Description The Illuminance area shows the current illuminance. The unit is lx (lux). Select the check box to enable auto-brightness adjustment. When the illuminance is higher than illuminance x [lx], the maximum brightness is automatically set to brightness x. When the illuminance is lower than illuminance y [lx], the minimum brightness is automatically set to brightness y. When the illuminance is between illuminance x and illuminance y, the brightness is set in proportion to the range between brightness x and brightness y. Click OK to save the changes and close the window. Click Cancel to discard the changes and close the window. Click Apply to save the changes The window will not be closed. Click Help to open the Help file of System Monitoring Library. * As long as the auto-brightness adjustment function is enabled, brightness changed by the other application program is adjusted by auto-adjustment. * Administrator privileges are required to save the settings. * When a write-filter is enabled on storage, commit is needed to reflect the changes. When a write-protection is enabled on storage, disable the write-protection before change of settings is made. 125

126 Battery Click the Battery tab to open the following dialog box. Item Enable Battery log* Forced charge* Description Select the Enable battery log check box to enable to output log records of battery. The log information includes; - switch over from a power supply to a battery, - battery capacity decline, - disconnection from a battery, and - change of interval time to shutdown or power off. Click the OK or Apply button to save changes. * If the battery status often changes in a short interval, not all the logs may be output. Select the check box to enable forced charge. The forced charge will be performed even if the remaining battery level is around 0 V (empty) when the forced charge is enabled. If the check box is cleared, the forced charge is disabled and the battery will not be charged if the remaining battery level is around 0 V (empty). - This function is applicable only to the JPS-BUSTC, JPS-BUETCA, and JPS-BUETC2. - Clear the check box to operate the system that is disconnected from a battery. - Depending on the time of production, this check box may not be displayed. Contact our Customer Support Center with the serial number to use this function. 126

127 Item Status Link Battery Description This item displays the battery status. This item indicates connection status of the battery module. : Connected : Disconnected This item indicates the remaining battery level and battery charging status. <Battery level> : 100 % to 80 % : 79 % to 30 % : 29 % to 1 % : 0 % Battery level of JPS-BUSTC/JPS-BUETCA/JPS-BUETC2 : 100 % to 80 % : 79 % to 30 % : 29 % to 0 % Life Low battery Battery error Power on count(*) Discharge count(*) <Charging status> Charging Discharging This item indicates if a lifetime alarm is detected or not. : Normal : A lifetime alarm is generated. * Replace the battery module if a lifetime alarm is generated. This item detects the decline of the remaining battery level. : Normal : The battery level is equal to or less than 30 %. This item indicates if the battery error is detected or not. : Normal : A battery error is detected. Contact our Customer Support Center if battery error is detected. This item indicates the number of start of system. This item indicates the number of discharges. 127

128 Item Simulation Description This item configures the simulation function of battery. Select the check box to configure simulation status. Charging Discharging Battery Life Low battery Battery error * The simulation function simulates only the status. For example, even if discharging is selected here, shutdown/forced power off do not occur after the time set at Time remaining. This item simulates charging information. When the check box is cleared not selected: not charging When the check box is cleared: charging This item simulates discharging information. When the check box is not selected: not discharging When the check box is selected: discharging This item simulates remaining battery level. Click the square ( ) to change the settings. : 100 % to 80 % : 79 % to 30 % : 29 % to 1 % : 0 % Battery level of JPS-BUSTC/JPS-BUETCA/JPS-BUETC2 : 100 % to 80 % : 79 % to 30 % : 29 % to 0 % This item simulates a lifetime alarm. Click the circle ( ) to change the settings. : Normal : A lifetime alarm is generated. This item simulates the decline of remaining battery level. Click the circle ( ) to change the settings. : Normal : The remaining battery level is equal to or less than 20 %. This item simulates the battery error. Click the circle ( ) to change the settings. : Normal : A battery error is detected. 128

129 Item Time remaining Shutdown* PowerOff* OK Cancel Apply Help Description This item configures an interval time between occurrence of power failure and start of shutdown/forced power off. Click the OK or Apply button to save changes. This item configures an interval time between occurrence of power failure and start of shutdown. The configurable range is from 0 through 255 seconds in every 1 second. If 0 is specified, the system will not be shut down nor forcibly powered off. This item configures an interval time between start of shutdown and forced power off. The configurable range is from 0 through 255 seconds in every 1 second. If 0 is specified, the system will not be forcibly powered off. If a system is not successfully shut down, the system is forcibly powered off after the time elapses. The time should be longer than a time required for shutdown process. This button saves the changes and closes the dialog box. This button closes the dialog box without saving the changes. This button saves the changes and the dialog box is kept open. Click Help to open the Help file of System Monitoring Library. * Administrator privileges are required to save the settings except the number of start of system and discharge). When a write-filter is enabled on storage, commit is needed to reflect the changes. When a write-protection is enabled on storage, disable the write-protection before change of settings is made. When a power supply is switched to the battery due to power failure detection, the battery level decreased, or the connection with the battery module is disconnected, the icon in the system tray shows the following messages. Example The power supply is switched to battery due to power failure detection. 129

130 RAID Click the RAID tab in the Interface Utility dialog box. Item Enable Disk log* RAID Message* Level Status Capacity RAID volume failed RAID volume restore Settings Description Select the Enable Disk log check box to output log records of SATA devices and RAID. The log information includes; - when a SATA device (HDD/SSD) is attached, - when a SATA device (HDD/SSD) is removed, - when a disk error occurs, - when rebuilding RAID1 is completed, - when rebuilding RAID1 starts, and - when the RAID1 is damaged (for example, the RAID configuration is broken due to an error on a disk). Click the OK or Apply button to save changes. This item indicates the RAID level. It shows either RAID0 or RAID1. This item indicates the RAID status. Normal: Normal operation Broken: The RAID configuration is broken and the RAID volume is not available. Degrade: An error occurs in RAID1 and the system is not protected by mirroring. Replace the disk on which the error occurred to rebuild the RAID configuration. Rebuilding: RAID1 is being rebuilt [progress %] This item indicates the capacity of the RAID volume. Select the check box to send messages when the RAID volume is broken. Select the check box to send messages when the recovery of RAID volume is completed. Click the button to set the destination 130

131 Item Disk Help ModelName SerialNumber Capacity PortType Description This item indicates the storage device name. This item indicates the serial number of the storage device. This item indicates the capacity of the storage device. This item indicates the status of the storage device. RAID Disk: The device belongs to the RAID member. Hard Disk: The device does not belong to the RAID member No Device: No device is connected. Click Help to open the Help file of System Monitoring Library. * Administrator privileges are required to save the settings. When a write-filter is enabled on storage, commit is needed to reflect the changes. When a write-protection is enabled on storage, disable the write-protection before change of settings is made. 131

132 Settings By Clicking the Settings button, the following dialog box appears. Mail Item From User Setting SMTP server Mail address Test mail SMTP-AUTH Name Password Name Port List To Add Delete Description Type a sender s address. Select the check box to use SMTP-AUTH. Clear the check box if you do not use SMTP-AUTH. Type a user name. Type a password. Type a mail server name. Type a mail submission port. Registered addresses are listed here. Type an address to be registered. Click this button to register the address typed in the To text box. Select an address in the list. Click this button to delete it. Click the Send button to send a test message to the registered addresses Network message Item Description Port Type a port number. Transmission and reception of messages are performed on the same port. Send server List Registered host/ip addresses are listed here. To Type a name or IP address of a computer to be registered. Add Click this button to register the computer typed in the To text box. Delete Select a computer in the list. Click this button to delete it. Test message Click the Send button to send a UDP message to the registered computers. 132

133 Message Item Description Failed Type a message to be sent when RAID volume is failed. Restore Type a message to be sent when RAID volume is restored. The messages are sent in the UTF-8 format. If corrupted messages are received, check your character code settings. 133

134 Information Click the Information tab in the Interface Utility dialog box. Item Function Version Copy Description Function names of Interface Utility Version of each function. Click this button to copy the information to the clipboard. 134