background image

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.

Summary of Contents for MegaRAC

Page 1: ...MegaRAC Hardware Health Function SDK MAN 780 HHF 8 30 00...

Page 2: ...or 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...

Page 3: ...lth 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...

Page 4: ...amages 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 man...

Page 5: ...ures 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...

Page 6: ...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...

Page 7: ...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...

Page 8: ...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...

Page 9: ...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 H...

Page 10: ...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...

Page 11: ...nfo 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 sel...

Page 12: ...tion 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 Wizar...

Page 13: ...on 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 S...

Page 14: ...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 d...

Page 15: ...ecified 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...

Page 16: ...re 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 cho...

Page 17: ...e 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 combin...

Page 18: ...ess 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 a...

Page 19: ...od 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...

Page 20: ...ing 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 Functio...

Page 21: ...MegaRAC Hardware Health Function 17 Initializing Hardware To initialize the hardware select the Initialize Hardware button The Access Script Form screen displays Make your selections on this screen an...

Page 22: ...lick 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 cl...

Page 23: ...ata Records Utility Version 1 0 For the following please refer to IPMI Sensor Data Record Formats Output all Sensor Data Records SDR to file 1 Create SDR file for MrSDK sdr 2 Output to Screen 3 Return...

Page 24: ...rSDK utility The main menu screen displays 2 Click on the Import IPMI Info button A directory of files displays 3 Locate the IPMI sdr file and click on the Open button 4 Click on the Save Configuratio...

Page 25: ...t X X 0 05 1000 Critical low limit X X 0 1 1000 Critical high limit X X 0 1 1000 2 New versions of the MegaRAC firmware include the following features that increase the flexibility of SDK The followin...

Page 26: ...e checked This makes it possible to only set a lower limit that is greater than zero Fans usually have only a lower limit c If a Lower Limit is less than zero and equal to the associated Upper Limit t...

Page 27: ...2 G General Information 3 Generating a SDK port for a Server with IPMI 19 H Hardware Health Function 2 Hardware Virtualization Layer 2 Health Function Porting Form 18 HHF Access Script 14 HHF Paramete...

Page 28: ...MegaRAC Hardware Health Function SDK 24 T Thresholds 11 U Unit Description 10 User Data hex 13 Using HHF 5 W Warning high limit 21 Warning low limit 21 Wizard interface 8...

Reviews: