American Megatrends MegaRAC 780 Series Assembly Instructions

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

MegaRAC Hardware Health Function SDK
ii
© Copyright 2000 American Megatrends, Inc.
All rights reserved.
American Megatrends, Inc.
6145F Northbelt Parkway
Norcross, GA 30071
This publication contains proprietary information which is protected by copyright. No part of this
publication can be reproduced, transcribed, stored in a retrieval system, translated into any
language or computer language, or transmitted in any form whatsoever without the prior written
consent of the publisher, American Megatrends, Inc. American Megatrends, Inc. acknowledges the
following trademarks:
Intel is a registered trademark of Intel Corporation.
MS-DOS, and Microsoft are registered trademarks of Microsoft Corporation. Windows 95,
Microsoft Windows and Windows NT are trademarks of Microsoft Corporation.
SCO, UnixWare, and Unix are registered trademarks of the Santa Cruz Operation. Inc.
Novell NetWare is a registered trademark of Novell Corporation.
IBM, AT, VGA, and OS/2 are registered trademarks and XT and CGA are trademarks of
International Business Machines Corporation.
Revision History
8/30/00 Initial release

Preface iii
Table of Contents
Table of Contents......................................................... iii
1 Overview of the Hardware Health Function SDK
............................................................................. 1
Screen Access..................................................................................2
HVL and HHF.................................................................................2
General Information ........................................................................3
2 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
Adding Functions ............................................................................9
HHF Parameters ............................................................................10
HHF Access Script........................................................................14
HHF Script Example .....................................................................15
Deleting Categories .......................................................................16
Deleting Functions ........................................................................16
Initializing Hardware.....................................................................17
Editing Functions ..........................................................................18
Generating a SDK port for a Server with IPMI.............................19
Application Notes for AMI MegaRAC .........................................21
Index............................................................................. 23

MegaRAC Hardware Health Function SDK
iv
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.
Licensee agrees to defend and indemnify American Megatrends from any
and all claims, suits, and liabilities (including attorney’s fees) arising out of
or resulting from any actual or alleged act or omission on the part of
Licensee, its authorized third parties, employees, or agents, in connection
with the distribution of Licensed Software to end-users, including, without
limitation, claims, suits, and liability for bodily or other injuries to end-users
resulting from use of Licensee’s product not caused solely by faults in
Licensed Software as provided by American Megatrends to Licensee.
Disclaimer This manual describes the operation of the American Megatrends
MegaRAID Disk Array Controller. Although efforts have been made to
assure the accuracy of the information contained here, American Megatrends
expressly disclaims liability for any error in this information, and for
damages, whether direct, indirect, special, exemplary, consequential or
otherwise, that may result from such error, including but not limited to the
loss of profits resulting from the use or misuse of the manual or information
contained therein (even if American Megatrends has been advised of the
possibility of such damages). Any questions or comments regarding this
document or its contents should be addressed to American Megatrends at the
address shown on the cover. American Megatrends provides this publication
“as is” without warranty of any kind, either expressed or implied, including,
but not limited to, the implied warranties of merchantability or fitness for a
specific purpose.
Some states do not allow disclaimer of express or implied warranties or the
limitation or exclusion of liability for indirect, special, exemplary, incidental
or consequential damages in certain transactions; therefore, this statement
may not apply to you. Also, you may have other rights which vary from
jurisdiction to jurisdiction. This publication could include technical
inaccuracies or typographical errors. Changes are periodically made to the
information herein; these changes will be incorporated in new editions of the
publication. American Megatrends may make improvements and/or revisions
in the product(s) and/or the program(s) described in this publication at any
time. Requests for technical information about American Megatrends
products should be made to your American Megatrends authorized reseller or
marketing representative.
Internet Address [e-mail]
Web Site http://www.ami.com/

Overiew of the Hardware Health Function SDK 1
1 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.
The SDK utility generates the data that can be flashed onto
the MegaRAC card’s firmware using separate applications
such as RacView, WebRacView, Control Panel Applet
Utility, and the Remote Flash Utility. In order for all
monitoring features to work, the card has to be connected
to the baseboard though the Feature Connector or Hobbs
Connector.
You can customize the system health monitoring properties
by using the SDK utility to create configurations that
define how to monitor the hardware. For example, you can
set warning and alert limits for the voltage or temperature
and save them in the configuration. The system then uses
the settings in the configuration to measure the voltage and
temperature.
This SDK utility cannot be used to change the graphical
user interface (GUI) of the console program. After the
firmware has been updated, the data can be viewed through
the desired remote console program. The remote console
program automatically finds the monitoring parameters and
displays them appropriately.

