System Monitoring Library Windows Driver Software for Industrial Controllers

Transcription

1 IFPMGR.WIN System Monitoring Library Windows Driver Software for Industrial ontrollers Help for Windows

2 ontents hapter 1 Introduction Overview Features... 4 hapter 2 Product Specifications Functional Specifications Product omposition... 6 hapter 3 Programming Guide Installation lass Library Using DLL Functions for Atom and ore i7 Models Using the ompatible DLL Functions for Pentium M and eleron M Models Programming Guide for DLL Functions for Atom and ore i7 Models WDT Temperature Monitoring Power Supply Voltage Monitoring Slot-in Power Supply Module Monitoring Battery Monitoring Interrupt Event Handling Programming Guide for ompatible DLL Functions for Pentium M/eleron M Model hapter 4 Reference for Atom/ore i7 Model List of DLL Function msetwdtonfig mgetwdtonfig mstartwdt mstopwdt mlearwdt mgettemp msettemplimit mgettemplimit mgetpower msetevent mkillevent mseteventmask mgeteventmask mgeteventfactor mgetspecifiedstatus msetpowerbuttonfilter mgetpowerbuttonfilter msetledonfig mgetledonfig mgetunitfanstatus mgetpsmid mgetpsmstatus mgetbatinfo mgetbathistory mgetbatstatus mgetbatdiagstatus msetbatosoffonfig mgetbatosoffonfig msetbatofftime mgetbatofftime allback Functions Structure M_EVENT_REQ M_BAT_INFO M_BAT_HISTORY Return Values hapter 5 Reference for Pentium M/eleron M Model List of DLL Function IfpuSetpulock IfpuGetpulock IfpuSetpulkDuty IfpuGetpulkDuty IfRasGetpuTmp IfRasGetVolt IfRasGetVolt IfRasGetVolt IfRasWdtEnable IfRasWdtlear

3 IfRasWdtDisable IfhipGetounterIH IfPsmGetModuleId IfPsmGetStatus hapter 6 Sample Programs Execution Procedure List of Sample Programs hapter 7 Utility Program Interface Utility Starting the Utility ommands Functions hapter 8 Terms of Use Limited Warranty opyrights and Intellectual Property Rights Warning Regarding Medical and linical Use of Our Products Prohibition of Reproduction Limitation of Liability Trademark

4 hapter 1 Introduction 1.1 Overview System monitoring library monitors Interface Slot-in Industrial ontroller and Long-Term Supply Industrial ontroller 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 PU reset or an interrupt event can be generated. - Temperatures of the PU, printed circuit board (PB), and memory chip can be retrieved. - An interrupt event is generated when the temperature of PU or PB 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. - Statuses of the fans attached to PU can be monitored. An interrupt event is generated when an error on the fans is detected. - The power button can be applied with a filter of duration of one second to protect from erroneous operations. - The power LED blinks when the system has an error. - Statuses of the fans mounted on the chassis can be monitored. - Insertion statuses of slot-in power supply modules and statuses of alarm and fail signals can be retrieved. - An interrupt event is generated when an error is detected on the slot-in power supply module. - Status and information of the battery can be retrieved. - The operating system is automatically shut down after the battery module detects power failure. The delay time from the detection of power failure to shutdown of operating system can be configured. - To protect the battery module from over-discharge, the time from the detection of power failure to forced turn-off of battery discharge can be configured. - 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, PU fan monitoring, power supply switch filter, error LED settings, slot-in power supply module monitoring, and battery information retrieval are included. - Ready-to-use utilities for WDT control, temperature monitoring, power voltage monitoring, fan monitoring, power button filter, and error LED settings, slot-in power supply module monitoring, and battery module monitoring are included. The utilities save logs for purposes of failure analysis and prediction. - The product provides some APIs that controls the PUs and RAS functions of the existing Slot-in Industrial ontrollers, Long-Term Supply Industrial ontrollers (Pentium M/eleron M models). The APIs help you easily migrate your existing system monitoring program to a new system. 4

5 hapter 2 Product Specifications 2.1 Functional Specifications Long-Term Supply Industrial ontroller Atom Atom ore i7/eleron N2800 (N2800 PI bus PI/PI excluded) Express Hybrid Slot-in Industrial ontroller Atom (N2800 excluded) Atom N2800 ore i7/ eleron WDT (watchdog timer) Temperature PU monitoring PB Power supply voltage monitoring Around memory chip Vdc Vdc Vdc Interrupt event 5 Vdc standby WDT time-out PU temperature is over the upper limit. PU temperature is under the lower limit. PB temperature is over the upper limit. PB temperature is under the lower limit. 5 Vdc power supply is abnormal. 3.3 Vdc power supply is abnormal. 12 Vdc power supply is abnormal. Slot-in power supply module alarm/abnormal - - PU fan error - - *1 *1 - - *1 PU fan monitoring - - *1 *1 - - *1 hassis fan monitoring *3 - *3 * Slot-in power supply module - - monitoring Battery module monitoring - - Power button filter Error LED indication : Supported -: Not supported Note: *1 These functions are supported only on ore i7/eleron (1st) models with a PU fan. heck the hardware manual if your controller has a PU fan or not. *2 This function monitors the following types of fan. - Exhaust fan in 7-slot unit (short-size/full-size) - Exhaust fan 1 and exhaust fan 2 in 9-slot/13-slot unit (short-size/full-size) - Fan in 4-slot unit (short-size) *3 This function monitors the following types of fan. - Exhaust fan 1 and exhaust fan2 in 9-slot unit (short-size/full-size) - Exhaust fan in 7-slot unit (short-size/full-size) 5

6 2.2 Product omposition Item File Name Latest information README.HTM Latest information Installer SETUP.EXE Installation program Sample programs wdt Watchdog timer temperature Temperature monitoring power Power supply voltage monitoring event WDT interrupt event notification pbfilter Power button filter led Error LED settings fan Fan status retrieval psm Slot-in power supply module monitoring bat IFPMGR Battery information retrieval lass library source for and Visual Basic.NET. Utilities IFUtil.EXE Interface Utility Service SMAN.EXE Interface System Manager DLL IFPMGR.DLL Dynamic link library file IFPMGR.LIB Import library file IFWINRP.DLL Dynamic link library file IFWINRP.LIB Import library file Device drivers IFPMGR.SYS Driver for Windows Header files IFPMGR.H Header file for Visual ++ IFPMGR.BAS Header file for IFWINRP.H Header file for Visual ++ IFWINRP.BAS Header file for Help HELP.PDF Help (PDF file) Note: * Sample programs for and.net are built with 2003 and.net 2003, respectively. 6

7 hapter 3 Programming Guide 3.1 Installation Refer to README.HTM for installation. 3.2 lass Library This product includes the source files of the class library. reating 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.) Using DLL Functions for Atom and ore i7 Models 1. reating a lass Library Prepare class library first to call DLL functions on.net. 1. Start Visual Studio. 2. Open the following project file. <installation destination> \interface\ifpmgr\samples\s_net\ifpmgr\ifpmgr.csproj After building the project file, IFPMGR.DLL is created in the bin folder..net 1. Start Visual Studio. 2. Open the following project file. <installation destination> \interface\ifpmgr\samples\vb_net\ifpmgr\ifpmgr.vbproj After building the project file, IFPMGR.DLL is created in the bin folder. 2. Adding lass Library Reference and.net 1. Start Visual Studio. 2. Select Project > Add Reference. 3. lick the Browse button. 4. Specify the class library DLL to refer. <installation destination> \interface\ifpmgr\samples\s_net\ifpmgr\bin\release\ifccpmgr.dll <installation destination> \interface\ifpmgr\samples\vb_net\ifpmgr\bin\relaase\ifccpmgr.dll 5. The DLL file will be displayed in Selected omponents. 6. lick OK. 7. Add the namespace of InterfaceorpDllWrap as below at the header of your source file to call the DLL functions. using InterfaceorpDllWrap;.NET Imports InterfaceorpDllWrap 7

8 3.2.2 Using the ompatible DLL Functions for Pentium M and eleron M Models 1. reating a lass Library Prepare class library first to call DLL functions on.net. 1. Start Visual Studio. 2. Open the following project file. <installation destination> \interface\ifpmgr\samples\s_net\ifwinrp\ifwinrp.csproj After building the project file, IFWINRP.DLL is created in the bin folder..net 1. Start Visual Studio. 2. Open the following project file. <installation destination> \interface\ifpmgr\samples\vb_net\ifwinrp\ifwinrp.vbproj After building the project file, IFWINRP.DLL is created in the bin folder. 2. Adding lass Library Reference and.net 1. Start Visual Studio. 2. Select Project > Add Reference. 3. lick the Browse button. 4. Specify the class library DLL to refer. <installation destination> \interface\ifpmgr\samples\s_net\ifwinrp\bin\release\ifcwincrp.dll <installation destination> \interface\ifpmgr\ samples\vb_net\ifwinrp\bin\relaase\ifcwincrp.dll 5. The DLL file will be displayed in Selected omponents. 6. lick OK. 7. Add the namespace of InterfaceorpDllWrap as below at the header of your source file to call the DLL functions. using InterfaceorpDllWrap;.NET Imports InterfaceorpDllWrap 3.3 Programming Guide for DLL Functions for Atom and ore i7 Models, ++, or Function declaration is required to use DLL functions in, ++, or. The definition file for each language is stored in the include folder. For and ++, include the IFPMGR.H file in the source program. For, add the IFPMGR.BAS file in the project. For and ++, link the IFPMGR.lib file in the lib folder..net, Visual # Add the class library reference. Refer to Using DLL Functions for Atom and ore i7 Models for details. This section explains basic control instructions. The examples are written in. 8

9 3.3.1 WDT Follow the instructions below to use the WDT. 1. onfigure a time-out time of the WDT and an action at the time-out error (PU reset or interrupt event notification). 2. Start the WDT. 3. lear the WDT before it reaches the time-out time. Use the msetwdtonfig function to configure a time-out time of the WDT and an action at the time-out error. UINT Ret; // PU is reset if the value is not cleared for 50 s. Ret = msetwdtonfig(50, M_WDT_AT_RESET Use the mstartwdt function to start the WDT. Ret = mstartwdt( Use the mlearwdt function to clear the WDT. Ret = mlearwdt( Use the mstopwdt function to stop the WDT. Ret = mstopwdt( An interrupt event is generated as well as PU reset. Refer to Interrupt Event for details. The table below describes the difference between interrupt event and PU reset. WDT Processes Applications Interrupt event The purpose of using interrupt event is to detect that a user program stops due to failure of the user program. reate 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 can not 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 PU reset The purpose of using PU reset is to automatically recover the system from a fatal error like freeze Temperature Monitoring The mgettemp function retrieves a temperature of the PU or PB. For ore i7/eleron models, the function retrieves a temperature around memory chips in addition. UINT Ret; int putemp; int BrdTemp; // PU temperature is retrieved Ret = mgettemp(m_temp_target_pu, &putemp // Board temperature is retrieved Ret = mgettemp(m_temp_target_brd, &BrdTemp The retrieved temperatures may be negative. The unit is degree elsius. By configuring the upper and lower limits of temperature, the function generates an interrupt event when the temperature becomes out of the range. Refer to Interrupt Event for details. The Atom N2800 and Atom D525 models generate an interrupt event when a temperature of PU1 or PU2 exceeds the PU temperature limit. 9

10 3.3.3 Power Supply Voltage Monitoring The mgetpower function retrieves a voltage of the 5 Vdc, 3.3 Vdc, or 12 Vdc power supply. For Atom N2800 model, a voltage of 5 Vdc standby power supply can also be retrieved. UINT Ret; float Power; // 5 Vdc Power supply voltage is retrieved Ret = mgetpower(m_power_target_5v, &Power The function generates an interrupt event when the power supply voltage is abnormal. Refer to Interrupt Event for details Slot-in Power Supply Module Monitoring * Read this section when you use a slot-in power supply module. * The slot positions for the slot-in power supply modules are defined as P1, P2 from the left The mgetpsmid function retrieves IDs of slot-in power supply modules. UINT Ret; UINT ModuleId[4]; // ID is retrieved Ret = mgetpsmid(&moduleid[0], 4 The mgetpsmstatus function retrieves statuses of slot-in power supply modules. UINT Ret; UINT Status[4]; // Power supply status is confirmed Ret = mgetpsmstatus(&status[0], 4 An interrupt event can be generated when an alarm/abnormal status of a slot-in power supply module is detected. Refer to Interrupt Event for details Battery Monitoring * Read this section when you use a battery module. The mgetbatstatus function retrieves a status of the battery module. UINT Ret; UINT Status; Ret = mgetbatstatus(&status When a self-diagnostic error of the battery module is detected, use the mgetbatdiagstatus function to check the details of the error. UINT Ret; UINT DiagStatus; Ret = mgetbatdiagstatus(&diagstatus Self-diagnostic errors can be caused by the battery life including increase of internal resistance, unbalance, or decrease of capacity. Replace the battery module when a self-diagnostic error occurs. 10

11 The msetbatosoffonfig function configures an interval time from occurrence of power failure to shutdown or hibernation of the system. UINT Ret; // Shutdown of the operating system is requested in 60 seconds after a // power failure Ret = msetbatosoffonfig(60, 0 Note: If the operating system disables hibernation, the operating system will be shut down when the hibernation is requested. The msetbatofftime function configures an interval time from when a power failure occurs to when the battery is forcibly turned off to protect the battery from over-discharge. UINT Ret; // Battery discharge is forcibly turned off in 180 seconds after an occurrence // of power failure Ret = msetbatofftime(180 Note: Measurement of an interval time to turning off the battery module starts when a power failure occurs The start timing is NOT when the time shutting down (hibernating) the system configured by the msetbatosoffonfig function elapsed After a power failure occurs, system configuration information or files may be corrupted if discharge of the battery module stops before post-processings of programs are successfully completed or the system is properly shut down. 11

12 3.3.6 Interrupt Event Handling Follow the instructions below to use interrupt events. 1. onfigure conditions of each interrupt event (WDT time-out error, and upper-limit/lower-limit temperatures). 2. Register handling methods of the interrupt events including signal event, message, and callback function by the msetevent function. 3. onfigure an interrupt event mask by the mseteventmask 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, PU temperature upper/lower limit, and power supply voltage error) // allback function void ALLBAK Userallback(PVOID User) { UINT Ret; UINT Factor; // Event source is retrieved Ret = mgeteventfactor(&factor // Processing each event } int main(void) { UINT Ret; M_EVENT_REQ EventReq; // 0 degrees for lower limit and 50 degrees for upper limit of PU temperature //are configured Ret = msettemplimit(m_temp_target_pu, 0, 50 // Event registration ZeroMemory(&EventReq, sizeof(m_event_req) EventReq.allBackProc = (LPMALLBAK)Userallback; Ret = msetevent(&eventreq // Event mask configuration (WDT, Upper/lower limit of PU temperature, // power supply voltage) Mask = M_EVENT_WDS M_EVENT_PTHS M_EVENT_PTLS M_EVENT_V27VA; Ret = mseteventmask(&mask, 1 } 12

13 After the events are used, mask the events by the SetEventMask function, clear the event sources by the mgeteventfactor function, and then release the interrupt events by the mkillevent function. UINT Ret; UINT Factor; UINT Mask = 0; // All interrupts are disabled Ret = mseteventmask(&mask, 1 // Event source is cleared Ret = mgeteventfactor(&factor, 1 // Interrupts are released Ret = mkillevent( Refer to hapter 6 Sample Programs to use functions other than the callback function. 3.4 Programming Guide for ompatible DLL Functions for Pentium M/eleron M Model, ++, or Function declaration is required to use DLL functions in, ++, or. The definition file for each language is stored in the include folder. For and ++, include the IFWINRP.H file in the source program. For, add the IFWINRP.BAS file in the project. For and ++, link the IFWINRP.lib file in the lib folder..net, Visual # Add the class library reference. Refer to Using the ompatible DLL Functions for Pentium M and eleron M Models for details.! aution The compatible DLL functions for Pentium M/eleron M model are compatible in the point of their function names and arguments. However, the parameters or behavior may be different. Refer to hapter 5 Reference for Pentium M/eleron M Model. 13

14 hapter 4 Reference for Atom/ore i7 Model 4.1 List of DLL Function No. Function <WDT> 1 msetwdtonfig onfigures a time-out time and an action at the time-out error. 2 mgetwdtonfig Retrieves a time-out time and an action at the time-out error. 3 mstartwdt Starts the WDT. 4 mstopwdt Stops the WDT. 5 mlearwdt lears the WDT. <Temperature monitoring> 6 mgettemp Retrieves the current temperature of a specified target. 7 msettemplimit onfigures upper and lower limits of monitoring temperature of a specified target. 8 mgettemplimit Retrieves upper and lower limits of monitoring temperature of a specified target. <Power supply voltage monitoring> 9 mgetpower Retrieves a voltage of a power supply. <Interrupt event> 10 msetevent Registers interrupt events. 11 mkillevent Deletes interrupt events. 12 mseteventmask onfigures an event mask. 13 mgeteventmask Retrieves an event mask. 14 mgeteventfactor Retrieves an event source. <Status> 15 mgetspecifiedstatus Retrieves statuses of specified targets. <Power button filter> 16 msetpowerbuttonfilter Applies one second filter to the power button to protect from erroneous operations 17 mgetpowerbuttonfilter Retrieves the filter setting of the power button. <Error LED> 18 msetledonfig onfigures blinking conditions of the LED. 19 mgetledonfig Retrieves blinking conditions of the LED. <hassis fan> 20 mgetunitfanstatus Retrieves statuses of the chassis fans. <Slot-in power supply module> 21 mgetpsmid Retrieves IDs of slot-in power supply modules. 22 mgetpsmstatus Retrieves statuses of slot-in power supply modules. <Battery module> 23 mgetbatinfo Retrieves information of the battery module. 24 mgetbathistory Retrieves a history of the battery module. 25 mgetbatstatus Retrieves statuses of the battery module. 26 mgetbatdiagstatus Retrieves statuses of self diagnostic of the battery module. 27 msetbatosoffonfig onfigures a condition of termination of the operating system. 28 mgetbatosoffonfig Retrieves a condition of termination of the operating system. 29 msetbatofftime onfigures a discharge condition of the battery module 30 mgetbatofftime Retrieves a discharge condition of the battery module 14

