American Megatrends 780 Hardware Manual
  1. Manuals
  2. Brands
  3. American Megatrends Manuals
  4. Software
  5. MegaRAC 780 Series
  6. Hardware manual
American Megatrends 780 Hardware Manual

American Megatrends 780 Hardware Manual

Hardware health function sdk
Hide thumbs Also See for 780:
Table of Contents

Advertisement

Quick Links

Download this manual
MegaRAC
®
Hardware Health
Function
SDK
MAN-780-HHF
8/30/00

Advertisement

Table of Contents
loading

Related Manuals for American Megatrends 780

Summary of Contents for American Megatrends 780

  • Page 1 MegaRAC ® Hardware Health Function MAN-780-HHF 8/30/00...
  • Page 2 American Megatrends, Inc. American Megatrends, Inc. acknowledges the following trademarks: Intel is a registered trademark of Intel Corporation.

  • Page 3: Table Of Contents

    Table of Contents Table of Contents... iii Overview of the Hardware Health Function SDK ... 1 Screen Access...2 HVL and HHF...2 General Information ...3 Using the MegaRAC Hardware Health Function SDK... 5 Using the MegaRAC Hardware Health Function SDK ...6 Menu Screen...6 Adding Categories...7 Adding Functions ...8...
  • Page 4 Disclaimers Limitations of Liability American Megatrends, Inc. shall in no event be held liable for any loss, expenses, or damages of any kind whatsoever, whether direct, indirect, incidental, or consequential (whether arising from the design or use of this product or the support materials provided with the product). No action or proceeding against American Megatrends may be commenced more than two years after the delivery of product to Licensee of Licensed Software.

  • Page 5: Overview Of The Hardware Health Function Sdk

    Overview of the Hardware Health Function SDK The MegaRAC™ Hardware Health Function SDK (Software Development Kit) is used with the MegaRAC™ (Remote Access Companion) card. It offers you a way to monitor the hardware and measure items such as the temperature, voltage, fans and chassis information.

  • Page 6: Screen Access

    Screen Access From the main menu screen, you can access the other configuration screens used to select settings and create configurations. The menu screen is shown below: HVL and HHF The Hardware Health Function (HHF), and Hardware Virtualization Layer (HVL) are the commonly used terms for the SDK's and MegaRAC’s system health monitoring process.

  • Page 7: General Information

    HVL and HHF, Continued Monitoring parameters such as Ambient Temperature, CPU Voltage, and Power Supply are some parameters of the HHF. The following list offers examples of two health categories, Temperature and Voltage, and their monitoring parameters: Temperature: • Ambient •...
  • Page 8 General Information, This Guide This guide describes the Hardware Health Function SDK screens, and the tasks that you can perform on each screen. MegaRAC Hardware Health Function SDK Continued...

  • Page 9: Using The Megarac Hardware Health Function

    Using the MegaRAC Hardware Health Function This chapter explains how to run the Hardware Health Function SDK utility and create a configuration file. The main menu screen is used to access other configuration screens and enter settings for temperature, voltage, fans, and any other item you want to monitor.

  • Page 10: Using The Megarac Hardware Health Function Sdk

    Using the MegaRAC Hardware Health Function SDK ?:\Host\Hardware Health SDK\MrSDK.exe ? = CD ROM directory A screen shot for the MegaRAC Hardware Health Function SDK utility is displayed below: Menu Screen The menu screen is used to add/delete categories, add/delete functions, initialize hardware, view data, save and load configurations.

  • Page 11: Adding Categories

    Menu Screen, Continued The other buttons located at the top of the screen are as follows: • Exit – exits the program • Save Configuration – saves the configuration file. This file is used to flash the SDK configuration to the MegaRAC card.

  • Page 12: Adding Functions

    Adding Categories, Adding Functions To add a function, select a category in the Health Function Tree then click the Add Function button. The Health Function Porting Form screen (Wizard interface) displays: MegaRAC Hardware Health Function SDK Continued Cont'd...

  • Page 13: Adding Functions

    Adding Functions Enter information in each section of this screen. This screen is explained later in the following pages. The Add/Edit button (located in the lower right corner), displays the Access Script Form screen. See screen shot above. Using the MegaRAC Hardware Health Function...

  • Page 14: Hhf Parameters

    HHF Parameters The Health Function Porting Form screen allows you to enter several parameters about each HHF. The following parameters are entered through the Wizard interface (HHF Porting Form): Item Name Name of the HHF (maximum of 32 characters) Low Warning If the monitoring value is below this value, then an alert Limit notification with warning code is issued.
  • Page 15 HHF Parameters, Thresholds The threshold section is used to enter the warning and critical limits used to monitor the health function. For example, you can set the high and low temperatures for the warning limits. If the temperature reaches a specified warning limit, the administrator is notified.
  • Page 16 HHF Parameters, Primary Access The primary access section determines where data is read. You can choose to read data from the port, global data, or local data. Operations in order define the order in which operations occur. The operators are AND (logical conjunction), OR (logical inclusion), and XOR (exclusive OR.) An exclusive OR yields "true"...
  • Page 17 HHF Parameters, User Data (hex) In this section, you can enter the hexadecimal address for the local data. Advanced Information not to stop, and the type of data: • Signed Byte • Unsigned Byte • Signed Word • Unsigned Word •...

  • Page 18: Hhf Access Script

    HHF Access Script This is the most important HVL data that SDK creates. The access script tells how to access a particular type of hardware. This script is generic to cover almost all types of hardware access. It follows the method described below. Primary Access Operation in order Final Access...

  • Page 19: Hhf Script Example

    HHF Script Example This section provides an example of the HHF Script. In this example, we read the temperature on device LM78 on the I2C bus with the slave ID 0x2C. This requires two access scripts. 1st Access Script: • Select Read Local Data as the primary access.

  • Page 20: Deleting Categories

    Deleting Categories To delete a category, select a category in the Health Function Tree and click on the Delete Category button. The following dialog box displays: Click Yes to delete the category. The category will no longer display on the Health Function Tree. Deleting Functions To delete a function, select a function in the Health Function Tree and click on the Delete Function button.

  • Page 21: Initializing Hardware

    Initializing Hardware To initialize the hardware, select the Initialize Hardware button. The Access Script Form screen displays. Make your selections on this screen and click OK. Using the MegaRAC Hardware Health Function...

  • Page 22: Editing Functions

    Editing Functions To edit a function, double-click on a function in Health Function Tree. The Health Function Porting Form screen displays: Move the cursor to any fields you want to change and enter the new information. To change an access script, click on the Add/Edit button and use the Access Script Form screen to make your changes.

  • Page 23: Generating A Sdk Port For A Server With Ipmi

    Generating a SDK port for a Server with IPMI Use the following procedures to generate a SDK port for a server with IPMI. Step Action Install MegaRAC in the IPMI server. Be sure to attach the ribbon cable between the MegaRAC and the server. Run the GetSDR utility.
  • Page 24 Generating a SDK port for a Server with IPMI, Step Action The message "Output to file (IPMI.sdr) complete" displays after program execution. If the message "IPMI Abort" displays, the program has stopped due to an IPMI timeout. The solution is to run the GetSDR utility again.

  • Page 25: Application Notes For Ami Megarac

    Application Notes for AMI MegaRAC Processors are available with different voltage requirements. Therefore, Warning and Critical limits (Mili Volt) must be adjusted for the processor installed. For example, if a processor requires X volts the following might be used: Warning low limit = (X - X*0.05)*1000 Warning high limit = (X + X*0.05)*1000 Critical low limit = (X - X*0.1)*1000 Critical high limit = (X + X*0.1)*1000...
  • Page 26 Application Notes for AMI MegaRAC, MegaRAC Hardware Health Function SDK If a Lower Limit is greater than zero and the associated Upper Limit is zero, the Upper Limit is not checked. For example, IF (Warning Low Limit > 0) AND (Warning High Limit == 0), the Warning High Limit will not be checked.

  • Page 27: Index

    Index Access Method, 12 Access Script, 10, 17 Add/Edit Access Script, 11 Adding Categories, 7, 8 Adding Functions, 8, 9 Advanced Information, 13 Ambient Temperature, 3 Application Notes for AMI MegaRAC, 21 Conversion Formula, 10 CPU Voltage, 3 Critical high limit, 21 Critical low limit, 21 Deleting Categories, 16 Deleting Functions, 16...
  • Page 28 Thresholds, 11 Unit Description, 10 User Data (hex), 13 MegaRAC Hardware Health Function SDK Using HHF, 5 Warning high limit, 21 Warning low limit, 21 Wizard interface, 8...

This manual is also suitable for:

Megarac

Table of Contents