MegaRAC Hardware Health Function SDK
2
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.
Cont'd

Overiew of the Hardware Health Function SDK 3
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
•CPU - 1
•CPU - 2
•Drive Cage
Voltage:
•CPU - 1
•CPU - 2
•GTL
•5V Power Supply
The MegaRAC card’s firmware monitors the system
hardware using a generic engine. This engine uses the
binary data generated by the SDK to monitor the system.
The binary data contains the information needed to access
or initialize the hardware for system monitoring. The
MegaRAC firmware creates the Hardware Visualization
Layer (HVL), which is a hardware independent layer
between the hardware interface and the system monitoring
process.
General Information
Screens There are three main screens in the Hardware Health
Function SDK:
•Menu
•Health Function Porting Form
•Access Script Form
Cont'd

MegaRAC Hardware Health Function SDK
4
General Information, Continued
This Guide This guide describes the Hardware Health Function SDK
screens, and the tasks that you can perform on each screen.

Using the MegaRAC Hardware Health Function 5
2 Using the MegaRAC
Hardware Health Function
SDK
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. Running the
Hardware Health Function SDK. The Hardware Health
Function SDK is used to create and save configurations
used for system monitoring. This utility can be found on
the MegaRAC v2.3 distribution CD. The executable file is
located at:
Cont'd

MegaRAC Hardware Health Function SDK
6
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. The menu screen also displays the
layout of the Health Function Tree.
Categories and Functions The Add Categories tab is used to create
health categories to monitor major items, such as
temperatures, fans, chassis information and voltages.
Within each category, you can select the Add Function tab
to create functions to monitor individual elements, such as
the temperature of a specific piece of hardware.
The Delete Categories and Delete Function tabs are used to
add or delete categories and/or functions that are not
desired. When a category is added, the system adds a
folder for that category to the menu screen. The functions
that are created for a category will display under the
category folder.
After changes have been made to the categories and
functions that you created. You can save the configuration
by selecting the Save Data tab.
The Initialize Hardware tab is used to re-initialized the
system configuration. The Advanced tab is used to wait for
commands before configuring.
Cont'd

Using the MegaRAC Hardware Health Function 7
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.
•Load Configuration – loads a previous configuration
that has already been created.
•Import IPMI Info. – loads the IPMI information
created by the GetSDR utility.
•Help – displays the Hardware Health SDK help file.
Note: The Delete Category button is inactive in the screen shot
above. A category must be selected in the Health Tree to
make this button active. After a category has been selected,
you can then delete that function.
Adding Categories
To add a category, click on a category or the Add Category
button. The following dialog box displays:
Enter the name of the health category and click OK. A
folder for the new category will display in the Health
Function Tree.
Cont'd

MegaRAC Hardware Health Function SDK
8
Adding Categories, Continued
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:
Cont'd

Using the MegaRAC Hardware Health Function 9
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.

MegaRAC Hardware Health Function SDK
10
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 Description
Name Name of the HHF (maximum of 32 characters)
Low Warning
Limit
If the monitoring value is below this value, then an alert
notification with warning code is issued. (Refer to Appendix
B, Application Notes for AMI MegaRAC.)
High Warning
Limit
If the monitoring value is above this value, then an alert
notification with warning code is issued. (Refer to Appendix
B, Application Notes for AMI MegaRAC.)
Low Critical
Limit
If the monitoring value is below this value, then an alert
notification with critical code is issued. (Refer to Appendix
B, Application Notes for AMI MegaRAC.)
High Critical
Limit
If the monitoring value is above this value, then an alert
notification with critical code is issued. (Refer to Appendix
B, Application Notes for AMI MegaRAC.)
Unit Description The item being monitored.
Conversion
Formula
This defines how the sensor data is converted to values that
you can use. The sensor data are in a linear curve. The
formulas for converting the sensor data are:
Y = (m*X + c*10^k1)*10^k2
Or
Y = (m/X + c*10^k1)*10^k2
"X" is the sensor reading data, "Y" is the converted value,
and c, k1 and k2 are signed integers.
Range of X Sensor data is compared to a range of valid values (byte,
word, double word.) Range is applied for the low and high
range of the sensor data and can be nullified. The following
is an example of how range values work:
There is a fan (rpm) reading as a byte, with a minimum value
of 0, and maximum value of 255. If the low range is set to 3
and the high range is set to 200, then valid sensor data are
from 3 to 200. Other values are considered invalid (or 0.)
Monitoring
Schedule
You can select the time intervals between monitoring. The
interval can be from 1 to 100 seconds, minutes, hours, or
days.
Access Script An access script defines how to access the hardware for
monitoring. For more information see the HHF Access
Script.
Cont'd

