System Management Interface Based on HPI-B (Centellis 4620) User’s Guide 6806800D85A July 2008
© 2008 Emerson All rights reserved. Trademarks Emerson, Business-Critical Continuity, Emerson Network Power and the Emerson Network Power logo are trademarks and service marks of Emerson Electric Co. © 2008 Emerson Electric Co. All other product or service names are the property of their respective owners. Intel® is a trademark or registered trademark of Intel Corporation or its subsidiaries in the United States and other countries.
Contents About this Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 1 System Management Interfaces Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 1.1 1.2 1.3 1.4 2 2.3 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installing and Configuring the HPI-B Daemon . . . .
Contents 4.4 A Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Example Application Source Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 List of Supported Example Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
List of Tables Table 1-1 Table 2-1 Table 2-2 Table 2-3 Table 2-4 Table 2-5 Table 3-1 Table 4-1 Table 4-2 Table 4-3 Table 4-4 Table 4-5 Table 4-6 Table 4-7 Table 4-8 Table 4-9 Table 4-10 Table 4-11 Table 4-12 Table 4-13 Table 4-14 Table 4-15 Table 4-16 Table 4-17 Table B-1 Table B-2 HPI-B Standards Supported by Emerson HPI-B Implementation . . . . . . . . . . . . . . . . RPM Files for HPI-B Clients and Daemons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
List of Tables 6 System Management Interface Based on HPI-B (Centellis 4620) User’s Guide (6806800D85A)
List of Figures Figure 1-1 Figure 4-1 Figure 4-2 Overview of HPI Usage in Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Multishelf Library - Representation of Shelves as Domains . . . . . . . . . . . . . . . . . . . . . 25 HPI Multishelf Library - Overview of Related HPI Resources and Controls . . . . . . . . .
List of Figures 8 System Management Interface Based on HPI-B (Centellis 4620) User’s Guide (6806800D85A)
About this Manual Overview of Contents This manual is divided into the following chapters and appendices. z Chapter 1, System Management Interfaces Overview, on page 13 Provides an overview on HPI-B in Emerson AdvancedTCA systems z Chapter 2, Software Installation and Configuration, on page 17 Describes how to install and configure HPI-B clients and HPI-B daemons.
About this Manual Abbreviation Description LAN Local Area Network MVL Montavista Linux OEM Original Equipment Manufacturer PICMG PCI Industrial Computer Manufacturers Group RMCP Remote Management Control Protocol RPM RedHat Package Manager SAF Service Availability Forum SAI Service Availability Interface SAIM Service Availability Interface Mapping SAM Shelf Management Alarm Module SMI Serial Management Interface ShMC Shelf Management Controller Conventions The following table desc
About this Manual Notation Description | Logical OR Indicates a hazardous situation which, if not avoided, could result in death or serious injury Indicates a hazardous situation which, if not avoided, may result in minor or moderate injury Indicates a property damage message No danger encountered. Pay attention to important information Summary of Changes This manual has been revised and replaces all prior editions.
About this Manual 12 System Management Interface Based on HPI-B (Centellis 4620) User’s Guide (6806800D85A)
System Management Interfaces Overview 1.1 1 Introduction Emerson provides an SAF Hardware Platform Interface (HPI) as part of its AdvancedTCA platforms. HPI provides an industry standard interface to monitor and control highly available telecommunications system platforms.
System Management Interfaces Overview HPI Library Management Alarm module (SAM) in the shelf. The communication between HPI daemon and SAM is realized via RMCP (Remote Management Control Protocol) which is an IPencapsulation of IPMI commands. The communication between HPI daemon and HPI client is realized by an IP-based remote HPI communication protocol. An HPI client may access one or more HPI daemons, and on the other hand, an HPI daemon may be accessed by one or more HPI clients.
HPI Daemon System Management Interfaces Overview The single shelf library supports the communication with one HPI daemon only. Since it is only used internally and is not intended to be used by user applications, it will not be described any further in this manual. The multishelf library, on the other hand, supports the communication with one up to several HPI daemons.
System Management Interfaces Overview 16 High Availability System Management Interface Based on HPI-B (Centellis 4620) User’s Guide (6806800D85A)
Software Installation and Configuration 2.1 2 Overview This section describes how to set-up HPI-B daemons and clients and how to install all files needed to run client applications. Generally, all files are delivered in the form of RPMs. The content of an RPM is reflected in its naming scheme. The following table describes the used naming scheme of the client and daemon RPMs.
Software Installation and Configuration 2.2.1 Installing an HPI-B Daemon Installing an HPI-B Daemon As previously mentioned, it depends on the ATCA-F120 release if the HPI-B daemon files are preinstalled or not. If they are not preinstalled or if you want to upgrade existing HPI-B files, you need to obtain the desired RPM files and install them manually as follows. Installing the HPI-B Daemon Files In order to install/upgrade the HPI-B daemon files on an ATCA-F120 blade, proceed as follows. 1.
Setting Up HPI Clients Software Installation and Configuration The corresponding section in the configuration file is called ipmidirect. Within ipmidirect, you need to adapt the entries addr and port, where addr is the IP address and port is the port. In a Centellis 4620 shelf the virtual IP address used to access the SAMs via RMCP is 192.168.24.11 and the port number is 623, by default.
Software Installation and Configuration Configuring HPI Clients Table 2-3 Overview of HPI-B Directories and Files on Node Blades (continued) 2.3.2 Directory Description /opt/motorola/bin Contains precompiled example applications. They are controlled via the command line and can easily be identified through the prefix "hpi" in their names. Use the -h option to display supported command line parameters. /opt/motorola/etc/bb s-hpib Contains configuration files used to configure HPI client libraries.
Developing Applications 3.1 3 Overview This chapter describes how to develop applications that make use of the HPI-B library. Depending on the CPU architecture of the target system where you want to run your HPI-B application and on the operating system, different RPM files are delivered which contain include files and static libraries needed for the application development. The naming scheme used for these files is as follows: bbs-hpib-devel--1.-.
Developing Applications 22 Building the Application System Management Interface Based on HPI-B (Centellis 4620) User’s Guide (6806800D85A)
Using HPI-B 4.1 4 Overview This chapter provides information which is necessary when writing applications that are based on the Emerson HPI-B distribution. It lists limitations with respect to the HPI-B specification and describes extensions which were added by Emerson. 4.2 Limitations This section describes those HPI-B features which the Emerson HPI-B implementation for the Centellis 4620 environment does not support. 4.2.
Using HPI-B 4.2.2 Limitations with Respect to HPI-B AdvancedTCA Mapping Specification Limitations with Respect to HPI-B AdvancedTCA Mapping Specification The following limitations apply with respect to the compatibility with the HPI-B-AdvancedTCA mapping specification SAIM-HPI-B.01.01-ATCA. Note that these limitations apply to the current and also to all future Emerson HPI-B releases. There are no plans to implement these features in the future. 4.
Accessing HPI Domains Using HPI-B The following figure illustrates an example configuration with four domains and three shelves. Figure 4-1 Multishelf Library - Representation of Shelves as Domains Any FRUs available in a shelf are represented as HPI resources together with Resource Data Records (RDRs) corresponding to that FRU. Whenever a FRU is added to or removed from a shelf, the corresponding HPI resource/RDR is added/removed from the HPI domain. 4.3.
Using HPI-B 4.3.3 How Domains and Shelves are Represented How Domains and Shelves are Represented As previously mentioned, each HPI implementation has at least the default domain. It has the ID 0 assigned to it. Starting with HPI-B, the default domain contains a Domain Reference Table, which contains references to all related domains and may be used by applications for discovery of available domains in the current configuration.
How Domains and Shelves are Represented Using HPI-B The Domain Management Resource contains one HPI control and allows applications to add/remove HPI domains/shelves to the HPI environment. The Shelf Management Resource contains one HPI control and one HPI sensor and acts as reference to connected daemons. There is one Shelf Management Resource for each connected daemon.
Using HPI-B How Domains and Shelves are Represented In the following, the Domain Management Resource and the Shelf Management resource will be described in detail. A description of typical usage examples/scenarios will be given after that. 4.3.3.1 Domain Management Resource The Domain Management Resource acts as container for the Domain Management Control and is defined as follows.
How Domains and Shelves are Represented Using HPI-B Table 4-3 Domain Management Control SaHpiCtrlRecT Value Num MOTHPI_CTRL_NUM_DOMAIN_MANAGEMENT Ignore SAHPI_FALSE OutputType SAHPI_CTRL_OEM Type SAHPI_CTRL_TYPE_OEM TypeUnion - Oem -Mld MOTHPI_MANUFACTURER_ID_MOTOROLA TypeUnion - Oem -ConfigData 0 TypeUnion - Oem - Default - Mld 0 TypeUnion - Oem - Default - BodyLength 0 TypeUnion - Oem - Default - Body 0 Oem 0 Table 4-4 Domain Management Control State SaHpiCtrlStateT Value Type S
Using HPI-B How Domains and Shelves are Represented Table 4-5 Shelf Management Resource (continued) SaHPIRptEntryT Value ResourceCapabilities SAHPI_CAPABILITY_RESOURCE | SAHPI_CAPABILITY_RDR | SAHPI_CAPABILITY_CONTROL | SAHPI_CAPABILITY_SENSOR When the shelf is reachable: SAHPI_CAPABILITY_DOMAIN ResourceSeverity SAHPI_MAJOR DomainId Domain Id when the shelf is reachable IdString Domain name The shelf management resource contains the following two RDRs: z Domain management control Read-only HPI
Discovering Shelves and Domains Using HPI-B Table 4-7 Domain Connection Sensor SaHpiSensorRecT Value Num MOTHPI_SENSOR_NUM_DOMAIN_CONNEC TION Type SAHPI_CHASSIS Category SAHPI_EC_AVAILABILITY EventCtrl SAHPI_SEC_PER_EVENT Events SAHPI_ES_ON_LINE | SAHPI_ES_OFF_LINE Ignore SAHPI_FALSE DataFormat - ReadingFormats SAHPI_SRF_EVENT_STATE DataFormat - IsNumeric SAHPI_FALSE DataFormat - IsThreshold SAHPI_FALSE Oem 0 Table 4-8 Domain Connection Sensor Reading SaHpiSensorReadingT Value Valu
Using HPI-B Adding and Removing Shelves and Domains Alternatively, you can use the Shelf Management Resources defined in the default domain. Any shelves that were added to the HPI environment are represented by one Shelf Management Resource with the entry ResourceCapability set to SAHPI_CAPABILITY_DOMAIN. So in order to discover shelves/domains, you simply need to parse the default domain for HPI resources with the entry ResourceCapability set to SAHPI_CAPABILITY_DOMAIN.
Emerson Extensions Using HPI-B After calling saHpiControlStateSet(), a new resource with the domain name you supplied as parameter is created. Additionally, a hot swap event of type ACTIVE for the created resource is sent. The newly created shelf is also added to the HPI multishelf configuration file as a new entry. All shelves must have different IP addresses. 4.3.5.
Using HPI-B 4.4.1 HPI Controls for Domain and Shelf Management HPI Controls for Domain and Shelf Management This refers to the Domain Management Resource and Shelf Management Resource which were previously explained. Both are Emerson-specific extensions. See Working with the Multishelf Library on page 24. 4.4.2 IPMI System Boot Options Support A FRU may have a payload which is capable of booting an operating system (OS).
IPMI System Boot Options Support Using HPI-B Table 4-12 Boot Option State SaHpiCtrlStateT Value Type SAHPI_CTRL_TYPE_OEM StateUnion.Oem.Mid MOTHPI_MANUFACTURER_ID_MOTOROLA StateUnion.Oem.BodyLength Get operations: When input parameter: 3 When output parameter: Total length of the response data 2 Set operations: Total length of the request data StateUnion.Oem.
Using HPI-B 4.4.3 POST Type Control POST Type Control This HPI control allows you to set/get the Power-On Self Test (POST) type of the blade. Two POST types are configurable: long POST and short POST. Refer to the respective hardware user manual of the blade for details about both POST types. The definition of the respective HPI controls is given in the following tables.
HPI Logging Support Using HPI-B Refer to the header file MotorolaHpi.h for used defines. Table 4-15 Log RDR SaHpiRdrT Value RecordId Assigned by HPI RdrType SAHPI_CTRL_RDR Entity The same entity as logical shelf resource RdrTypeUnion Defined in next table IdString MOTHPI_CTRL_NAME_LOG found in MotorolaHpi.h Table 4-16 Log Control SaHpiCtrlRecT Value Num MOTHPI_CTRL_NUM_LOG Ignore SAHPI_FALSE OutputType SAHPI_CTRL_OEM Type SAHPI_CTRL_TYPE_OEM TypeUnion.Oem.
Using HPI-B HPI Logging Support Table 4-17 Log Control State SaHpiCtrlStateT Value Type SAHPI_CTRL_TYPE_OEM StateUnion.Oem.MId MOTHPI_MANUFACTURER_ID_MOTOROLA StateUnion.Oem.BodyLength 40 + length of log file name StateUnion.Oem.
A Example Applications A.1 A Overview The HPI-B client base package contains precompiled example applications. They are invoked via the command line and can be configured via command line parameters. Each example application illustrates a certain feature of HPI-B and makes use of the respective HPI-B function calls. After extracting the HPI-B client RPMs, the example applications can be found in the following directory: /opt/motorola/bin.
Example Applications List of Supported Example Applications # # Lists the usage of all supported HPI-B example programs. # # Copyright (c) 2007 by Motorola GmbH # Copyright (c) 2008, Emerson Network Power - Embedded Computing GmbH # #------------------------------# # hpiautotimer #------------------------------# Usage: hpiautotimer [OPTION]... HPI example application to manage the timeout values of the auto insert timer and auto extract timer.
List of Supported Example Applications Example Applications Set the system boot option 1 (service partition) to value 2 for resource 4 on domain 0: hpibootoptions -d 0 -r 4 1 2 Turn on console redirection and perform a cold-reset for resource 34 on domain 0: hpibootoptions -d 0 -r 34 -c -x #------------------------------# # hpichassisstatus #------------------------------# Usage: hpichassisstatus [OPTION]... HPI example application to display the control state of the chassis status control.
Example Applications -A -t -p -x -V -h List of Supported Example Applications display everything display RDR with the event log display RPT with the event log display debug messages print version information and exit display this help and exit #------------------------------# # hpidomainself #------------------------------# Usage: hpidomainself [OPTION]... HPI example application to print the domain ID where this program is running on. Note: Requires multishelf library.
List of Supported Example Applications -r RESOURCE_ID -a {0|1} -w DELAY -V -h Example Applications use resource with id RESOURCE_ID disable/enable ShM activation set delay before next power on to DELAY * 1/10 sec print version information and exit display this help and exit #------------------------------# # hpifruipmcreset #------------------------------# Usage: hpifruipmcreset [OPTION]... HPI example application to set FRU IPMC Reset Control actions.
Example Applications List of Supported Example Applications #------------------------------# # hpiha #------------------------------# Usage: hpiha [OPTION]... HPI example application to show the HA state and to initiate a switch-over.
List of Supported Example Applications -s STRING -f FILE -w FILE -V -h Example Applications write string STRING to User Info Area write content of file FILE to User Info Area write User Info Area to file FILE print version information and exit display this help and exit #------------------------------# # hpiipmb0 #------------------------------# Usage: hpiipmb0 [OPTION]... HPI example application to set the IPMB-A or IPMB-B state control.
Example Applications List of Supported Example Applications #------------------------------# # hpilink #------------------------------# Usage: hpilink [OPTION]... HPI example application to display E-Keying link states and optionally listen for link state events.
List of Supported Example Applications Example Applications ng|ipmipower|ipmiptpekeying|ipmisub|softwareupgrade|redundancy|script|shfruv alidation|sdrrepository|rmcp|deassert|solmgmt|marshal|all #------------------------------# # hpiposttype #------------------------------# Usage: hpiposttype [OPTION]... HPI example application to control POST type.
Example Applications List of Supported Example Applications on. Options: -d DOMAIN_ID -V -h use domain with id DOMAIN_ID print version information and exit display this help and exit #------------------------------# # hpirestartdaemon #------------------------------# Usage: hpirestartdaemon [OPTION]... HPI example application to restart the HPI daemon.
List of Supported Example Applications Example Applications Usage: hpiship [OPTION]... HPI example application to display and set the Shelf Manager IP address.
Example Applications -s -c -w -i -a -x -V -h List of Supported Example Applications display sensors display controls display watchdogs display inventories display annunciators display debug messages print version information and exit display this help and exit #------------------------------# # hpiversion #------------------------------# Usage: hpiversion [OPTION]... HPI example application to display the version of the different HPI components.
B Related Documentation B.1 B Emerson Network Power - Embedded Computing Documents The Emerson Network Power - Embedded Computing publications listed below are referenced in this manual. You can obtain electronic copies of Emerson Network Power - Embedded Computing publications by contacting your local Emerson sales office. For documentation of final released (GA) products, you can also visit the following website: www.emersonnetworkpower.
Related Documentation 52 Related Specifications System Management Interface Based on HPI-B (Centellis 4620) User’s Guide (6806800D85A)