15 4.1.1 msetwdtonfig The msetwdtonfig function configures a time-out time of the WDT and an action at the time-out error. Syntax UINT msetwdtonfig( UINT ycle, UINT Action Declare Function msetwdtonfig Lib "ifcpmgr.dll"( _ ByVal ycle As Long, _ ByVal Action As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint msetwdtonfig( uint ycle, uint Action.NET Declare Function msetwdtonfig Lib "ifcpmgr.dll"(_ ByVal ycle As Integer, _ ByVal Action As Integer _ )As Integer Parameters ycle Action The parameter configures 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. The parameter specifies an action at the time-out error. Specify a value in the following table. The default setting is M_WDT_AT_INTERRUPT. When the WDT is enabled by BIOS, the value is M_WDT_AT_RESET. ode Value M_WDT_AT_INTERRUPT 0 Generates an interrupt event at the time-out error M_WDT_AT_RESET 1 Generates a PU reset at the time-out error 15

16 Return Values ode Value IFM_ERROR_SUESS 0 Successful completion IFM_ERROR_INTERNAL h Internal error IFM_ERROR_INVALID_PARAMETER h Invalid input parameter IFM_ERROR_INVALID_HANDLE h Internal error Refer to 4.4 Return Values for details if the function returns a value other than 0. omments - 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 are effective. - The product uses the setting of the WDT by BIOS when BIOS enables the WDT. Example Setting the time-out time to 50 seconds and the action to PU reset UINT Ret; Ret = msetwdtonfig(50, M_WDT_AT_RESET Dim Ret As Long Ret = msetwdtonfig(50, M_WDT_AT_RESET) uint Ret; Ret = IFPMGR.mSetWDTonfig(50, IFPMGR.M_WDT_AT_RESET.NET Dim Ret As Integer Ret = IFPMGR.mSetWDTonfig(50, IFPMGR.M_WDT_AT_RESET) 16

17 4.1.2 mgetwdtonfig The mgetwdtonfig function retrieves a time-out time of the WDT and an action at the time-out error. Syntax UINT mgetwdtonfig( UINT* pycle, UINT* paction Declare Function mgetwdtonfig Lib "ifcpmgr.dll"( _ ByRef pycle As Long, _ ByRef paction As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint mgetwdtonfig( out uint pycle, out uint paction.net Declare Function mgetwdtonfig Lib "ifcpmgr.dll"( ByRef pycle As Integer, _ ByRef paction As Integer _ )As Integer Parameters pycle 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 msetwdtonfig function can configure. Return Values ode Value IFM_ERROR_SUESS 0 Successful completion IFM_ERROR_INTERNAL h Internal error IFM_ERROR_NULL_POINTER h NULL pointer detection IFM_ERROR_INVALID_HANDLE h Internal error Refer to 4.4 Return Values for details if the function returns a value other than 0. 17

18 Example Retrieving a time-out time of the WDT and action at the time-out error UINT Ret; UINT ycle; UINT Action; Ret = mgetwdtonfig(&ycle, &Action Dim Ret As Long Dim ycle As Long Dim Action As Long Ret = mgetwdtonfig(ycle, Action) uint Ret; uint ycle; uint Action Ret = IFPMGR.mGetWDTonfig(out ycle, out Action.NET Dim Ret As Integer Dim ycle As Integer Dim Action As Integer Ret = IFPMGR.mGetWDTonfig(ycle, Action) 18

19 4.1.3 mstartwdt The mstartwdt function starts the WDT. Syntax UINT mstartwdt(void Declare Function mstartwdt Lib "ifcpmgr.dll"() As Long [DllImport("ifcpmgr.dll")] public static extern uint mstartwdt(.net Declare Function mstartwdt Lib "ifcpmgr.dll"() As Integer Parameter None Return Values This function returns the following return values. ode Value IFM_ERROR_SUESS 0 Successful completion IFM_ERROR_INTERNAL h Internal error IFM_ERROR_ALREADY h Already in progress IFM_ERROR_INVALID_HANDLE h Internal error Refer to 4.4 Return Values for details if the function returns a value other than 0. omment When this function is called after the WDT stops, the WDT starts from the beginning. Example Starting WDT UINT Ret; Ret = mstartwdt( Dim Ret As Long Ret = mstartwdt() uint Ret; Ret = IFPMGR.mStartWDT(.NET Dim Ret As Integer Ret = IFPMGR.mStartWDT() 19

20 4.1.4 mstopwdt The mstopwdt function stops the WDT. Syntax UINT mstopwdt(void Declare Function mstopwdt Lib "ifcpmgr.dll"() As Long [DllImport("ifcpmgr.dll")] public static extern uint mstopwdt( Declare Function mstopwdt Lib "ifcpmgr.dll"() As Integer Parameter None Return Values This function returns the following return values. ode Value IFM_ERROR_SUESS 0 Successful completion IFM_ERROR_INTERNAL h Internal error IFM_ERROR_NOT_YET h Not in progress yet IFM_ERROR_INVALID_HANDLE h Internal error Refer to 4.4 Return Values for details if the function returns a value other than 0. Example Stopping WDT UINT Ret; Ret = mstopwdt( Dim Ret As Long Ret = mstopwdt() uint Ret; Ret = IFPMGR.mStopWDT(.NET Dim Ret As Integer Ret = IFPMGR.mStopWDT() 20

21 4.1.5 mlearwdt The mlearwdt function clears the WDT. The WDT restarts with the current time-out time. Syntax UINT mlearwdt(void Declare Function mlearwdt Lib "ifcpmgr.dll"() As Long [DllImport("ifcpmgr.dll")] public static extern uint mlearwdt(.net Declare Function mlearwdt Lib "ifcpmgr.dll"() As Integer Parameters None Return Values This function returns the following return values. ode Value IFM_ERROR_SUESS 0 Successful completion IFM_ERROR_INTERNAL h Internal error IFM_ERROR_NOT_YET h Not in progress yet IFM_ERROR_INVALID_HANDLE h Internal error Refer to 4.4 Return Values for details if the function returns a value other than 0. Example learing WDT UINT Ret; Ret = mlearwdt( Dim Ret As Long Ret = mlearwdt() uint Ret; Ret = IFPMGR.mlearWDT(.NET Dim Ret As Integer Ret = IFPMGR.mlearWDT() 21

22 4.1.6 mgettemp The mgettemp function retrieves a temperature of a specified target. Syntax UINT mgettemp( UINT Target, INT* ptemp Declare Function mgettemp Lib "ifcpmgr.dll"( _ ByVal Target As Long, _ ByRef ptemp As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint mgettemp( uint Target, out int ptemp )As Long.NET Declare Function mgettemp Lib "ifcpmgr.dll"(_ ByVal Target As Integer, _ ByRef ptemp As Integer _ )As Integer Parameters Target ptemp The parameter specifies a target to retrieve its temperature. Specify a value from the following table. ode Value M_TEMP_TARGET_PU 0 Retrieves a temperature of the PU. For Atom N2800, Atom D525, and ore i7/eleron models, the value shows PU1 temperature. M_TEMP_TARGET_BRD 1 Retrieves a temperature of the PB. M_TEMP_TARGET_MEM 2 Retrieves a temperature around the memory chips. M_TEMP_TARGET_PU2 3 Retrieves a temperature of the PU2. (Only for Atom N2800, Atom D525, and ore i7/eleron models) This parameter points to a variable to receive a temperature. The retrieved temperature may be negative. The unit is degree. 22

23 Return Values This function returns the following return values. ode Value IFM_ERROR_SUESS 0 Successful completion IFM_ERROR_INTERNAL h Internal error IFM_ERROR_INVALID_PARAMETER h Invalid input parameter IFM_ERROR_NULL_POINTER h NULL pointer detection IFM_ERROR_INVALID_HANDLE h Internal error IFM_ERROR_NOT_SUPPORT h Not supported Refer to 4.4 Return Values for details if the function returns a value other than 0. Example Retrieving a current temperature of PU UINT Ret; INT putemp; Ret = mgettemp(m_temp_target_pu, &putemp Dim Ret As Long Dim putemp As Long Ret = mgettemp(m_temp_target_pu, putemp) uint Ret; int putemp; Ret = IFPMGR.mGetTemp(IFPMGR.M_TEMP_TARGET_PU, out putemp.net Dim Ret As Integer Dim putemp As Integer Ret = IFPMGR.mGetTemp(IFPMGR.M_TEMP_TARGET_PU, putemp) 23

24 4.1.7 msettemplimit The msettemplimit 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 msettemplimit( UINT Target, INT LowerLimit, INT UpperLimit Declare Function msettemplimit Lib "ifcpmgr.dll"( _ ByVal Target As Long, _ ByVal LowerLimit As Long, _ ByVal UpperLimit As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint msettemplimit ( uint Target, int LowerLimit, int UpperLimit.NET Declare Function msettemplimit 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. ode Value M_TEMP_TARGET_PU 0 onfigures a monitoring temperature of the PU. The value is applicable only to the Atom models. M_TEMP_TARGET_BRD 1 onfigures a monitoring temperature of the PB LowerLimit The parameter specifies a lower limit of the monitoring temperature: -60 LowerLimit < UpperLimit The default value for the PU and PB is -60 (degrees ). UpperLimit The parameter specifies an upper limit of the monitoring temperature: LowerLimit < UpperLimit 125 The default value for the PU and PB is 125 (degrees ). 24

25 Return Values This function returns the following return values. ode Value IFM_ERROR_SUESS 0 Successful completion IFM_ERROR_INTERNAL h Internal error IFM_ERROR_INVALID_PARAMETER h Invalid input parameter IFM_ERROR_INVALID_HANDLE h Internal error IFM_ERROR_NOT_SUPPORT h Not supported Refer to 4.4 Return Values for details if the function returns a value other than 0. omment - When this function is called in a different process, the latest settings are effective. - For the Atom N2800 and Atom D525 models, an error detected when a temperature of either PU1 or PU2 becomes out of the range. (In other words, no error is detected when the temperatures of both PU1 and PU2 are within the range)! aution The values that can be specified here are values that this software can monitor. The specified values are not guaranteed temperature of the hardware. Example Setting lower and upper limit temperatures of PB to 0 degrees and 50 degrees, respectively UINT Ret; Ret = msettemplimit(m_temp_target_brd, 0, 50 Dim Ret As Long Ret = msettemplimit(m_temp_target_brd, 0, 50) uint Ret; Ret = IFPMGR.mSetTempLimit(IFPMGR.M_TEMP_TARGET_BRD, 0, 50) ;.NET Dim Ret As Integer Ret = IFPMGR.mSetTempLimit(IFPMGR.M_TEMP_TARGET_BRD, 0, 50) 25

26 4.1.8 mgettemplimit The mgettemplimit function retrieves upper and lower limits of monitoring temperatures of a specified target. Syntax UINT mgettemplimit( UINT Target, INT* plowerlimit, INT* pupperlimit Declare Function mgettemplimit Lib "ifcpmgr.dll"( _ ByVal Target As Long, _ ByRef plowerlimit As Long, _ ByRef pupperlimit As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint mgettemplimit ( uint Target, out int plowerlimit, out int pupperlimit.net Declare Function mgettemplimit 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. ode Value M_TEMP_TARGET_PU 0 Retrieves a monitoring temperature of the PU. M_TEMP_TARGET_BRD 1 Retrieves a monitoring temperature of the PB. plowerlimit The parameter points to variable to receive the lower limit of the monitoring temperature. Lower-limit temperature: -60 retrieved value < UpperLimit (degrees ) pupperlimit The parameter points to variable to receive the upper limit of the monitoring temperature. Upper-limit temperature: LowerLimit < retrieved value 125 (degrees ) 26

27 Return Values This function returns the following return values. ode Value IFM_ERROR_SUESS 0 Successful completion IFM_ERROR_INTERNAL h Internal error IFM_ERROR_NULL_POINTER h NULL pointer detection IFM_ERROR_INVALID_HANDLE h Internal error IFM_ERROR_NOT_SUPPORT h Not supported Refer to 4.4 Return Values for details if the function returns a value other than 0. Example Retrieving upper and lower limit temperatures of the PB UINT Ret; INT LowerLimit; INT UpperLimit; Ret = mgettemplimit(m_temp_target_brd, &LowerLimit, &UpperLimit Dim Ret As Long Dim LowerLimit As Long Dim UpperLimit As Long Ret = mgettemplimit(m_temp_target_brd, LowerLimit, UpperLimit) uint Ret; int LowerLimit; int UpperLimit; Ret = IFPMGR.mGetTempLimit(IFPMGR.M_TEMP_TARGET_BRD, out LowerLimit, out UpperLimit.NET Dim Ret As Integer Dim LowerLimit As Integer; Dim UpperLimit As Integer Ret = IFPMGR.mGetTempLimit(IFPMGR.M_TEMP_TARGET_BRD, LowerLimit, UpperLimit) 27

28 4.1.9 mgetpower The mgetpower function retrieves a power supply voltage. The function is applicable only to the Atom models. Syntax UINT mgetpower( UINT Target, float* ppower Declare Function mgetpower Lib "ifcpmgr.dll"( _ ByVal Target As Long, _ ByRef ppower As Single _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint mgetpower( uint Target, out float ppower.net Declare Function mgetpower Lib "ifcpmgr.dll"(_ ByVal Target As Integer, _ ByRef ppower As Single _ )As Integer Parameters Target The parameter specifies a target to retrieve a voltage. Only the following values are applicable. ode Value M_POWER_TARGET_5V 1 Retrieves a voltage of 5 Vdc power supply. M_POWER_TARGET_3_3V 2 Retrieves a voltage of 3.3 Vdc power supply. M_POWER_TARGET_12V 3 Retrieves a voltage of 12 Vdc power supply. This code is applicable only to the Long-Term Supply Industrial ontroller Atom models. M_POWER_TARGET_5VSB 5 Retrieves a voltage of 5 Vdc standby power supply. This code is applicable only to the Atom N2800 models. ppower This parameter points to a variable to receive the voltage value. The unit is Vdc. 28

29 Return Values This function returns the following return values. ode Value IFM_ERROR_SUESS 0 Successful completion IFM_ERROR_INTERNAL h Internal error IFM_ERROR_INVALID_PARAMETER h Invalid input parameter IFM_ERROR_NULL_POINTER h NULL pointer detection IFM_ERROR_INVALID_HANDLE h Internal error IFM_ERROR_NOT_SUPPORT h Not supported Refer to 4.4 Return Values for details if the function returns a value other than 0. Example Retrieving a voltage of 5 Vdc power supply UINT Ret; float Power; Ret = mgetpower(m_power_target_5v, &Power Dim Ret As Long Dim Power As Single Ret = mgetpower(m_power_target_5v, Power) uint Ret; float Power; Ret = IFPMGR.mGetPower(IFPMGR.M_POWER_TARGET_5V, out Power.NET Dim Ret As Integer Dim Power As Single Ret = IFPMGR.mGetPower(IFPMGR.M_POWER_TARGET_5V, Power) 29

30 msetevent The msetevent function registers notification methods of interrupt event: event signal, message, and function callback. Syntax UINT msetevent( PM_EVENT_REQ pevent Declare Function msetevent Lib "ifcpmgr.dll"( _ ByRef pevent As M_EVENT_REQ _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint msetevent( ref M_EVENT_REQ pevent.net Declare Function msetevent Lib "ifcpmgr.dll"(_ ByRef pevent As M_EVENT_REQ _ )As Integer Parameters pevent The parameter points to a variable that contains a setting of event handling. Refer to M_EVENT_REQ for details. Return Values This function returns the following return values. ode Value IFM_ERROR_SUESS 0 Successful completion IFM_ERROR_ALREADY h Event is already registered IFM_ERROR_NULL_POINTER h Null pointer detection IFM_ERROR_NOT_ALLOATE h Memory allocation error IFM_ERROR_INVALID_HANDLE h Internal error Refer to 4.4 Return Values for details if the function returns a value other than 0. omment An event can be registered per program. Refer to "4.2 allback Functions" for more details on the callback functions.! aution allback functions can be handled only in. Use event signal or message for other languages. 30

31 Example Registering a signal event UINT Ret; M_EVENT_REQ EventReq; EventReq.Signal = reateevent(null, TRUE, FALSE, NULL EventReq.Wnd = NULL; EventReq.Msg = WM_NULL; EventReq.allBackProc = NULL; EventReq.User = NULL; Ret = msetevent(&eventreq Dim Ret As Long Dim EventReq As M_EVENT_REQ EventReq.Signal = reateevent(0, True, False, 0) EventReq.Wnd = 0 EventReq.Msg = 0 EventReq.allBackProc = 0 EventReq.User = 0 Ret = msetevent(eventreq) uint Ret; IFPMGR.M_EVENT_REQ EventReq = new IFPMGR.M_EVENT_REQ( EventReq.Signal = IFPMGR.reateEvent(IntPtr.Zero, true, false, null EventReq.Wnd = IntPtr.Zero; EventReq.Msg = 0; EventReq.allBackProc = IntPtr.Zero; EventReq.User = IntPtr.Zero; Ret = IFPMGR.mSetEvent(ref EventReq.NET Dim Ret As Integer Dim EventReq As IFPMGR.M_EVENT_REQ = New IFPMGR.M_EVENT_REQ EventReq.Signal = IFPMGR.reateEvent(IntPtr.Zero, True, False, Nothing) EventReq.Wnd = IntPtr.Zero EventReq.Msg = 0 EventReq.allBackProc = IntPtr.Zero EventReq.User = IntPtr.Zero Ret = IFPMGR.mSetEvent(EventReq) 31

32 mkillevent The mkillevent function releases registered interrupt events. Syntax UINT mkillevent(void Declare Function mkillevent Lib "ifcpmgr.dll"() As Long _ [DllImport("ifcpmgr.dll")] public static extern uint mkillevent(.net Declare Function mkillevent Lib "ifcpmgr.dll"() As Integer Parameters None Return Values This function returns the following return values. ode Value IFM_ERROR_SUESS 0 Successful completion IFM_ERROR_NOT_YET h Not in progress yet IFM_ERROR_INVALID_HANDLE h Internal error Refer to 4.4 Return Values for details if the function returns a value other than 0. Example Releasing registered interrupt events UINT Ret; Ret = mkillevent( Dim Ret As Long Ret = mkillevent() uint Ret; Ret = IFPMGR.mKillEvent(.NET Dim Ret As Integer Ret = IFPMGR.mKillEvent() 32

33 mseteventmask The mseteventmask function configures a mask of interrupt events to enable or disable each event. Syntax UINT mseteventmask( UINT* pmask, UINT ount Declare Function mseteventmask Lib "ifcpmgr.dll"( _ ByRef pmask As Long, _ ByVal ount As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint mseteventmask( ref uint pmask, uint ount.net Declare Function mseteventmask Lib "ifcpmgr.dll"(_ ByRef pmask As Integer, _ ByVal ount As Integer _ )As Integer Parameters pmask The parameter points to a variable that contains a mask of interrupt events A value of 0 disables all events. The default value is 0. One or more values can be ORed. Depending on the model, the supported values are different. Do not use unsupported functions. ode Value Availability *1 A B D E M_EVENT_WDS 1h Enables an event that the WDT is timed-out. M_EVENT_PTHS 2h Enables an event that a temperature of the PU goes over the upper limit. - - M_EVENT_PTLS 4h Enables an event that a temperature of the PU goes below the lower limit. - - M_EVENT_LTHS 8h Enables an event that a temperature of the PB goes over the upper limit. M_EVENT_LTLS 10h Enables an event that a temperature the PB goes below the lower limit. M_EVENT_V5VSR 20h Enables an event that a voltage of 5 Vdc power supply is abnormal. - - M_EVENT_V3VSR 40h Enables an event that a voltage of 3.3 Vdc power supply is abnormal. - - M_EVENT_V12VSR 80h Enables an event that a voltage of 12 Vdc power supply is abnormal

34 ode Value M_EVENT_PSMP1_FAL 100h Enables an event that the slot-in power module installed in the P1 slot is failed (The FAIL signal is detected.) M_EVENT_PSMP2_FAL 200h Enables an event that the slot-in power module installed in the P2 slot is failed (The FAIL signal is detected.) M_EVENT_PSMP3_FAL 400h Enables an event that the slot-in power module installed in the P3 slot is failed (The FAIL signal is detected.) M_EVENT_PSMP4_FAL 800h Enables an event that the slot-in power module installed in the P4 slot is failed (The FAIL signal is detected.) M_EVENT_PSMP5_FAL 1000h Enables an event that the slot-in power module installed in the P5 slot is failed (The FAIL signal is detected.) M_EVENT_PSMP6_FAL 2000h Enables an event that the slot-in power module installed in the P6 slot is failed (The FAIL signal is detected.) M_EVENT_PSMP1_DEG 4000h Enables an event that the slot-in power module installed in the P1 slot is alarmed (The ALM signal is detected.) M_EVENT_PSMP2_DEG 8000h Enables an event that the slot-in power module installed in the P2 slot is alarmed (The ALM signal is detected.) M_EVENT_PSMP3_DEG 10000h Enables an event that the slot-in power module installed in the P3 slot is alarmed (The ALM signal is detected.) M_EVENT_PSMP4_DEG 20000h Enables the P4 slot-in power module alarm (ALM signal detection) event. M_EVENT_PSMP5_DEG M_EVENT_PSMP6_DEG M_EVENT_FANST 40000h 80000h *1 : supported -: not supported Enables an event that the slot-in power module installed in the P5 slot is alarmed (The ALM signal is detected.) Enables an event that the slot-in power module installed in the P6 slot is alarmed (The ALM signal is detected.) h Enables an event that of a PU fan is failed. (ontinued) Availability *1 A B D E *2 - *2 A: Long Term Supply Industrial ontroller Atom N2800 model B: Long Term Supply Industrial ontroller (Atom N2800 model excluded) : Long Term Supply Industrial ontroller ore i7/eleron models D: Slot-in Industrial ontroller Atom model E: Slot-in Industrial ontroller ore i7/eleron models * The code is applicable only to ore i7/eleron (1st) models with a PU fan. heck the hardware manual if your controller has a PU fan or not. 34

35 ount Reserved. Specify 1. Return Values This function returns the following return values. ode Value IFM_ERROR_SUESS 0 Successful completion IFM_ERROR_INVALID_PARAMETER h Invalid input parameter IFM_ERROR_INVALID_HANDLE h Internal error Refer to 4.4 Return Values for details if the function returns a value other than 0. omments - An event mask can be independently configured per program. - When the same event is enabled in one or more programs and the event is generated, the event is notified to the programs. Example Enabling WDT event and abnormal 12 Vdc power supply voltage event UINT Ret; UINT Mask; Mask = M_EVENT_WDS M_EVENT_V12VSR; Ret = mseteventmask(&mask, 1 Dim Ret As Long Dim Mask As Long Mask = M_EVENT_WDS Or M_EVENT_V12VSR Ret = mseteventmask(mask, 1) uint Ret; uint Mask; Mask = IFPMGR.M_EVENT_WDS IFPMGR.M_EVENT_V12VSR; Ret = IFPMGR.mSetEventMask(ref Mask, 1.NET Dim Ret As Integer Dim Mask As Integer Mask = IFPMGR.M_EVENT_WDS Or IFPMGR.M_EVENT_V12VSR Ret = IFPMGR.mSetEventMask(Mask, 1)) 35

36 mgeteventmask The mgeteventmask function retrieves a mask of interrupt events. Syntax UINT mgeteventmask( UINT* pmask, UINT ount Declare Function mgeteventmask Lib "ifcpmgr.dll"( _ ByRef pmask As Long, _ ByVal ount As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint mgeteventmask( out uint pmask, uint ount.net Declare Function mgeteventmask Lib "ifcpmgr.dll"(_ ByRef pmask As Integer, _ ByVal ount As Integer _ )As Integer Parameter pmask The parameter points to a variable to receive an event mask value. The parameter retrieves a value configured by the mseteventmask function. ount Reserved. Specify 1. Return Values This function returns the following return values. ode Value IFM_ERROR_SUESS 0 Successful completion IFM_ERROR_NULL_POINTER h NULL pointer detection IFM_ERROR_INVALID_HANDLE h Internal error Refer to 4.4 Return Values for details if the function returns a value other than 0. 36

37 Example Retrieving the current interrupt mask value UINT Ret; UINT Mask; Ret = mgeteventmask(&mask, 1 Dim Ret As Long Dim Mask As Long Ret = mgeteventmask(mask, 1) uint Ret; uint Mask; Ret = IFPMGR.mGetEventMask(out Mask, 1 Dim Ret As Integer Dim Mask As Integer Ret = IFPMGR.mGetEventMask(Mask, 1) 37

38 mgeteventfactor The mgeteventfactor function retrieves sources of interrupt events. Syntax UINT mgeteventfactor( UINT* pfactor, UINT ount Declare Function mgeteventfactor Lib "ifcpmgr.dll"( _ ByRef pfactor As Long, _ ByVal ount As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint mgeteventfactor( out uint pfactor, uint ount.net Declare Function mgeteventfactor Lib "ifcpmgr.dll"(_ ByRef pfactor As Integer, _ ByVal ount As Integer _ )As Integer 38

39 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. ode Value M_EVENT_WDS 1h WDT time-out error occurs M_EVENT_PTHS 2h PU temperature goes over the upper limit M_EVENT_PTLS 4h PU temperature goes below the lower limit M_EVENT_LTHS 8h PB temperature goes over the upper limit M_EVENT_LTLS 10h PB temperature goes under the lower limit M_EVENT_V5VSR 20h A voltage of 5 Vdc power supply is abnormal M_EVENT_V3VSR 40h A voltage of 3.3 Vdc power supply is abnormal M_EVENT_V12VSR 80h A voltage of 12 Vdc power supply is abnormal M_EVENT_PSMP1_FAL 100h The slot-in power module installed in the P1 slot is failed (The FAIL signal is detected.) M_EVENT_PSMP2_FAL 200h The slot-in power module installed in the P2 slot is failed (The FAIL signal is detected.) M_EVENT_PSMP3_FAL 400h The slot-in power module installed in the P3 slot is failed (The FAIL signal is detected.) M_EVENT_PSMP4_FAL 800h The slot-in power module installed in the P4 slot is failed (The FAIL signal is detected.) M_EVENT_PSMP5_FAL 1000h The slot-in power module installed in the P5 slot is failed (The FAIL signal is detected.) M_EVENT_PSMP6_FAL 2000h The slot-in power module installed in the P6 slot is failed (The FAIL signal is detected.) M_EVENT_PSMP1_DEG 4000h The slot-in power module installed in the P1 slot is alarmed (The ALM signal is detected.) M_EVENT_PSMP2_DEG 8000h The slot-in power module installed in the P2 slot is alarmed (The ALM signal is detected.) M_EVENT_PSMP3_DEG 10000h The slot-in power module installed in the P3 slot is alarmed (The ALM signal is detected.) M_EVENT_PSMP4_DEG 20000h The slot-in power module installed in the P4 slot is alarmed (The ALM signal is detected.) M_EVENT_PSMP5_DEG 40000h The slot-in power module installed in the P5 slot is alarmed (The ALM signal is detected.) M_EVENT_PSMP6_DEG 80000h The slot-in power module installed in the P6 slot is alarmed (The ALM signal is detected.) M_EVENT_FASNST h A PU fan is failed. ount Reserved. Specify 1. Return Values This function returns the following return values. ode Value IFM_ERROR_SUESS 0 Successful completion IFM_ERROR_NULL_POINTER h NULL pointer detection IFM_ERROR_INVALID_HANDLE h Internal error Refer to 4.4 Return Values for details if the function returns a value other than 0.! aution 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. 39

40 omment - 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 PU temperature goes over the upper limit, and the PU temperature goes over the upper limit again before the function retrieves the source of the first event. In case, this function returns M_EVENT_PTHS 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. 40

41 Example Retrieving event sources in the message handler LRESULT EventDlg::OnMessage(WPARAM wparam, LPARAM lparam) { unsigned int Ret; unsigned int Factor; Ret = mgeteventfactor(&factor, 1 } Public Sub OnMessage() Dim Ret As Long Dim Factor As Long Ret = mgeteventfactor(factor, 1) End Sub private void OnMessage(IntPtr WParam, IntPtr LParam) { uint Ret; uint Factor; Ret = IFPMGR.mGetEventFactor(out Factor, 1 }.NET Public Sub OnMessage(ByVal WParam As IntPtr, ByVal LParam As IntPtr) Dim Ret As Integer Dim Factor As Integer Ret = IFPMGR.mGetEventFactor(Factor, 1) End Sub 41

42 mgetspecifiedstatus The mgetspecifiedstatus function retrieves the specified status. Syntax UINT mgetspecifiedstatus( UINT* pstatus Declare Function mgetspecifiedstatus Lib "ifcpmgr.dll"( _ ByRef pstatus As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint mgetspecifiedstatus( ref uint pstatus.net Declare Function mgetspecifiedstatus Lib "ifcpmgr.dll"(_ ByRef pstatus As Integer _ )As Integer Parameter 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 to bit12 bit11 bit9, bit10 bit8 bit7 to bit0 Reserved FAN Reserved WDTE Reserved WDTE: Status of WDT. 0: WDT is enabled 1: WDT is disabled FAN: Status of PU fan 0: Fan stops 1: Fan is in operation FAN is applicable only to ore i7/eleron (1st) models with a PU fan. 42

43 Return Values This function returns the following return values. ode Value IFM_ERROR_SUESS 0 Successful completion IFM_ERROR_INTERNAL h Internal error IFM_ERROR_NULL_POINTER h NULL pointer detection IFM_ERROR_INVALID_HANDLE h Internal error Refer to 4.4 Return Values for details if the function returns a value other than 0. Example Retrieving current WDT status UINT Ret; UINT Status; Status = 0x ; Ret = mgetspecifiedstatus(&status Dim Ret As Long Dim Status As Long Status = &H100 Ret = mgetspecifiedstatus(status) uint Ret; uint Status; Status = 0x ; Ret = IFPMGR.mGetSpecifiedStatus(ref Status.NET Dim Ret As Integer Dim Status As Integer Status = &H100 Ret = IFPMGR.mGetSpecifiedStatus(Status) 43

44 msetpowerbuttonfilter The msetpowerbuttonfilter function sets the power button to ignore any operation for 1 second to protect from erroneous operations on the button. The function is applicable only to ore i7/eleron models. Syntax UINT msetpowerbuttonfilter ( UINT Enable Declare Function msetpowerbuttonfilter Lib "ifcpmgr.dll"( _ ByVal Enable As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint msetpowerbuttonfilter ( uint Enable.NET Declare Function msetpowerbuttonfilter Lib "ifcpmgr.dll"(_ ByVal Enable As Integer _ )As Integer Parameter Enable The parameter enables/disables the error protection filter of 1 second. Specify either one of the values. ode Value M_FILTER_ENABLE 1h Enables the filter. M_FILTER_DISABLE 0h Disables the filter. Return Values This function returns the following return values. ode Value IFM_ERROR_SUESS 0 Successful completion IFM_ERROR_INTERNAL h Internal error IFM_ERROR_INVALID_PARAMETER h Invalid input parameter IFM_ERROR_INVALID_HANDLE h Internal error IFM_ERROR_NOT_SUPPORT h Not supported Refer to 4.4 Return Values for details if the function returns a value other than 0. omment The setting is stored in the internal non-volatile memory and retained while the system is turned off. The setting is applied when the system starts the next time 44

45 Example Enabling 1 second error protection filter UINT Ret; Ret = msetpowerbuttonfilter(m_filter_enable Dim Ret As Long Ret = msetpowerbuttonfilter(m_filter_enable) uint Ret; Ret = IFPMGR.mSetPowerButtonFilter(IFPMGR.M_FILTER_ENABLE.NET Dim Ret As Integer Ret = IFPMGR.mSetPowerButtonFilter(IFPMGR.M_FILTER_ENABLE) 45

46 mgetpowerbuttonfilter The mgetpowerbuttonfilter function retrieves the settings of 1 second error protection filter of the power button. The function is applicable only to the ore i7/eleron models. Syntax UINT mgetpowerbuttonfilter ( UINT* penable Declare Function mgetpowerbuttonfilter Lib "ifcpmgr.dll"( _ ByRef penable As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint mgetpowerbuttonfilter ( ref uint penable.net Declare Function mgetpowerbuttonfilter Lib "ifcpmgr.dll"(_ ByRef penable As Integer _ )As Integer Parameter penable The parameter points to a variable to receive the status (enable/disable) of the 1 second error protection filter. A value set by the msetpowerbuttonfilter is retrieved. Return Values This function returns the following return values. ode Value IFM_ERROR_SUESS 0 Successful completion IFM_ERROR_INTERNAL h Internal error IFM_ERROR_NULL_POINTER h NULL pointer detection IFM_ERROR_INVALID_HANDLE h Internal error IFM_ERROR_NOT_SUPPORT h Not supported Refer to 4.4 Return Values for details if the function returns a value other than 0. 46

47 Example Retrieving the status of 1 second error protection filter UINT Ret; UINT Enable; Ret = mgetpowerbuttonfilter(&enable Dim Ret As Long Dim Enable As Long Ret = mgetpowerbuttonfilter(enable) uint Ret; uint Enable; Ret = IFPMGR.mGetPowerButtonFilter(out Enable.NET Dim Ret As Integer Dim Enable As Integer Ret = IFPMGR.mGetPowerButtonFilter(Enable) 47

48 msetledonfig The mgetledonfig function configures blinking conditions of the LED for error indication. The function is applicable only to ore i7/eleron models. Syntax UINT msetledonfig ( UINT* Enable Declare Function msetledonfig Lib "ifcpmgr.dll"( _ ByVal Enable As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint msetledonfig ( Uint Enable.NET Declare Function msetledonfig Lib "ifcpmgr.dll"(_ ByVal Enable As Integer _ )As Integer Parameter Enable The parameter specifies blinking conditions of the LED. Specify values from the following table. One or more values can be ORed. ode Value M_EVENT_LTHS 8h A temperature of the PB goes over the upper limit. M_EVENT_LTLS 10h A temperature of the PB goes below the lower limit. M_EVENT_FANST h The PU fan has an error. * * The code is applicable only to the products with a PU fan. Return Values This function returns the following return values. ode Value IFM_ERROR_SUESS 0 Successful completion IFM_ERROR_INTERNAL h Internal error IFM_ERROR_INVALID_PARAMETER h Invalid input parameter IFM_ERROR_INVALID_HANDLE h Internal error IFM_ERROR_NOT_SUPPORT h Not supported Refer to 4.4 Return Values for details if the function returns a value other than 0. omment The setting is stored in the internal non-volatile memory and retained while the system is turned off. The setting is applied when the system starts the next time 48

49 Example Setting the LED to blink when a temperature of the PB goes over the upper-limit temperature UINT Ret; Ret = msetledonfig(m_event_lths Dim Ret As Long Ret = msetledonfig(m_event_lths) uint Ret; Ret = IFPMGR.mSetLedonfig(IFPMGR.M_EVENT_LTHS.NET Dim Ret As Integer Ret = IFPMGR.mSetLedonfig(IFPMGR.M_EVENT_LTHS) 49

50 mgetledonfig The mgetledonfig function retrieves blinking conditions of the LED. The function is applicable only to ore i7/eleron model. Syntax UINT mgetledonfig ( UINT* penable Declare Function mgetledonfig Lib "ifcpmgr.dll"( _ ByRef penable As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint mgetledonfig ( ref uint penable.net Declare Function mgetledonfig Lib "ifcpmgr.dll"(_ ByRef penable As Integer _ )As Integer Parameter penable The parameter points to a variable to receive blinking conditions of the LED. A value specified by the msetledonfig function is retrieved. Return Values This function returns the following return values. ode Value IFM_ERROR_SUESS 0 Successful completion IFM_ERROR_INTERNAL h Internal error IFM_ERROR_NULL_POINTER h NULL pointer detection IFM_ERROR_INVALID_HANDLE h Internal error IFM_ERROR_NOT_SUPPORT h Not supported Refer to 4.4 Return Values for details if the function returns a value other than 0. 50

51 Example Retrieving blinking conditions of the LED UINT Ret; UINT Enable; Ret = mgetledonfig(&enable Dim Ret As Long Dim Enable As Long Ret = mgetledonfig(enable) uint Ret; uint Enable; Ret = IFPMGR.mGetLedonfig(out Enable.NET Dim Ret As Integer Dim Enable As Integer Ret = IFPMGR.mGetLedonfig(Enable) 51

52 mgetunitfanstatus The mgetunitfanstatus function retrieves statuses of the chassis fans. The function is applicable only to Long-Term Supply Industrial ontroller Atom N2800 and ore i7/eleron models. Refer to 2.1 Functional Specifications for details. Syntax UINT mgetunitfanstatus ( UINT* pstatus, UINT ount Declare Function mgetunitfanstatus Lib "ifcpmgr.dll" ( _ ByRef pstatus As Long, _ ByVal ount As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint mgetunitfanstatus( uint[] pstatus, uint ount.net Declare Function mgetunitfanstatus Lib "ifcpmgr.dll" (_ ByVal pstatus() As Integer, _ ByVal ount As Integer _ )As Integer Parameter pstatus The parameter points to an array to receive statuses of the chassis fans. Array pstatus[0] Exhaust fan in a 7-slot unit (short-size/full size) or exhaust fan 1 in a 9-slot unit (short-size/full size) pstatus[1] Exhaust fan 2 in a 9-slot unit (short-size/full-size) or exhaust fan 1 in a 13-slot unit (short-size/full-size) pstatus[2] Exhaust fan 2 in a 13-slot unit (short-size/full-size) pstatus[3] Fan in a 4-slot unit (short-size) Each element is 1 while the fan is in operation and 0 when the fan stops or is not connected. ount Reserved. Specify 4. 52

53 Return Values This function returns the following return values. ode Value IFM_ERROR_SUESS 0 Successful completion IFM_ERROR_INTERNAL h Internal error IFM_ERROR_INVALID PARAMETER h Input invalid parameter IFM_ERROR_NULL_POINTER h NULL pointer detection IFM_ERROR_INVALID_HANDLE h Internal error IFM_ERROR_NOT_SUPPORT h Not supported Refer to 4.4 Return Values for details if the function returns a value other than 0. omment Use appropriate elements of the array according to your system. For example, if you use a 13-slot unit, monitor only element 1 (exhaust fan 1) and element 2 (exhaust fan 2) of the array. Example Retrieving the current status of chassis fan UINT Ret; UINT Status[4]; Ret = mgetunitfanstatus(&status[0], 4 Dim Ret As Long Dim Status(3) As Long Ret = mgetunitfanstatus(status(0), 4) uint Ret; uint[] Status = new uint[4]; Ret = IFPMGR.mGetUnitFanStatus(Status, 4.NET Dim Ret As Integer Dim Status(3) As Integer Ret = IFPMGR.mGetUnitFanStatus(Status(0), 4) 53

54 mgetpsmid The mgetpsmid function retrieves IDs of slot-in power supply modules. The function is applicable only when the slot-in power supply modules are used. Syntax UINT mgetpsmid ( UINT* pmoduleid, UINT ount Declare Function mgetpsmid Lib "ifcpmgr.dll" ( _ ByRef pmoduleid As Long, _ ByVal ount As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint mgetpsmid( uint[] pmoduleid, uint ount.net Declare Function mgetpsmid Lib "ifcpmgr.dll" ( _ ByVal pmoduleid() As Integer, _ ByVal ount As Integer _ )As Integer Parameter pmoduleid The parameter points to an array to receive IDs of slot-in power supply modules. IDs of the number specified by ount are retrieved. Array element pmoduleid[0] ID of the slot-in power supply module installed in the P1 slot pmoduleid[1] ID of the slot-in power supply module installed in the P2 slot pmoduleid[2] ID of the slot-in power supply module installed in the P3 slot pmoduleid[3] ID of the slot-in power supply module installed in the P4 slot pmoduleid[4] ID of the slot-in power supply module installed in the P5 slot pmoduleid[5] ID of the slot-in power supply module installed in the P6 slot The slot positions for the slot-in power supply modules are defined as P1, P2 from the left. 54

55 The IDs are defined as follows ID Model 05h JPS Vdc input module (isolated, 80 W) 06h JPS Vdc input module (isolated, 80 W) 08h JPS-2101 ATX output module (100 W) 09h JPS Vac/200 Vac input module (isolated, 130 W) 0Ah JPS Vdc input module (isolated, 130 W) 0Bh JPS Vdc input module (isolated, 130 W) 0h JPS ~ +24 Vdc input module (non-isolated, 130 W) 0Dh JPS Vdc input module for +12 Vdc power supply bus (non-isolated, 50 W) 0Eh JPS JPS Vdc input module (non-isolated, 150 W) +24 Vdc input module (isolated,150 W) * JPS and JPS have the same ID. 0Fh Uninstalled No slot-in power supply module is installed. ount The parameter specifies the number of IDs to retrieve. The maximum value is 6. For example, if you specify 4, 4 IDs are stored in pmoduleid[0] through pmoduleid[3]. Return Values This function returns the following return values. ode Value IFM_ERROR_SUESS 0 Successful completion IFM_ERROR_INTERNAL h Internal error IFM_ERROR_INVALID PARAMETER h Input invalid parameter IFM_ERROR_NULL_POINTER h NULL pointer detection IFM_ERROR_INVALID_HANDLE h Internal error IFM_ERROR_NOT_SUPPORT h Not supported Refer to 4.4 Return Values for details if the function returns a value other than 0. Example Retrieving IDs of slot-in power supply modules UINT Ret; UINT ModuleId[4]; Ret = mgetpsmid(&moduleid[0], 4 Dim Ret As Long Dim ModuleId(3) As Long Ret = mgetpsmid(moduleid(0), 4) uint Ret; uint[] ModuleId = new uint[4]; Ret = IFPMGR.mGetPsmId(ModuleId, 4.NET Dim Ret As Integer Dim ModuleId(3) As Integer Ret = IFPMGR.mGetPsmId(ModuleId(0), 4) 55

56 mgetpsmstatus The mgetpsmstatus function retrieves statuses of slot-in power supply modules. The function is applicable only when the slot-in power supply modules are used. Syntax UINT mgetpsmstatus ( UINT* pstatus, UINT ount Declare Function mgetpsmstatus Lib "ifcpmgr.dll" ( _ ByRef pstatus As Long, _ ByVal ount As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint mgetpsmstatus( uint[] pstatus, uint ount.net Declare Function mgetpsmstatus Lib "ifcpmgr.dll" (_ ByVal pstatus() As Integer, _ ByVal ount As Integer _ )As Integer Parameter pstatus The parameter points to an array to receive statuses of slot-in power supply modules. IDs whose count is specified by ount are retrieved. Array element pstatus[0] Status of a slot-in power supply module installed in the P1 slot pstatus[1] Status of a slot-in power supply module installed in the P2 slot pstatus[2] Status of a slot-in power supply module installed in the P3 slot pstatus[3] Status of a slot-in power supply module installed in the P4 slot pstatus[4] Status of a slot-in power supply module installed in the P5 slot pstatus[5] Status of a slot-in power supply module installed in the P6 slot The slot positions for the slot-in power supply modules are defined as P1, P2 from the left The following values are stored in each element when an error is detected. When no errors are detected, 0 is stored in each element. One or more values may be ORed. ode Value M_PSM_STATUS_DEG 01h Alarm (The ALM signal is detected.) M_PSM_STATUS_FAL 02h Fail (The FAIL signal is detected) 56

57 ount The parameter specifies the number of statuses to retrieve. The maximum value is 6. For example, if you specify 4, 4 statuses are stored in pstatus[0] through pstatus[3]. Return Values This function returns the following return values. ode Value IFM_ERROR_SUESS 0 Successful completion IFM_ERROR_INTERNAL h Internal error IFM_ERROR_INVALID PARAMETER h Input invalid parameter IFM_ERROR_NULL_POINTER h NULL pointer detection IFM_ERROR_INVALID_HANDLE h Internal error IFM_ERROR_NOT_SUPPORT h Not supported Refer to 4.4 Return Values for details if the function returns a value other than 0. Example Retrieving statuses of slot-in power supply modules. UINT Ret; UINT Status[4]; Ret = mgetpsmstatus(&status[0], 4 Dim Ret As Long Dim Status(3) As Long Ret = mgetpsmstatus(status(0), 4) uint Ret; uint[] Status = new uint[4]; Ret = IFPMGR.mGetPsmStatus(Status, 4.NET Dim Ret As Integer Dim Status(3) As Integer Ret = IFPMGR.mGetPsmStatus(Status(0), 4) 57

58 mgetbatinfo The mgetbatinfo function retrieves information of the battery module. The function is applicable only when the battery module is used. Syntax UINT mgetbatinfo ( PM_BAT_INFO pinfo Declare Function mgetbatinfo Lib "ifcpmgr.dll" ( _ ByRef pinfo As M_BAT_INFO _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint mgetbatinfo( out M_BAT_INFO pinfo.net Declare Function mgetbatinfo Lib "ifcpmgr.dll" (_ ByRef pinfo As M_BAT_INFO _ )As Integer Parameter pinfo The parameter points to a variable to receive information of the battery module. Refer to M_BAT_INFO. Return Values This function returns the following return values. ode Value IFM_ERROR_SUESS 0 Successful completion IFM_ERROR_INTERNAL h Internal error IFM_ERROR_NULL_POINTER h NULL pointer detection IFM_ERROR_INVALID_HANDLE h Internal error IFM_ERROR_NOT_SUPPORT h Not supported Refer to 4.4 Return Values for details if the function returns a value other than 0. 58

59 Example Retrieving information of the battery module UINT Ret; M_BAT_INFO Info; Ret = mgetbatinfo(&info Dim Ret As Long Dim Info As M_BAT_INFO Ret = mgetbatinfo(info) uint Ret; IFPMGR.M_BAT_INFO Info = new IFPMGR.M_BAT_INFO( Ret = IFPMGR.mGetBatInfo(out Info.NET Dim Ret As Integer Dim Info As IFPMGR.M_BAT_INFO = New IFPMGR.M_BAT_INFO() Ret = IFPMGR.mGetBatInfo(Info) 59

60 mgetbathistory The mgetbathistory function retrieves a history of the battery module. The function is applicable only when the battery module is used. Syntax UINT mgetbathistory ( PM_BAT_HISTORY phistory Declare Function mgetbathistory Lib "ifcpmgr.dll" ( _ ByRef phistory As M_BAT_HISTORY _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint mgetbathistory( out M_BAT_HISTORY phistory.net Declare Function mgetbathistory Lib "ifcpmgr.dll" (_ ByRef phistory As M_BAT_HISTORY _ )As Integer Parameter phistory The parameter points to a variable to receive a history of the battery module. Refer to M_BAT_HISTORY. Return Values This function returns the following return values. ode Value IFM_ERROR_SUESS 0 Successful completion IFM_ERROR_INTERNAL h Internal error IFM_ERROR_NULL_POINTER h NULL pointer detection IFM_ERROR_INVALID_HANDLE h Internal error IFM_ERROR_NOT_SUPPORT h Not supported Refer to 4.4 Return Values for details if the function returns a value other than 0. 60

61 Example Retrieving a history of the battery module UINT Ret; M_BAT_HISTORY History; Ret = mgetbathistory(&history Dim Ret As Long Dim History As M_BAT_HISTORY Ret = mgetbathistory(history) uint Ret; IFPMGR.M_BAT_HISTORY History = new IFPMGR.M_BAT_HISTORY( Ret = IFPMGR.mGetBatHistory(out History.NET Dim Ret As Integer Dim Info As IFPMGR.M_BAT_HISTORY = New IFPMGR.M_BAT_HISTORY() Ret = IFPMGR.mGetBatHistory(History) 61

62 mgetbatstatus The mgetbatstatus function retrieves statuses of the battery module. The function is applicable only when the battery module is used. Syntax UINT mgetbatstatus ( UINT* pstatus Declare Function mgetbatstatus Lib "ifcpmgr.dll" ( _ ByRef pstatus As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint mgetbatstatus( out uint pstatus.net Declare Function mgetbatstatus Lib "ifcpmgr.dll" (_ ByRef pstatus As Integer _ )As Integer Parameter pstatus The parameter points to a variable to receive statuses of the battery module. When the content of a bit is 1, the corresponding status is detected. Ignore the reserved bits. Bit 0 Reserved 1 Reserved 2 Reserved 3 Reserved 4 The battery is charging. 5 The battery is fully charged 6 It is during power failure 7 Reserved 8 Reserved 9 Reserved 10 An error occurred during self-diagnostics 11 Discharge error occurred. 12 Battery temperature error occurred. 13 Reserved 14 harge error occurred. 15 Reserved 16~23 Reserved 24~31 Reserved 62

63 Return Values This function returns the following return values. ode Value IFM_ERROR_SUESS 0 Successful completion IFM_ERROR_INTERNAL h Internal error IFM_ERROR_NULL_POINTER h NULL pointer detection IFM_ERROR_INVALID_HANDLE h Internal error IFM_ERROR_NOT_SUPPORT h Not supported Refer to 4.4 Return Values for details if the function returns a value other than 0. Example Retrieving statuses of the battery module UINT Ret; UINT Status; Ret = mgetbatstatus(&status Dim Ret As Long Dim Status As Long Ret = mgetbatstatus(status) uint Ret; uint Status; Ret = IFPMGR.mGetBatStatus(out Status.NET Dim Ret As Integer Dim Status As Integer Ret = IFPMGR.mGetBatStatus(Status) 63

64 mgetbatdiagstatus The mgetbatdiagstatus function retrieves statuses of self-diagnostics of the battery module. The function is applicable only to a battery module. Syntax UINT mgetbatdiagstatus ( UINT* pstatus Declare Function mgetbatdiagstatus Lib "ifcpmgr.dll" ( _ ByRef pstatus As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint mgetbatdiagstatus( out uint pstatus.net Declare Function mgetbatdiagstatus Lib "ifcpmgr.dll" (_ ByRef pstatus As Integer _ )As Integer Parameter pstatus The parameter points to a variable to receive statuses of self-diagnostics of the battery module. When the content of a bit is 1, the corresponding status is detected. Ignore the reserved bits. Bit 0 Increase of internal resistance is detected. 1 Reserved 2 Unbalance is detected during charge 3 ell-unbalance is detected during discharge. 4 Reserved 5 The battery capacity at full charge decreases to less than 50 % of the initial capacity. 6 Reserved 7 Reserved 8 Reserved 9 Reserved 10 An internal error is detected. 11 Reserved 12 An internal error is detected. 13 An internal error is detected. 14 Reserved 15 Reserved 16~23 Reserved 24~31 Reserved 64

65 Return Values This function returns the following return values. ode Value IFM_ERROR_SUESS 0 Successful completion IFM_ERROR_INTERNAL h Internal error IFM_ERROR_NULL_POINTER h NULL pointer detection IFM_ERROR_INVALID_HANDLE h Internal error IFM_ERROR_NOT_SUPPORT h Not supported Refer to 4.4 Return Values for details if the function returns a value other than 0. Example Retrieving statuses of self-diagnostics of the battery module UINT Ret; UINT Status; Ret = mgetbatdiagstatus(&status Dim Ret As Long Dim Status As Long Ret = mgetbatdiagstatus(status) uint Ret; uint Status; Ret = IFPMGR.mGetBatDiagStatus(out Status.NET Dim Ret As Integer Dim Status As Integer Ret = IFPMGR.mGetBatDiagStatus(Status) 65

66 msetbatosoffonfig The msetbatosoffonfig function configures a condition how the battery module terminates the operating system. The function is applicable only when the battery module is used. Syntax UINT msetbatosoffonfig ( UINT OsOff, UINT OffType Declare Function msetbatosoffonfig Lib "ifcpmgr.dll" ( _ ByVal OsOff As Long, _ ByVal OffType As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint msetbatosoffonfig( uint OsOff, uint OffType.NET Declare Function msetbatosoffonfig Lib "ifcpmgr.dll" (_ ByVal OsOff As Integer, _ ByVal OffType As Integer _ )As Integer Parameter OsOff The parameter specifies an interval time from when power failure begins to when the battery module requests termination of the operating system. The unit of time is second. Specify a type of termination in OffType. The interval time ranges from 0 through When 0 is specified, the operating system is not terminated. The default value is 0. OffType The parameter specifies a type of termination that is performed when the interval time elapses after the power failure begins. Value 0 Shuts down the operating system 1 Hibernates the operating system. (hibernation must be enabled ) The default value is 0. 66

67 Return Values This function returns the following return values. ode Value IFM_ERROR_SUESS 0 Successful completion IFM_ERROR_INTERNAL h Internal error IFM_ERROR_INVALID_PARAMETER h Invalid input parameter IFM_ERROR_INVALID_HANDLE h Internal error IFM_ERROR_NOT_SUPPORT h Not supported Refer to 4.4 Return Values for details if the function returns a value other than 0.! aution If the operating system disables hibernation, the operating system will be shut down when the hibernation is requested. Example Shutting down the operating system in 60 seconds after power failure. UINT Ret; Ret = msetbatosoffonfig(60, 0 Dim Ret As Long Ret = msetbatosoffonfig(60, 0) uint Ret; Ret = IFPMGR.mSetBatOsOffonfig(60, 0.NET Dim Ret As Integer Ret = IFPMGR.mSetBatOsOffonfig(60, 0) 67

68 mgetbatosoffonfig The mgetbatosoffonfig function retrieves a condition how the battery module terminates the operating system. The function is applicable only to the battery module. Syntax UINT mgetbatosoffonfig ( UINT* posoff, UINT* pofftype Declare Function mgetbatosoffonfig Lib "ifcpmgr.dll" ( _ ByRef posoff As Long, _ ByRef pofftype As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint mgetbatosoffonfig( out uint posoff, out uint pofftype.net Declare Function mgetbatosoffonfig Lib "ifcpmgr.dll" (_ ByRef posoff As Integer, _ ByRef pofftype As Integer _ )As Integer Parameter posoff The parameter points to variable to receive an interval time from when power failure occurs to when the battery module requests termination of the operating system. The unit of the time is second. pofftype The parameter points to a variable to receive a type of termination that is performed when the interval time elapses after the power failure begins The value configured by the msetbatosoffonfig function can be retrieved. 68

69 Return Values This function returns the following return values. ode Value IFM_ERROR_SUESS 0 Successful completion IFM_ERROR_INTERNAL h Internal error IFM_ERROR_NULL_POINTER h NULL pointer detection IFM_ERROR_INVALID_HANDLE h Internal error IFM_ERROR_NOT_SUPPORT h Not supported Refer to 4.4 Return Values for details if the function returns a value other than 0. Example Retrieving the duration time and the method of termination of the operating system UINT Ret; UINT OsOff; UINT OffType; Ret = mgetbatosoffonfig(&osoff, &OffType Dim Ret As Long Dim OsOff As Long Dim OffType As Long Ret = mgetbatosoffonfig(osoff, OffType) uint Ret; uint OsOff; uint OffType; Ret = IFPMGR.mGetBatOsOffonfig(out OsOff, out OffType.NET Dim Ret As Integer Dim OsOff As Integer Dim OffType As Integer Ret = IFPMGR.mGetBatOsOffonfig(OsOff, OffType) 69

70 msetbatofftime The msetbatofftime function configures a condition to stop discharge of the battery module. The function is applicable only when the battery module is used. Syntax UINT msetbatofftime ( UINT BatOff Declare Function msetbatofftime Lib "ifcpmgr.dll" ( _ ByVal BatOff As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint msetbatofftime( uint BatOff.NET Declare Function msetbatofftime Lib "ifcpmgr.dll" (_ ByVal BatOff As Integer _ )As Integer Parameter BatOff The parameter specifies an interval time from when a power failure occurs (discharge of the battery module starts) to when discharge of the battery module forcibly turned off. The unit of the interval time is second. The interval time ranges from 0 to When 0 is specified, battery discharge is immediately stopped. Return Values This function returns the following return values. ode Value IFM_ERROR_SUESS 0 Successful completion IFM_ERROR_INTERNAL h Internal error IFM_ERROR_INVALID_PARAMETER h Invalid input parameter IFM_ERROR_INVALID_HANDLE h Internal error IFM_ERROR_NOT_SUPPORT h Not supported Refer to 4.4 Return Values for details if the function returns a value other than 0.! aution After power failure occurs, system configuration information or files may be corrupted if discharge of the battery stops before post-processings of programs are successfully completed or the system is properly shut down. 70

71 Example Stopping discharge of the battery module in 120 seconds after a power failure. UINT Ret; Ret = msetbatofftime(120 Dim Ret As Long Ret = msetbatofftime(120) uint Ret; Ret = IFPMGR.mSetBatOffTime(120.NET Dim Ret As Integer Ret = IFPMGR.mSetBatOffTime(120) 71

72 mgetbatofftime The mgetbatofftime function retrieves a condition to stop discharge of the battery module. The function is applicable only when the battery module is used. Syntax UINT mgetbatofftime ( UINT* pbatoff Declare Function mgetbatofftime Lib "ifcpmgr.dll" ( _ ByRef pbatoff As Long _ )As Long [DllImport("ifcpmgr.dll")] public static extern uint mgetbatofftime( out uint pbatoff.net Declare Function mgetbatofftime Lib "ifcpmgr.dll" (_ ByRef pbatoff As Integer _ )As Integer Parameter pbatoff The parameter points to a variable to receive an interval time from when a power failure occurs (discharge of the battery module starts) to when discharge of the battery module forcibly turned off. The unit of the time is second. Return Values This function returns the following return values. ode Value IFM_ERROR_SUESS 0 Successful completion IFM_ERROR_INTERNAL h Internal error IFM_ERROR_NULL_POINTER h NULL pointer detection IFM_ERROR_INVALID_HANDLE h Internal error IFM_ERROR_NOT_SUPPORT h Not supported Refer to 4.4 Return Values for details if the function returns a value other than 0. 72

73 Example Retrieving an interval time between a power failure and stopping discharge of the battery module. UINT Ret; UINT OffTime; Ret = mgetbatofftime(&offtime Dim Ret As Long Dim OffTime As Long Ret = mgetbatofftime(offtime) uint Ret; uint OffTime; Ret = IFPMGR.mGetBatOffTime(out OffTime.NET Dim Ret As Integer Dim OffTime As Integer Ret = IFPMGR.mGetBatOffTime(OffTime) 73

74 4.2 allback Functions The callback function is supported only in. Syntax void ALLBAK UserallBack( PVOID User Parameter User The parameter specifies a user parameter The value specified by the User member of the M_EVENT_REQ structure is passed to this parameter. Refer to M_EVENT_REQ for details. Example Refer to Interrupt Event for details. 74

75 4.3 Structure M_EVENT_REQ The M_EVENT_REQ structure is used to register interrupt events. typedef struct _M_EVENT_REQ{ HANDLE Signal; HWND Wnd; UINT Msg; LPMALLBAK allbackproc; PVOID User; } M_EVENT_REQ, *PM_EVENT_REQ; Type M_EVENT_REQ Signal As Long Wnd As Long Msg As Long allbackproc As Long User As Long End Type [StructLayout(LayoutKind.Sequential)] public struct M_EVENT_REQ { public IntPtr Signal; putlic IntPtr Wnd; public int Msg; public IntPtr allbackproc; putlib IntPtr User; }.NET <StructLayout(LayoutKind.Sequential)> Structure M_EVENT_REQ Dim Signal As IntPtr Dim Wnd As IntPtr Dim Msg As Integer Dim allbackproc As IntPtr Dim User As IntPtr End Structure 75

76 Member Signal 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, 0 for, and IntPtr.Zero for and.net. Wnd 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, 0 for, and IntPtr.Zero for and.net. Msg 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, and 0 for,, and.net. allbackproc The member points to a callback function to be called when an interrupt event is generated. The callback function is supported only in. Specify 0 for, and IntPtr.Zero for and.net. When you do not use the callback function in, specify NULL. User 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, and IntPtr.Zero for and.net. 76

77 4.3.2 M_BAT_INFO The M_BAT_INFO structure is used to retrieve information of the battery module. typedef struct _M_BAT_INFO{ float Temp; float Voltage; int urrent; int Avgurrent; UINT Relharge; UINT Fullapacity; UINT Designapacity; float PowerTemp; UINT RelPower; } M_BAT_INFO, *PM_BAT_INFO; Type M_BAT_INFO Temp Voltage urrent Avgurrent Relharge Fullapacity Designapacity PowerTemp RelPower End Type As Single As Single As Long As Long As Long As Long As Long As Single As Long [StructLayout(LayoutKind.Sequential)] public struct M_BAT_INFO { public float Temp; public float Voltage; public int urrent; public int Avgurrent; public uint Relharge; public uint Fullapacity; public uint Designapacity; public float PowerTemp; public uint RelPower; }.NET <StructLayout(LayoutKind.Sequential)> Structure M_BAT_INFO Dim Temp As Single Dim Voltage As Single Dim urrent As Integer Dim Avgurrent As Integer Dim Relharge As Integer Dim Fullapacity As Integer Dim Designapacity As Integer Dim PowerTemp As Single Dim RelPower As Integer End Structure 77

78 Member Temp The member specifies the battery temperature. The unit is degrees. Voltage The member specifies a measured voltage of the battery module. The unit is V. urrent The member specifies a measured current of the battery module. The unit is ma. When the battery module discharges, the sign of current is negative. Avgurrent The member specifies an average of measured current of the battery module. The unit is ma. When the battery module discharges, the sign of current is negative. Relharge The member specifies a charge level of the battery module. The unit is %. It is a relative value to Fullapacity. Fullapacity The member specifies a learning capacity of the battery module. The unit is mah. The value is the maximum capacity that the battery module can have at this time in consideration of the learning result of discharge, lifetime, and so on. Designapacity The member specifies the nominal capacity of the battery module. The unit is mah. PowerTemp Reserved. Ignore the value. RelPower Reserved. Ignore the value. 78

79 4.3.3 M_BAT_HISTORY The M_BAT_HISTORY structure is used to retrieve a history of the battery module. typedef struct _M_BAT_HISTORY{ UINT TotalRunTime; UINT Disount; UINT Disapacity; UINT Temp_10; UINT Temp10_19; UINT Temp20_29; UINT Temp30_39; UINT Temp40_49; UINT Temp50_59; UINT Temp60_69; UINT Temp70_; } M_BAT_HISTORY, *PM_BAT_HISTORY; Type M_BAT_HISTORY TotalRunTime As Long Disount As Long Disapacity As Long Temp_10 As Long Temp10_19 As Long Temp20_29 As Long Temp30_39 As Long Temp40_49 As Long Temp50_59 As Long Temp60_69 As Long Temp70_ As Long End Type [StructLayout(LayoutKind.Sequential)] public struct M_BAT_HISTORY { public uint TotalRunTime; public uint Disount; public uint Disapacity; public uint Temp_10; public uint Temp10_19; public uint Temp20_29; public uint Temp30_39; public uint Temp40_49; public uint Temp50_59; public uint Temp60_69; public uint Temp70_; } 79

80 .NET <StructLayout(LayoutKind.Sequential)> Structure M_BAT_HISTORY Dim TotalRunTime As Integer Dim Disount As Integer Dim Disapacity As Integer Dim Temp_10 As Integer Dim Temp10_19 As Integer Dim Temp20_29 As Integer Dim Temp30_39 As Integer Dim Temp40_49 As Integer Dim Temp50_59 As Integer Dim Temp60_69 As Integer Dim Temp70_ As Integer End Structure Member TotalRunTime Disount Disapacity Temp_10 Temp10_19 Temp20_29 Temp30_39 Temp40_49 Temp50_59 Temp60_69 Temp70_ The member shows the total operating time of the battery module. The unit is hour (h). The member shows the number of power failures. The count increases when the battery recovers from power failure. The member shows discharging capacity when power failure occurs. The unit is mah. The value increases while the battery is discharging. When the battery becomes charged status, the value shows a total discharge capacity of the last power failure. The member shows the accumulated time while a temperature T of the battery module satisfies that T < 10 degrees. The unit is hour (h). The member shows the accumulated time while a temperature T of the battery module satisfies that 10 <= T <20 degrees. The unit is hour (h). The member shows the accumulated time while a temperature T of the battery module satisfies that 20 <= T <30 degrees. The unit is hour (h). The member shows the accumulated time while a temperature T of the battery module satisfies that 30 <= T <40 degrees. The unit is hour (h). The member shows the accumulated time while a temperature T of the battery module satisfies that 40 <= T <50 degrees. The unit is hour (h). The member shows the accumulated time while a temperature T of the battery module satisfies that 50 <= T <60 degrees. The unit is hour (h). The member shows the accumulated time while a temperature T of the battery module satisfies that 60 <= T <70 degrees. The unit is hour (h). The member shows the accumulated time while a temperature T of the battery module satisfies that 70 degrees <= T. The unit is hour (h). 80

81 4.4 Return Values Error ode Value omments/solutions IFM_ERROR_SUESS 0 Successful completion - IFM_ERROR_INTERNAL h ( ) Internal error Internal error during hardware control. ontact and tell us how the error occurred. IFM_ERROR_INVALID _PARAMETER h ( ) Invalid input parameter heck the configurable range to configure parameters. IFM_ERROR_ALREADY IFM_ERROR_NOT_YET IFM_ERROR_NULL_POINTER IFM_ERROR_NOT_ALLOATE IFM_ERROR_INVALID _HANDLE IFM_ERROR_NOT_SUPPORT h ( ) h ( ) h ( ) h ( ) h ( ) h ( ) - 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 - 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. heck that IFPMGR is running normally with Device Manager. The function is not supported. Refer to the manual to check the function is supported or 2.1 Functional Specifications. 81

82 hapter 5 Reference for Pentium M/eleron M Model 5.1 List of DLL Function This software contains the following functions. Available functions differ depending on product models. No. Function A *1 B *1 *1 D *1 E *1 <PU control > 1 IfpuSetpulock onfigures an operating frequency of the PU. *2 2 IfpuGetpulock Retrieves an operating frequency of the PU. *2 3 IfpuSetpulkDuty onfigures a clock duty ratio of the PU 4 IfpuGetpulkDuty Retrieves a clock duty ratio of the PU <RAS control> 5 IfRasGetpuTmp Measures a temperature of the PU. 6 IfRasGetVolt3 Measures a voltage of the bus (+3.3 Vdc) IfRasGetVolt5 Measures a voltage of the bus (+5 Vdc) IfRasGetVolt12 Measures a voltage of the bus (+12 Vdc) IfRasWdtEnable Enables the WDT 10 IfRasWdtlear lears the WDT 11 IfRasWdtDisable Disables the WDT 12 IfhipGetounterI Retrieves a count value of the H4 counter on the chipset. <Slot-in Power Supply module > 13 IfPsmGetModuleId Retrieves IDs of slot-in power supply modules installed in the power supply backplane IfPsmGetStatus Retrieves statuses of slot-in power supply modules installed in the power supply backplane. - - Note: *1 : Supported -: Not supported A: Long-Term Supply Industrial ontroller Atom N2800 model B: Long-Term Supply Industrial ontroller Atom model (N2800 excluded) : Long-Term Supply Industrial ontroller ore i7/eleron models D: Slot-in Industrial ontroller Atom model E: Slot-in Industrial ontroller ore i7/eleron model *2 These functions are not available in the Atom D525 model. 82

83 5.1.1 IfpuSetpulock The IfpuSetpulock function configures an operating frequency of the PU (the SpeedStep function). This function is not supported in the Atom D525 models. Syntax BOOL IfpuSetpulock( int stepno Declare Function IfpuSetpulock Lib "IFWINRP.DLL"( _ ByVal stepno As Long, _ )As Long [DllImport("ifwincrp.dll")] public static extern bool IfpuSetpulock( int stepno.net Declare Function IfpuSetpulock Lib "ifwincrp.dll"(_ ByVal stepno As Integer, _ )As Boolean Parameters stepno The parameter specifies a step number. Step PU Operating Frequency (unit: GHz) Number ATOM N2800 Atom N450 Atom Z530 ore i7 620UE ore i7 610E ore i5 520E eleron P4505 eleron U

84 Return Values Step PU Operating Frequency (unit: GHz) Number ore i5 2515E ore i7 3517UE eleron 807UE ore i7 2610UE This function returns TRUE (non-zero value) when it is successfully completed. Otherwise, it returns FALSE (0). Get details by using the GetLastError function of Win32API if the function returns FALSE (0). The GetLastError function returns one of the following values. ode Value IFWIN_ERROR_GET_PUINFO E h PU information retrieval error IFWIN_ERROR_NOT_SUPPORTED E h Unsupported system IFWIN_ERROR_ALL_DRIVER E h Driver call error omments When a step number is out of the range, the function automatically selects the maximum available step number. For example, when 3 is specified to the step number for the Atom N450 PU, the function automatically selects 1 as the step number. Example Setting the PU step number to 1. BOOL Ret; Ret = IfpuSetpulock(1 Dim Ret As Long Ret = IfpuSetpulock(1) bool Ret; Ret = IFWINRP.IfpuSetpulock(1.NET Dim Ret As Boolean Ret = IFWINRP.IfpuSetpulock(1) 84

85 5.1.2 IfpuGetpulock The IfpuGetpulock function retrieves an operating frequency of the PU (the SpeedStep function). Syntax BOOL IfpuGetpulock( int* hz Declare Function IfpuGetpulock Lib "IFWINRP.DLL"( _ ByRef hz As Long _ )As Long [DllImport("ifwincrp.dll")] public static extern bool IfpuGetpulock( out int hz.net Declare Function IfpuGetpulock Lib "ifwincrp.dll"(_ ByRef hz As Integer _ )As Boolean Parameters hz The parameter points to a variable to receive an operating frequency of the PU. The unit is MHz. The value may have an error that ranges a few MHz. Return Values This function returns TRUE (non-zero value) when it is successfully completed. Otherwise, it returns FALSE (0). Get details by using the GetLastError function of Win32API if the function returns FALSE (0). The GetLastError function returns one of the following values. ode Value IFWIN_ERROR_GET_PUINFO E h PU information retrieval error IFWIN_ERROR_INVALID_PARAM E h NULL pointer specified IFWIN_ERROR_NOT_SUPPORTED E h Unsupported system IFWIN_ERROR_ALL_DRIVER E h Driver call error 85

86 Example Retrieving the PU frequency. BOOL Ret; int hz; Ret = IfpuGetpulock(&hz Dim Ret As Long Dim hz As Long Ret = IfpuGetpulock(hz) bool Ret; int hz; Ret = IFWINRP.IfpuGetpulock(out hz.net Dim Ret As Boolean Dim hz As Integer Ret = IFWINRP.IfpuGetpulock(hz) 86

87 5.1.3 IfpuSetpulkDuty The IfpuSetpulkDuty function configures a clock duty ratio of the PU. Syntax BOOL IfpuSetpulkDuty( int dutyno Declare Function IfpuSetpulkDuty Lib "IFWINRP.DLL"( _ ByVal dudyno As Long, _ )As Long [DllImport("ifwincrp.dll")] public static extern bool IfpuSetpulkDuty( int dutyno.net Declare Function IfpuSetpulkDuty Lib "ifwincrp.dll"(_ ByVal dutyno As Integer, _ )As Boolean Parameter dutyno The parameter specifies a clock duty ratio of the PU. Value % % % % % % % % If a specified value is out of the range, the function sets 8 (100 %). Return Values This function returns TRUE (non-zero value) when it is successfully completed. Otherwise, it returns FALSE (0). Get details by using the GetLastError function of Win32API if the function returns FALSE (0). The GetLastError function returns one of the following values. ode Value IFWIN_ERROR_NOT_SUPPORTED E h Unsupported system IFWIN_ERROR_ALL_DRIVER E h Driver call error omment For the ore i7 model, this function is available only when HT (hyper threading) is enabled. 87

88 Example onfiguring the PU clock duty ratio to 50 %. BOOL Ret; Ret = IfpuSetpulkDuty(4 Dim Ret As Long Ret = IfpuSetpulkDuty(4) bool Ret; Ret = IFWINRP.IfpuSetpulkDuty(4.NET Dim Ret As Boolean Ret = IFWINRP.IfpuSetpulkDuty(4) 88

89 5.1.4 IfpuGetpulkDuty The IfpuGetpulkDuty function retrieves a clock duty ratio of the PU. Syntax BOOL IfpuGetpulkDuty( int* dutyno Declare Function IfpuGetpulkDuty Lib "IFWINRP.DLL"( _ ByRef dutyno As Long _ )As Long [DllImport("ifwincrp.dll")] public static extern bool IfpuGetpulkDuty( out int dutyno Declare Function IfpuGetpulkDuty Lib "ifwincrp.dll"(_ ByRef dutyno As Integer _ )As Boolean Parameter dutyno The parameter points to a variable to receive a clock duty ratio of the PU. Value % % % % % % % % Return Values This function returns TRUE (non-zero value) when it is successfully completed. Otherwise, it returns FALSE (0). Get details by using the GetLastError function of Win32API if the function returns FALSE (0). The GetLastError function returns one of the following values. ode Value IFWIN_ERROR_INVALID_PARAM E h NULL pointer specification IFWIN_ERROR_NOT_SUPPORTED E h Unsupported system IFWIN_ERROR_ALL_DRIVER E h Driver call error omment For the ore i7 model, this function is available only when HT (hyper threading) is enabled. 89

90 Example Retrieving clock duty ratio BOOL Ret; int dutyno; Ret = IfpuGetpulkDuty(&dutyno Dim Ret As Long Dim dutyno As Long Ret = IfpuGetpulkDuty(dutyno) bool Ret; int dutyno; Ret = IFWINRP.IfpuGetpulkDuty(out dutyno.net Dim Ret As Boolean Dim dutyno As Integer Ret = IFWINRP.IfpuGetpulkDuty(dutyno) 90

91 5.1.5 IfRasGetpuTmp The IfRasGetpuTmp function measures a temperature of the PU. Syntax BOOL IfRasGetpuTmp( float* temp Declare Function IfRasGetpuTmp Lib "IFWINRP.DLL"( _ ByRef temp As Single _ )As Long [DllImport("ifwincrp.dll")] public static extern bool IfRasGetpuTmp( out float temp.net Declare Function IfRasGetpuTmp Lib "ifwincrp.dll"(_ ByRef temp As Single _ )As Boolean Parameters temp The parameter points to a variable to receive a measured temperature of the PU (or PU1 for Atom N2800, Atom D525 and ore i7/eleron models). Return Values This function returns TRUE (non-zero value) when it is successfully completed. Otherwise, it returns FALSE (0). Get details by using the GetLastError function of Win32API if the function returns FALSE (0). The GetLastError function returns one of the following values. ode Value IFWIN_ERROR_GET_PUTEMP E h PU temperature retrieval error IFWIN_ERROR_INVALID_PARAM E h NULL pointer specified IFWIN_ERROR_NOT_SUPPORTED E h Unsupported system IFWIN_ERROR_ALL_DRIVER E h Driver call error 91

92 Example Retrieving the PU temperature BOOL Ret; float temp; Ret = IfRasGetpuTmp(&temp Dim Ret As Long Dim temp As Single Ret = IfRasGetpuTmp(temp) bool Ret; float temp; Ret = IFWINRP.IfRasGetpuTmp(out temp.net Dim Ret As Boolean Dim temp As Single Ret = IFWINRP.IfRasGetpuTmp(temp) 92

93 5.1.6 IfRasGetVolt3 The IfRasGetVolt3 function measures a voltage of the bus (+3.3 Vdc). Syntax BOOL IfRasGetVolt3( float* volt Declare Function IfRasGetVolt3 Lib "IFWINRP.DLL"( _ ByRef volt As Single _ )As Long [DllImport("ifwincrp.dll")] public static extern bool IfRasGetVolt3( out float volt.net Declare Function IfRasGetVolt3 Lib "ifwincrp.dll"(_ ByRef volt As Single _ )As Boolean Parameters volt The parameter points to a variable to receive a measured voltage of the bus (+3.3 Vdc). Return Values This function returns TRUE (non-zero value) when it is successfully completed. Otherwise, it returns FALSE (0). Get details by using the GetLastError function of Win32API if the function returns FALSE (0). The GetLastError function returns one of the following values. ode Value IFWIN_ERROR_GET_BUSVOLT E h Bus voltage retrieval error IFWIN_ERROR_INVALID_PARAM E h NULL pointer specified IFWIN_ERROR_NOT_SUPPORTED E h Unsupported system IFWIN_ERROR_ALL_DRIVER E h Driver call error 93

94 Example Retrieving the bus voltage (+3.3 Vdc) BOOL Ret; float volt; Ret = IfRasGetVolt3(&volt Dim Ret As Long Dim volt As Single Ret = IfRasGetVolt3(volt) bool Ret; float volt; Ret = IFWINRP.IfRasGetVolt3(out volt.net Dim Ret As Boolean Dim volt As Single Ret = IFWINRP.IfRasGetVolt3(volt) 94

95 5.1.7 IfRasGetVolt5 The IfRasGetVolt5 function measures a voltage of the bus (+5 Vdc). Syntax BOOL IfRasGetVolt5( float* volt Declare Function IfRasGetVolt5 Lib "IFWINRP.DLL"( _ ByRef volt As Single _ )As Long [DllImport("ifwincrp.dll")] public static extern bool IfRasGetVolt5( out float volt.net Declare Function IfRasGetVolt5 Lib "ifwincrp.dll"(_ ByRef volt As Single _ )As Boolean Parameters volt This parameter points to a variable to receive a voltage of the bus (+ 5 Vdc) Return Values This function returns TRUE (non-zero value) when it is successfully completed. Otherwise, it returns FALSE (0). Get details by using the GetLastError function of Win32API if the function returns FALSE (0). The GetLastError function returns one of the following values. ode Value IFWIN_ERROR_GET_BUSVOLT E h Bus voltage retrieval error IFWIN_ERROR_INVALID_PARAM E h NULL pointer specified IFWIN_ERROR_NOT_SUPPORTED E h Unsupported system IFWIN_ERROR_ALL_DRIVER E h Driver call error 95

96 Example Retrieving the bus voltage (+5 Vdc) BOOL Ret; float volt; Ret = IfRasGetVolt5(&volt Dim Ret As Long Dim volt As Single Ret = IfRasGetVolt5(volt) bool Ret; float volt; Ret = IFWINRP.IfRasGetVolt5(out volt.net Dim Ret As Boolean Dim volt As Single Ret = IFWINRP.IfRasGetVolt5(volt) 96

97 5.1.8 IfRasGetVolt12 The IfRasGetVolt12 function measures a voltage of the bus (+12 Vdc). This function is applicable only to Long-Term Supply Industrial ontrollers. Syntax BOOL IfRasGetVolt12( float* volt Declare Function IfRasGetVolt12 Lib "IFWINRP.DLL"( _ ByRef volt As Single _ )As Long [DllImport("ifwincrp.dll")] public static extern bool IfRasGetVolt12( out float volt.net Declare Function IfRasGetVolt12 Lib "ifwincrp.dll"(_ ByRef volt As Single _ )As Boolean Parameters volt This parameter points to a variable to receive a measured voltage of the bus (+12 Vdc). Return Values This function returns TRUE (non-zero value) when it is successfully completed. Otherwise, it returns FALSE (0). Get details by using the GetLastError function of Win32API if the function returns FALSE (0). The GetLastError function returns one of the following values. ode Value IFWIN_ERROR_GET_BUSVOLT E h Bus voltage retrieval error IFWIN_ERROR_INVALID_PARAM E h NULL pointer specified IFWIN_ERROR_NOT_SUPPORTED E h Unsupported system IFWIN_ERROR_ALL_DRIVER E h Driver call error 97

98 Example Retrieving the bus voltage (+12 Vdc) BOOL Ret; float volt; Ret = IfRasGetVolt12(&volt Dim Ret As Long Dim volt As Single Ret = IfRasGetVolt12(volt) bool Ret; float volt; Ret = IFWINRP.IfRasGetVolt12(out volt.net Dim Ret As Boolean Dim volt As Single Ret = IFWINRP.IfRasGetVolt12(volt) 98

99 5.1.9 IfRasWdtEnable The IfRasWdtEnable function enables the WDT. The time-out time of the WDT is fixed to 10 seconds. If the WDT is not cleared within 10 seconds, the WDT restarts the system. Syntax BOOL IfRasWdtEnable(void Declare Function IfRasWdtEnable Lib "IFWINRP.DLL"() As Long [DllImport("ifwincrp.dll")] public static extern bool IfRasWdtEnable(.NET Declare Function IfRasWdtEnable Lib "ifwincrp.dll"() As Boolean Parameters None Return Values This function returns TRUE (non-zero value) when it is successfully completed. Otherwise, it returns FALSE (0). Get details by using the GetLastError function of Win32API if the function returns FALSE (0). The GetLastError function returns one of the following values. ode Value IFWIN_ERROR_INVALID_PARAM E h WDT is running. IFWIN_ERROR_NOT_SUPPORTED E h Unsupported system IFWIN_ERROR_ALL_DRIVER E h Driver call error omment If the WDT is running, this function returns FALSE. Example Enabling WDT BOOL Ret; Ret = IfRasWdtEnable( Dim Ret As Long Ret = IfRasWdtEnable() bool Ret; Ret = IFWINRP.IfRasWdtEnable(.NET Dim Ret As Boolean Ret = IFWINRP.IfRasWdtEnable() 99

100 IfRasWdtlear The IfRasWdtlear function clears the WDT. Syntax BOOL IfRasWdtlear(void Declare Function IfRasWdtlear Lib "IFWINRP.DLL"() As Long [DllImport("ifwincrp.dll")] public static extern bool IfRasWdtlear(.NET Declare Function IfRasWdtlear Lib "ifwincrp.dll"() As Boolean Parameters None Return Values This function returns TRUE (non-zero value) when it is successfully completed. Otherwise, it returns FALSE (0). Get details by using the GetLastError function of Win32API if the function returns FALSE (0). The GetLastError function returns one of the following values. ode Value IFWIN_ERROR_INVALID_PARAM E h WDT is not running IFWIN_ERROR_NOT_SUPPORTED E h Unsupported system IFWIN_ERROR_ALL_DRIVER E h Driver call error omment If the WDT is not running, this function returns FALSE. Example learing WDT BOOL Ret; Ret = IfRasWdtlear( Dim Ret As Long Ret = IfRasWdtlear() bool Ret; Ret = IFWINRP.IfRasWdtlear(.NET Dim Ret As Boolean Ret = IFWINRP.IfRasWdtlear() 100

101 IfRasWdtDisable The IfRasWdtDisable function disables the WDT. Syntax BOOL IfRasWdtDisable(void Declare Function IfRasWdtDisable Lib "IFWINRP.DLL"() As Long [DllImport("ifwincrp.dll")] public static extern bool IfRasWdtDisable(.NET Declare Function IfRasWdtDisable Lib "ifwincrp.dll"() As Boolean Parameters None Return Values This function returns TRUE (non-zero value) when it is successfully completed. Otherwise, it returns FALSE (0). Get details by using the GetLastError function of Win32API if the function returns FALSE (0). The GetLastError function returns one of the following values. ode Value IFWIN_ERROR_INVALID_PARAM E h WDT is not running IFWIN_ERROR_NOT_SUPPORTED E h Unsupported system IFWIN_ERROR_ALL_DRIVER E h Driver call error omment If WDT is not running, this function returns an error. Example Disabling WDT BOOL Ret; Ret = IfRasWdtDisable( Dim Ret As Long Ret = IfRasWdtDisable() bool Ret; Ret = IFWINRP.IfRasWdtDisable(.NET Dim Ret As Boolean Ret = IFWINRP.IfRasWdtDisable() 101

102 IfhipGetounterIH4 The IfhipGetounterIH4 function retrieves a count value of the counter on the chipset. The counter length is 24 bits and the clock frequency is MHz. Syntax DWORD IfhipGetounerIH4(void Declare Function IfhipGetounerIH4 Lib "IFWINRP.DLL"() As Long [DllImport("ifwincrp.dll")] public static extern uint IfhipGetounerIH4(.NET Declare Function IfhipGetounerIH4 Lib "ifwincrp.dll"() As Integer Parameters None Return Values This function returns counter value from 0 through 00FFFFFFh when it is successfully completed. Otherwise, it returns FFFFFFFFh. Get details by using the GetLastError function of Win32API if the function returns FFFFFFFFh. The GetLastError function returns one of the following values. ode Value IFWIN_ERROR_NOT_SUPPORTED E h Unsupported system IFWIN_ERROR_ALL_DRIVER E h Driver call error Example Retrieving the current counter value DWORD ount; ount = IfhipGetounterIH4( Dim ount As Long ount = IfhipGetounterIH4() uint ount; ount = IFWINRP.IfhipGetounterIH4(.NET Dim ount As Integer ount = IFWINRP.IfhipGetounterIH4() 102

103 IfPsmGetModuleId The IfPsmGetModuleId function retrieves IDs of slot-in power supply modules installed in the power supply backplane. Syntax BOOL IfPsmGetModuleId( WORD* ModuleId Declare Function IfPsmGetModuleId Lib "IFWINRP.DLL"( _ ByRef ModuleId As Integer _ )As Long [DllImport("ifwincrp.dll")] public static extern bool IfPsmGetModuleId( out ushort ModuleId [DllImport("ifwincrp.dll")] public static extern bool IfPsmGetModuleId( ushort[] ModuleId.NET Declare Function IfPsmGetModuleId Lib "ifwincrp.dll"(_ ByRef ModuleId As Short _ )As Boolean Parameters ModuleId The parameter points to an array to receive IDs of slot-in power supply modules. Prepare an array that has 4 or more elements. Array pmoduleid[0] ID of the slot-in power supply module installed in the P1 slot pmoduleid[1] ID of the slot-in power supply module installed in the P2 slot pmoduleid[2] ID of the slot-in power supply module installed in the P3 slot pmoduleid[3] ID of the slot-in power supply module installed in the P4 slot The index number of the array corresponds to a number that is given by subtracting one from the P number (silk number) printed on the power supply backplane. 103

104 Return Values The IDs are defined as follows ID Model 05h JPS Vdc input module (isolated, 80 W) 06h JPS Vdc input module (isolated, 80 W) 08h JPS-2101 ATX output module (100 W) 09h JPS Vac/200 Vac input module (isolated, 130 W) 0Ah JPS Vdc input module (isolated, 130 W) 0Bh JPS Vdc input module (isolated, 130 W) 0h JPS ~ +24 Vdc input module (non-isolated, 130 W) 0Dh JPS Vdc input module for +12 Vdc power supply bus (non-isolated, 50 W) 0Eh JPS JPS Vdc input module (non-isolated, 150 W) +24 Vdc input module (isolated,150 W) * JPS and JPS have the same ID. 0Fh Uninstalled No slot-in power supply module is installed. This function returns TRUE (non-zero value) when it is successfully completed. Otherwise, it returns FALSE (0). Get details by using the GetLastError function of Win32API if the function returns FALSE (0). The GetLastError function returns one of the following values. ode Value IFWIN_ERROR_GET_PSMMODULEID E h Slot-in power supply module ID retrieval error IFWIN_ERROR_INVALID_PARAM E h NULL pointer specification IFWIN_ERROR_NOT_SUPPORTED E h Unsupported system IFWIN_ERROR_ALL_DRIVER E h Driver call error Example Retrieving a slot-in power supply module ID. UINT Ret; WORD ModuleId[4]; Ret = IfPsmGetModuleId(&ModuleId[0], 4 Dim Ret As Long Dim ModuleId(3) As Long Ret = IfPsmGetModuleId(ModuleId(0), 4) uint Ret; uint[] ModuleId = new uint[4]; Ret = IFWINRP.IfPsmGetModuleId(ModuleId, 4.NET Dim Ret As Integer Dim ModuleId(3) As Integer Ret = IFWINRP.IfPsmGetModuleId(ModuleId(0), 4) 104

105 IfPsmGetStatus The IfPsmGetStatus function retrieves statuses of slot-in power supply modules installed in the power supply backplane. Syntax BOOL IfPsmGetStatus( WORD* Status Declare Function IfPsmGetStatus Lib "IFWINRP.DLL"( _ ByRef Status As Integer _ )As Long [DllImport("ifwincrp.dll")] public static extern bool IfPsmGetStatus( out ushort Status [DllImport("ifwincrp.dll")] public static extern bool IfPsmGetStatus( ushort[] Status.NET Declare Function IfPsmGetStatus Lib "ifwincrp.dll"(_ ByRef Status As Short _ )As Boolean Parameters pstatus The parameter points to an array to receive statuses of slot-in power supply modules. Prepare an array that has 4 or more elements. Array Status[0] Status of the slot-in power supply module installed in the P1 slot Status[1] Status of the slot-in power supply module installed in the P2 slot Status[2] Status of the slot-in power supply module installed in the P3 slot Status[3] Status of the slot-in power supply module installed in the P4 slot The index number of the array corresponds to a number that is given by subtracting one from the P number (silk number) printed on the power supply backplane. The following values are stored in each element when an error is detected. When no error is detected, 0 is stored in each element. One or more values may be ORed. ode Value M_PSM_STATUS_DEG 01h Alarm (ALM signal detection) M_PSM_STATUS_FAL 02h Fail (FAIL signal detection) 105

106 Return Values This function returns TRUE (non-zero value) when it is successfully completed. Otherwise, it returns FALSE (0). Get details by using the GetLastError function of Win32API if the function returns FALSE (0). The GetLastError function returns one of the following values. ode Value IFWIN_ERROR_GET_PSMMODULEID E h Slot-in power supply module ID retrieval error IFWIN_ERROR_INVALID_PARAM E h NULL pointer specification IFWIN_ERROR_NOT_SUPPORTED E h Unsupported system IFWIN_ERROR_ALL_DRIVER E h Driver call error Example Retrieving statuses of the slot-in power supply modules. UINT Ret; WORD Status[4]; Ret = IfPsmGetStatus(&Status[0] Dim Ret As Long Dim Status(3) As Long Ret = IfPsmGetStatus(Status(0)) uint Ret; uint[] Status = new uint[4]; Ret = IFWINRP.IfPsmGetStatus(Status.NET Dim Ret As Integer Dim Status(3) As Integer Ret = IFWINRP.IfPsmGetStatus(Status(0)) 106

107 hapter 6 Sample Programs 6.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 or.net,.net Framework 1.1 or later version is required. (event_clr for Visual ++.NET requires 2.0 or later versions.) Visual 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 ++.NET 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. 1. Start. 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. *1 4. Build the project file. 5. Run the executable file, *.exe..net 1. Start Visual Studio. 2. Select File > Open > Project. 3. Open the project file, *.vbproj. *1 4. Build the project file. 5. Run the executable file, *.exe. Note: *1 The class library will be automatically built at the same time. 107

108 6.2 List of Sample Programs Sample program wdt The sample program configures a time-out time of the WDT to 5 seconds and an action of the time-out to PU 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 the PU and PB every 3 seconds. The sample program exits after it displays the temperatures of the PU and PB 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 event of the WDT by signaling an event, calling a callback function (applicable only in Visual ++), and posting a message. The sample program works as follows: - set a time-out time of the WDT to 3 seconds 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 function by the allback button. - register a message handler with the Message button. - execute post-processes such as event release with the Kill Event button. Note: For Visual ++ users, sample programs of MF (event_mfc) and LR (event_clr) are provided. LR is applicable to Visual or later versions. pbfilter The sample program configures the error protection filter of the power button. The sample program enables the filter, and then disables it. led The sample program configures the error conditions to blink the LED, then 5 second later, disable the error conditions. fan The sample program retrieves and displays the operating status of the PU fan every 3 seconds. The program exits after it displays the status 5 times. Note: Only products with a PU fan support this sample program. psm The sample program retrieves and displays the status of a slot-in power supply module every 3 seconds. The program exits after it displays the status 5 times. bat The sample program retrieves and displays the information of the battery module. The program exits after it displays the information 5 times and history information. 108

109 hapter 7 Utility Program 7.1 Interface Utility Interface Utility provides the following operations. *.NET Framework 2.0 or later is required to use Interface Utility. Log - Monitoring log information - onfiguring a log file WDT - Enabling/disabling log recording of the WDT - hecking 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 Fan - hecking the statuses of the fans - Enabling/disabling log recording of the fans Button filter - onfiguring the one second error protection filter for the power button LED - Setting the blink condition when the temperature of the PB is over the upper limit. - Setting the blink condition when the temperature of the PB is below the lower limit. - Setting the blink condition when a fan has an error. PowerModule - Enabling/disabling log recording of the power supply modules - Monitoring the slot-in power supply modules Battery - Enabling/disabling log recording of the battery module - Monitoring information and history of the battery module - onfiguring the termination method of the operating system at power failure and the duration of discharge. 109

110 7.1.1 Starting the Utility This utility starts automatically 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 interface\ifpmgr\bin folder ommands Right click Interface Utility icon in the system tray to open the command menu. ommand Open Exit 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 Functions The pictures displayed on your screen may be different from the pictures below depending on the model you use. 1. Log lick the Log tab to open the following dialog box. 110

111 Item Monitor By clicking the Monitor button, the following Log Monitor window appears. You can execute any other processes even when the Log Monitor window opens. File No save New records are appended at the bottom of the text box. Item Log File The path of a log file appears in the Log File box.no path appear when log recording is disabled. The records displayed in the text box are saved in the log file. lear lick lear to delete the records in the text box. The records in the log file on the disk will not be deleted. lose lick lose to close the Log Monitor window. The File area specifies a log file to be saved. lick OK or Apply to save the changes. The logs can be displayed on the Log Monitor window without saving the log file. * Administrator privileges are required to save the settings. No log file is saved. 111

112 Item No log limit Log records are appended in the existing log file. lick [ ] 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. lick the OK or Apply button to start to save log records in the log file. 112

113 Item New file every day 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 currently used log file appears in the Log window. lick [ ] to specify a folder where the log files are saved. The path of the folder appears in the Folder box. OK ancel Apply Help lick OK or Apply to start to save log records in the log file. lick OK to save the changes and close the window. lick ancel to discard the changes and close the window. lick Apply to save the changes. The window will not be closed. lick Help to open the Help file of System Monitoring Library. 113

114 2. WDT lick the WDT tab to open the following dialog box. Item Enable WDT Select Enable WDT log to enable to output log records of the WDT. log The log information includes; - start/stop of the WDT, - change of time-out time and action change, - WDT interrupt generation. lick OK or Apply to save the changes. Note: If setting change and WDT start/stop are successively executed at a short interval, not all the log may be output. * Administrator privileges are required to save the settings. Status This item shows the operating status of the WDT. -STOP: WDT stops. - RUN: WDT is running. onfig This item configures the time-out time and action at the time-out of the WDT. lick OK or Apply to save the changes. ycle This item configures the WDT cycle. The configurable range is from 1 through 255. Action This item configures the action when the time-out occurs. - Reset: Reset the PU - Interrupt: An interrupt occurs ontrol The ontrol area includes the following commands to control the WDT. Start lick Start to start the WDT. Stop lick Stop to stop the WDT. lear lick lear to clear the WDT. OK lick OK to save the changes and close the window. ancel lick ancel to discard the changes and close the window. Apply lick Apply to save the changes. The window will not be closed. Help lick Help to open the Help file of System Monitoring Library. 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. 114

115 3. Temperature lick the Temperature tab to open the following dialog box. <Atom model> Item Enable temperature log Temperature log cycle Select Enable temperature log 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). lick 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. * Administrator privileges are required to save the settings. 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 if the check box is cleared. lick OK or Apply to save the changes. * Administrator privileges are required to save the settings. 115

116 PU Board Item Upper Limit Lower Limit History graph urrent temperature Upper Limit Lower Limit History graph urrent temperature OK ancel Apply Help (ontinued) The PU area contains information of the PU temperature. lick OK or Apply to save the changes For Atom N2800 and Atom D525 models, temperatures of two cores are shown. The left is PU core 1 and the other is PU core 2. Enter the upper-limit temperature in Upper Limit. Enter the lower-limit temperature in Lower Limit. The graph shows a trend of PU temperature. olors 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 PU 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 PB temperature. lick 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 PB temperature. olors 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 PB 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 lick OK to save the changes and close the window. lick ancel to discard the changes and close the window. lick Apply to save the changes. The window will not be closed. lick Help to open the Help file of System Monitoring Library. 116

117 <ore i7/eleron models> Item Enable temperature log 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 check box is selected). lick 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. * Administrator privileges are required to save the settings. Temperature log cycle Select Temperature log cycle check box 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 if the check box is cleared. lick OK or Apply to save the changes. * Administrator privileges are required to save the settings. PU The item shows PU temperature. lick the OK or Apply button to reflect the upper-limit/lower-limit temperature. The left is PU core 1, and the other is PU core 2. History graph The graph shows a trend of PU temperature. olors of the line indicate the temperature ranges. Higher than100 degrees : red High temperature: orange Medium temperature: yellow-green Low temperature: light blue Lower than 0 degrees : white urrent The current PU temperature is shown under the graph. temperature olors of the value indicate the temperature ranges. Higher than100 degrees : red High temperature: orange Medium temperature: yellow-green Low temperature: blue Lower than 0 degrees : black 117

118 Board Item Upper Limit Lower Limit History graph urrent temperature Memory History graph urrent temperature OK ancel Apply Help (ontinued) The Board area contains information of the PB temperature. lick OK or Apply to save the changes Type the upper-limit temperature in Upper Limit. Type the lower-limit temperature in Lower Limit. The graph shows a trend of the PB temperature. olors 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 PB 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 memory area shows temperature around memory. lick the OK or Apply button to reflect the upper-limit/lower-limit temperature. The graph shows a trend of temperature around memory. olors 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 lower-limit temperature: white The current temperature around memory is shown under the graph. Higher than the upper-limit temperature: red High temperature: orange Medium temperature: green Lowe temperature: blue Lower than lower-limit temperature: black lick OK to save the changes and close the window. lick ancel to discard the changes and close the window. lick Apply to save the changes The window will not be closed. lick Help to open the Help file of System Monitoring Library. When abnormal temperature is detected, the following massage appears on the icon in the system tray. Example: The board temperature is over the upper limit temperature. When the temperature changed from abnormal to normal temperature range, the following massage appears on the icon in the system tray. If log output is enabled, the information is output in the log. 118

119 4. Power lick the Power tab to open the following dialog box. * This function is applicable only to the Atom models. Item 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). lick 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. * Administrator privileges are required to save the settings. 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 if the check box is cleared. lick OK or Apply to save the changes. * Administrator privileges are required to save the settings. 5 V The 5V area contains information of the status of 5 Vdc power supply. History graph The graph shows a trend of 5 Vdc power supply. The yellow dotted line indicates the upper-limit/lower-limit voltage. The color of the graph line changes depending on the status of 5 Vdc power supply. Normal: green Abnormal: red urrent The current voltage of 5 Vdc power supply is shown on the right side of the voltage graph. olors of the value indicate the status of the status of 5 Vdc power supply. Normal: green Abnormal: red 119

120 Item (ontinued) 3.3 V The 3.3 V area contains the status of 3.3 Vdc power supply. History graph The graph shows a trend of 3.3 Vdc power supply. The yellow dotted line indicates the upper-limit/lower-limit voltages. The color of the graph line changes depending on the status of 3.3 Vdc power supply. Normal: green Abnormal: red urrent voltage The current voltage of 3.3 Vdc power supply is shown on the right side of the graph. olors of the value indicate the status of the status of 3.3 Vdc power supply. Normal: green Abnormal: red 12 V The 12V area contains the status of 12 Vdc power supply. The item appears only when you use Long-Term Supply Industrial ontroller Atom model. History graph The graph shows a trend of 12 Vdc power supply. The yellow dotted line indicates the upper-limit/lower-limit voltages. The color of the graph line changes depending on the status of 12 Vdc power supply. Normal: green Abnormal: red urrent voltage The current voltage of 12 Vdc power supply is shown on the right side of the graph. olors of the value indicate the status of the status of 12 Vdc power supply. Normal: green Abnormal: red 5 VSB The 5 VSB area contains the status of 5V standby power supply. The item appears only when you use Atom N2800 model. History graph The graph shows a trend of 5 Vdc standby power supply. urrent voltage The current voltage of 5 Vdc standby power supply is shown on the right side of the graph. OK lick OK to save the changes and close the window. ancel lick ancel to discard the changes and close the window. Apply lick Apply to save the changes The window will not be closed. Help lick Help to open the Help file of System Monitoring Library. When abnormal voltage is detected, the following massage appears from the icon in the system tray. Example: detection of abnormal 5 Vdc voltages When the voltage changed from abnormal to normal voltage range, the following massage appears from the icon in the system tray. If log output is enabled, the messages above are output in the log. 120

121 5. FAN This function is applicable only to Atom N2800, and ore i7/eleron models. lick the FAN tab to open the following dialog box. Item Enable fan log PU fan status Select the Enable fan log check box to enable to output log records of fan. The log information includes abnormal status and recovery of PU fan. lick OK or Apply to save the changes. Note: * If abnormal status and recovery of PU fan are successively occurred at a short interval, not all the log may not be output. * Administrator privileges are required to save the settings. Select the PU fan status check box to output the operating status of PU fan. STOP means the fan stops, and RUN means the fan is in operation. For products without PU fan, the information is invalid. In this case - is displayed. 121

122 Unit fan status Item 4-slot short unit / fan 7-slot unit /exhaust fan 9-slot unit /exhaust fan 1 9-slot unit / exhaust fan 2 13-slot unit / exhaust fan 1 OK ancel Apply Help 13-slot unit / exhaust fan 2 (ontinued) The Unit fan status area contains the status of chassis fan. The fan monitored by this utility differs depending on product you use. The picture above is the result for 7-slot unit product. The item indicates the status of 4-slot unit (short size) fan. RUN: The fan is in operation. STOP or UNONNETED: The fan stops or is not connected. The item indicates the status of 7-slot unit (short size/full size) exhaust fan or 9-slot unit (short size/full size) exhaust fan 1 RUN: The fan is in operation. STOP or UNONNETED: The fan stops or is not connected. The item indicates the status of 9-slot unit (short size/full size) exhaust fan 2 or 13-slot unit (short size/full size) exhaust fan 1 RUN: The fan is in operation. STOP or UNONNETED: The fan stops or is not connected. The item indicates the status of 13-slot unit (short size/full size) exhaust fan 2. RUN: The fan is in operation. STOP or UNONNETED: The fan stops or is not connected. lick OK to save the changes and close the window. lick ancel to discard the changes and close the window. lick Apply to save the changes The window will not be closed. lick Help to open the Help file of System Monitoring Library. When fan stop is detected, the following massage appears from the icon in the system tray. When the fan is recovered and starts operation, the following massage appears from the icon in the system tray. If log output is enabled, the messages above are output in the log. 122

123 6. ButtonFilter lick the ButtonFilter tab to open the following dialog box * This function is applicable only to ore i7/eleron model. Item Filter Enable power button filter OK ancel Apply Help Select the check box to ignore any operation for a second to protect from erroneous operation. lick OK to save the changes and close the window. lick ancel to discard the changes and close the window. lick Apply to save the changes The window will not be closed. lick Help to open the Help file of System Monitoring Library. 123

124 7. LED lick the LED tab to open the following dialog box. * This function is applicable only to ore i7/eleron models. Item onfig when the board temperature is higher than the upper limit. when the board temperature is lower than the lower limit. Select the check box to blink the power supply indicator LED on the rear panel of the product while the PB temperature is higher than the upper-limit set at the Temperature tab or set by the msettemplimit function. Select the check box to blink the power supply indicator LED on the rear panel of the product when the board temperature is lower than the lower-limit value set at the Temperature tab or set by the msettemplimit function. Select the check box to blink the power supply indicator LED on the rear panel of the product while the PU fan stops. lick OK to save the changes and close the window. lick ancel to discard the changes and close the window. lick Apply to save the changes The window will not be closed. lick Help to open the Help file of System Monitoring Library. when the PU fan stops. * OK ancel Apply Help * This configuration is applicable only to ore i7/eleron models with a PU fan. 124

125 8. PowerModule This function is applicable only to slot-in power supply modules. lick the PowerModule tab to open the following dialog box. The picture in the dialog box shows 6 slots. The slots in which a slot-in power supply module is not inserted are described as blank panels. Item Enable power module log Select the check box to output logs about slot-in power supply module. The following information is logged: - warning/error and recovery - insertion and removal of slot-in power supply module lick the OK or Apply button to save changes. * If warning/error and recovery and insertion/removal are occurred continuously in short intervals, some logs may not be output. * Administrator privileges are required to save the settings. 125

126 Status Item - The product models and pictures of slot-in power supply modules are displayed. - The status of slot-in power supply modules are distinguished by the color. Warning (ALM):red Error (FAIL): blue Warning and error (ALM+FAIL): white When a slot-in power supply module is not inserted in a slot, product model is not displayed and the picture is described as a blank panel. OK lick OK to save the changes and close the window. ancel lick ancel to discard the changes and close the window. Apply lick Apply to save the changes. The window will not be closed. Help lick Help to open the Help file of System Monitoring Library. Note: Because the JPS and JPS have the same ID, the product model is displayed as JPS If you use the JPS , read it as JPS When warning and error are detected, the following massage appears from the icon in the system tray. Example) A warning (ALM) is detected at JPS-1059 inserted into the P2 slot. Warning (ALM) and error (FAIL) are not notified simultaneously. heck the status by logs and the pictures in the Status. When a module is recovered from warning or error, the following massage appears. If log output is enabled, the messages above are output in the log. 126

127 9. Battery This function is applicable only to battery module. lick the Battery tab to open the following dialog box. Item Enable battery log Status apacity Voltage Temperature urrent Battery Average Select the Enable battery log check box to enable to output logs about battery. The log information includes; - battery charge start/full charge detection/power failure detection - abnormal battery status detection - diagnostic error detection lick the OK or Apply button to save changes. * If battery charge start/full charge detection/power failure detection are occurred continuously in short intervals, some logs may not be output. * Administrator privileges are required to save the settings. The status area contains the current status of a battery. harging: Full charge: Blacking out *While status transits to another status, status may not be shown. The item shows the battery capacity. The item shows the battery voltage. The item shows the battery temperature. The current area contains information about current. The item shows the measurement value of current. The value is minus while discharging. The item shows the average value of current. The value is minus while discharging 127

128 Item apacity Learn Nominal History Setting OK ancel Apply Help (ontinued) The apacity area contains information about battery. The item shows the learning capacity of battery. The value is the maximum capacity of the battery with consideration for learning and life time factor at discharging. The item shows the nominal capacity of battery. The button opens the history dialog box. The button opens the setting dialog box. lick OK to save the changes and close the window. lick ancel to discard the changes and close the window. lick Apply to save the changes The window will not be closed. lick Help to open the Help file of System Monitoring Library. 128

129 - History dialog box lick the History button to open the following dialog box. Item Total operating time Black out count The item shows the total operating time of battery. The unit is hours (h). The item shows the number of power failure occurrence. The number counts up when the module is recovered from power failure. The item shows the discharged capacity while discharging. The value increases while the battery module is discharging. When the status becomes charging, the total discharged capacity at the last power failure is retrieved. The graph shows accumulated operating time versus temperature of the battery. - 9 Temperature < 10 degrees <= Temperature < <= Temperature < <= Temperature < <= Temperature < <= Temperature < <= Temperature < <= Temperature Electric discharge capacity of the black out Temperature distribution To close the dialog box, click the close button on the upper right of the dialog box. 129

130 - Setting Dialog Box lick the Setting button to open the following dialog box. Item Shutdown Enable OS shutdown Time Type Battery off Time OK ancel The Shutdown area includes items about the operating system shutdown request at a power failure occurrence. Select the check box to request to shut down the operating system by the settings of Time and Type when a power failure occurs. Specify an interval time from a power failure occurrence (battery discharge start) to OS shutdown request. The unit is seconds. The selectable range is 1 through Select a process to be executed when the interval elapses after the power failure occurs. Shutdown: shutting down after the time specified in Time elapses. Hibernation: Go into hibernation mode after the time specified in Time elapses. Specify time to terminate discharging of the battery. Discharge of the battery is forcibly terminated when the interval time elapses after power failure occurred to protect the battery from over discharge. * System configuration information and files may be corrupted if battery discharge stops between a power failure occurrence and completion of post-processing and operating system shutdown. lick OK to save the changes and close the window. * Administrator privileges are required to save the settings. lick ancel to discard the changes and close the window. 130

131 10. Information lick the Information tab to open the following dialog box. Item Function Version opy This column shows the utility functions. This column shows the version of each function. The button copies the functions and versions to the clip board. 131