Using the MegaRAC Hardware Health Function 11
HHF Parameters, Continued
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. You can also
set critical limits for the temperature. Critical limits are
higher and lower than the warning limits. An example is
shown below:
Add/Edit Access Script The Add/Edit button on the Health Function
Porting Form screen is used to access the Access Script
Form screen. On this screen you can enter the following:
•Primary Access
•Operations in order
•Final Access
•Access Method
•SlaveID (hex)
•User Data (hex)
•Advanced Information
•Script Table
Cont'd

MegaRAC Hardware Health Function SDK
12
HHF Parameters, Continued
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 Use this section to select Boolean operators that
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" only
if one operand is true and the other is false.
Final Access In the Final Access section, you can choose to write the
data back to port or to save it to global data.
Access Method Use this section to select how to access the data: I2C,
standard I/O (input/output), memory mapped I/O, or IPMI.
SlaveID (hex) In this section, you can enter the I2C slave id, standard I/O
port, memory mapped I/O address, or IPMI Sensor Owner
and Sensor Number.
Cont'd

Using the MegaRAC Hardware Health Function 13
HHF Parameters, Continued
User Data (hex) In this section, you can enter the hexadecimal address for
the local data.
Advanced Information Use this section to enter the Read position, select
not to stop, and the type of data:
•Signed Byte
•Unsigned Byte
•Signed Word
•Unsigned Word
•Signed Dword (double word)
•Unsigned Dword
•Script Table
The selections that you make in the first six sections on this
screen are combined in a script in the Script Table section.
For example, the script in the screen above is:
The script has the following parts:
•[rdl:I2C,2D] [] [wrp:20].
•rdl - read user data
•I2C - access method
•2D – Slave ID
•[] - no operations
•wrp – write back to port
•20 – user data
Cont'd

MegaRAC Hardware Health Function SDK
14
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 
Each script command for hardware access has three steps.
They are defined as HVL OpCodes.
Step 1 This is the primary access, which can be hardware or
simply data. It means the primary access from hardware or
read from the data supplied by the user.
For example, primary hardware access can be of a type of
hardware, Read Port, and a method, either I2C, Standard
I/O or Memory mapped I/O. This also can be from the data
supplied by the user; in that case it is set to Read Local
Data. Also, it can be from the last hardware access; in that
case it is set to Read Global Data.
Step 2 In this step, the data is prepared by up to three logical
operations. The operations are AND, OR, and XOR, which
take place in that order.
Step 3 In this step, the final prepared data is used. The data can be
written to a hardware or stored as a global variable for
future access.
These three-step commands build a complete HHF access
script.

Using the MegaRAC Hardware Health Function 15
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.
•Select I2C as the access method.
•Select I2C slave ID as the Port value. Set the value as
0x2C.
•Enter 0x20 (LM78 temperature register) in the Local
Data field.
•Select unsigned byte as the data type.
•Select Write Back To Port as the Final Access.
2nd Access Script:
•Select Read Port as the primary access.
•Set I2C as the access method.
•Enter 0x2C as the Port value.
•Select signed byte as the data type.
•Select Save To Global Data as the final access. This
reads the final value from the device to the global data.
All read devices must end by reading the value to the
global data.

MegaRAC Hardware Health Function SDK
16
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. The
following dialog box displays:
Click Yes to delete the function. The function will no
longer display on the Health Function Tree.