Kontron CP6003-RC User Manual
» User Guide «
CP6003-SA/RA/RC
IPMI Firmware
Doc. ID: 1045-5656, Rev. 2.0
January 12, 2012
If it’s embedded, it’s Kontron.
P R E L I M I N A R Y
Preface CP6003-SA/RA/RC
Revision History
Publication Title:
Doc. ID: 1045-5656
Rev. Brief Description of Changes Date of Issue
1.0 Initial issue 11-Aug-2011
2.0 Added description for the CP6003-RA/RC 12-Jan-2012
CP6003-SA/RA/RC IPMI Firmware User Guide
Imprint
Kontron Modular Computers GmbH may be contacted via the following:
MAILING ADDRESS TELEPHONE AND E-MAIL
Kontron Modular Computers GmbH +49 (0) 800-SALESKONTRON
Sudetenstraße 7 sales@kontron.com
D - 87600 Kaufbeuren Germany
For further information about other Kontron products, please visit our Internet website:
P R E L I M I N A R Y
www.kontron.com.
Disclaimer
Copyright © 2012 Kontron AG. All right s reserved. All dat a is for information purposes only and
not guaranteed for legal purposes. Information has been carefully checked and is believed to
be accurate; however, no responsibility is assumed for inaccuracies. Kontron and the Kontron
logo and all other trademarks or registered trademarks are the property of their respective owners and are recognized. Specifications are subject to change without notice.
Page 2 ID 1045-5656, Rev. 2.0
CP6003-SA/RA/RC Preface
Table of Contents
Revision History ........................................................................................................2
Imprint ....................................................................................................................... 2
Disclaimer .................................................................................................................2
Table of Contents ...................................................................................................... 3
List of Tables ............................................................................................................. 7
1. Introduction ...................................................................................9
1.1 Terminology and Acronym Definitions ..........................................................9
1.2 Related Publications ...................................................................................11
1.3 IPMI Overview .............................................................................................11
2. IPMI Setup ....................................................................................12
2.1 IPMI in a CompactPCI Chassis .................................................................. 12
2.2 IPMI Setup for the CP6003-SA/RA/RC ......................................................12
2.3 IPMI Setup for the Rack .............................................................................13
3. IPMI Controller Hardware ...........................................................13
4. IPMI Firmware ..............................................................................14
4.1 Key Features ..............................................................................................14
5. Supported IPMI and ATCA Commands .....................................15
5.1 Standard IPMI Commands ......................................................................... 15
5.2 AdvancedTCA and AMC Commands ......................................................... 20
P R E L I M I N A R Y
6. OEM Commands and Command Extensions ...........................21
6.1 Get Device ID Command with OEM Extensions ........................................ 21
6.2 Set Firmware Parameters .......................................................................... 22
6.3 Set Control State (SPI Boot Flash, Boot Order) ......................................... 23
ID 1045-5656, Rev. 2.0 Page 3
Preface CP6003-SA/RA/RC
6.4 Get Control State (SPI Boot Flash, Boot Order) .........................................24
7. Sensors Implemented on the CP6003-SA/RA/RC .................... 24
7.1 Sensor List ..................................................................................................25
7.2 Sensor Thresholds ......................................................................................28
7.3 OEM Event/Reading Types ........................................................................29
8. IPMI Firmware Code ................................................................... 31
8.1 Structure and Functionality .........................................................................31
8.2 uEFI BIOS/IPMI Controller Interaction ........................................................31
8.3 IPMI Firmware Configuration ......................................................................31
8.4 Firmware Identification ................................................................................32
8.5 Firmware Upgrade ......................................................................................32
8.5.1 Firmware File Formats .......................................................................32
8.5.2 Firmware Upgrade - “ipmitool hpm” ..................................................33
8.5.3 Firmware Upgrade - “ipmitool fwum” .................................................34
8.6 Setting the SEL Time ..................................................................................34
8.7 IPMI Firmware Write Protection ..................................................................34
9. FRU Data .....................................................................................35
9.1 Structure and Functionality .........................................................................35
9.2 FRU Version Identification ..........................................................................35
P R E L I M I N A R Y
9.3 Board-Specific FRU Data ...........................................................................35
9.4 FRU Data Update .......................................................................................36
9.5 FRU Data Write Protection .........................................................................36
10. XMC Card Support ...................................................................... 36
1 1. uEFI BIOS Failover Control - Automatic SPI Boot Flash Selection
37
11.1 Automatic SPI Boot Flash Selection During the Boot Process ...................37
Page 4 ID 1045-5656, Rev. 2.0
CP6003-SA/RA/RC Preface
11.2 OS Boot Order Selection by OEM IPMI ..................................................... 37
12. Hot Swap and Shutdown ............................................................38
12.1 Hot Swap Handle and Hot Swap (Blue) LED ............................................. 38
12.2 The Hot Swap and Shutdown Processes ................................................... 39
13. LAN Functions .............................................................................40
13.1 Overview ....................................................................................................40
13.2 Setting Up the Ethernet Channel ...............................................................40
13.3 Basic Setup from uEFI Shell ......................................................................41
13.4 Setup by “ipmitool” or IPMI Commands ..................................................... 41
13.5 Setup of User Accounts and Password ...................................................... 41
13.6 IPMI Over LAN (IOL) .................................................................................. 42
13.7 Serial Over LAN (SOL) ............................................................................... 42
14. OS Support / Tools ......................................................................43
14.1 Linux Tools ................................................................................................. 43
14.2 OS Support - Board Support Packages .....................................................43
15. IPMI and Hot Swap LEDs ............................................................44
P R E L I M I N A R Y
ID 1045-5656, Rev. 2.0 Page 5
Preface CP6003-SA/RA/RC
This page has been intentionally left blank.
P R E L I M I N A R Y
Page 6 ID 1045-5656, Rev. 2.0
CP6003-SA/RA/RC Preface
List of Tables
1 Terminology and Acronym Definitions ............................................................9
2 Related Publications .....................................................................................11
3 Standard IPMI Commands ...........................................................................15
4 AdvancedTCA and AMC Commands ..........................................................20
5 Get Device ID Command with OEM Extensions ..........................................21
6 Set Firmware Parameters ............................................................................ 22
7 Set Control State ..........................................................................................23
8 Get Control State ......................................................................................... 24
9 Sensor List ................................................................................................... 25
10 Gigabit Ethernet Link Sensor Assignment ................................................... 27
11 Thresholds - Standard Temperature Range ................................................. 28
12 Voltage Sensor Thresholds .......................................................................... 28
13 OEM Event/Reading Types .......................................................................... 29
14 IPMI and Hot Swap LEDs Function .............................................................45
P R E L I M I N A R Y
ID 1045-5656, Rev. 2.0 Page 7
Preface CP6003-SA/RA/RC
This page has been intentionally left blank.
P R E L I M I N A R Y
Page 8 ID 1045-5656, Rev. 2.0
CP6003-SA/RA/RC IPMI Firmware
1. Introduction
1.1 Terminology and Acronym Definitions
The following table provides descriptions for terms and acronyms used in this guide. The descriptions are derived primarily from the IPMI specifications.
Table 1: Terminology and Acronym Definitions
TERM or ACRONYM DESCRIPTION
BMC Baseboard Management Controller
Each board is equipped with an IPMI controller acting either as a BMC or as an SMC.
However, in a CompactPCI chassis, there can be only one BMC present. The BMC
administrates the SEL and the SDRR for the complete system. The BMC is connected
to the other boards in the shelf via a dedicated bus (IPMB-0). The CP6003-SA/RA/
RC’s IPMI controller can be configured to operate in SMC mode or in BMC mode via
an IPMI OEM command or an uEFI Shell command. The factory setting is SMC.
BSP Board Support Package
FRU Field Replaceable Unit
Every board is a FRU. The FRU data contains information about the board such as
the part number and the serial number. See PICMG Specification 2.9 for complete
details on the FRU data structure. The free Linux tool “ipmitool” can be used to
update or display the FRU data.
FWH Firmware Hub memory location where a complete uEFI BIOS code is stored.
2
I
C
IPMB Intelligent Platform Management Bus
IPMB-0 Intelligent Platform Management Bus which connects all SMCs with the BMC or the
IPMI Intelligent Platform Management Interface
IOL IPMI over LAN. An IPMI controller is accessed via LAN, not IPMB.
KCS Keyboard Controller Style (Interface)
Inter-Integrated Circuit
The dedicated I
shelf manager.
This is the IPMI mandatory interface on the host system (payload) to communicate
with the BMC.
2
C management bus where the BMC and the SMCs communicate.
P R E L I M I N A R Y
MP Management Power
This powers the BMC or SMC controller.
PICMG PCI Industrial Computer Manufacturer Group
ID 1045-5656, Rev. 2.0 Page 9
IPMI Firmware CP6003-SA/RA/RC
Table 1: Terminology and Acronym Definitions (Continued)
TERM or ACRONYM DESCRIPTION
PWR Payload Power.
This powers the host side of the board where the application software runs. It is
granted by the BMC or the SMC after all prerequisites are met. Prerequisites can be,
for example, a closed handle switch, power on the backplane etc.
SDR Sensor Data Record
This is the IPMI data structure that defines a sensor.
SDRR Sensor Data Record Repository
The SDRR is located in the BMC and contains all SDRs of the chassis’ boards that
are administrated. A free Linux utility named “ipmitool” makes a full chassis discovery
and fills the SDRR with the SDRs being found.
SEL System Event Log
The SEL is located in the BMC and keeps track of all events in the chassis. If an
event occurs on any board, the sensor event is sent through the IPMB bus to the
BMC, which additionally stores its own events as well.
SMBIOS System Management BIOS
SMC Satellite Management Controller
Each board is equipped with an IPMI controller acting either as a BMC or as an SMC.
In a CompactPCI chassis, there can be several SMCs. The SMC administrates the
sensor and FRU data of the CP6003-SA/RA/RC and makes it available to the BMC.
Each SMC can be connected to the BMC via a dedicated bus (IPMB-0). The CP6003-
SA/RA/RC’s IPMI controller can be configured to operate in SMC mode or in BMC
mode via an IPMI OEM command or an uEFI Shell command. The factory setting is
SMC.
SMS System Management Software (designed to run under the OS)
SOL Serial over LAN
A serial interface is redirected by LAN using the RMCP+ protocol.
P R E L I M I N A R Y
Page 10 ID 1045-5656, Rev. 2.0
CP6003-SA/RA/RC IPMI Firmware
1.2 Related Publications
The following publications contain information relating to this product.
Table 2: Related Publications
PRODUCT PUBLICATION
IPMI IPMI Specification V2.0
IPMI IPMI- Platform Management FRU Information Storage Definition v1.0,
Document Revision 1.1
IPMI Addenda, Errata, and Clarifications document revision 4 for IPMI v2.0 rev 1.0
specification
IPMI Intelligent Platform Management Bus Communications Protocol Specification v1.0
Document Revision 1.0, November 1999
IPMI IPMB v1.0 Address Allocation Document Revision 1.0, September 1998
PICMG CompactPCI System Management Specification PICMG 2.9 Rev. 1.0
CompactPCI Hot Swap Specification PICMG 2.1 Rev. 2.0
PICMG® AMC.0 R2.0, Advanced Mezzanine Card Base Specification, Nov. 15, 2006
CP6003-SA/RA/RC CP6003-SA/RA/RC User Guide
CP6003-SA/RA/RC uEFI BIOS User Guide
CP6003-SA/RA/RC Linux Board Support Package
IPMI Tools “ipmitool” documentation: http://ipmitool.sourceforge.net
IPMI Tools OpenIPMI documentation: http://www.openipmi.sourceforge.net
1.3 IPMI Overview
This product fully supports the Intelligent Platform Management Interface a nd PICMG 2.9 R1.0
specifications. All of its IPMI functionality operates under an autonomous management
controller even if the board is held in reset or power-down mode by a management card within
a system designed for high availability.
While the CP6003-SA/RA/RC IPMI implementation is fully compliant with IPMI v2.0 and has
been designed to operate with any system management software (SMS) that respects this
specification, can be easily integrated with the Service Availability Forum-Hardware Platform
Interface (SAF-HPI) specification.
More information about Service Availability can be found on the following website:
http://www.saforum.org/home
IPMI is an extensible and open standard that defines autonomous system monitoring. It is au-
tonomous because every management controller within a CompactPCI chassis monitors its
own sensors and sends critical events through a dedicated bus to the BMC that logs it into a
non-volatile System Event Log (SEL). The CP6003-SA/RA/RC IPMI implementation includes
a device SDR repository module that allows the user's system management software to detect
all system components and build a database of all management controller sensors.
P R E L I M I N A R Y
For further information concerning IPMI refer to the following website:
http://www.intel.com/design/servers/ipmi/
ID 1045-5656, Rev. 2.0 Page 11
IPMI Firmware CP6003-SA/RA/RC
BMC
IPMB
Address
Fix: 20h
Backplane
SMC
IPMB
Address:
B0h
(1)
SMC
IPMB
Address:
B2h
(1)
SMC
IPMB
Address:
B4h
(1)
SMC
IPMB address for SMC is determined via the location of the slot in the chassis
IPMB
Address:
B6h
SMC
IPMB
Address:
B8h
(1)
(1)
SMC
IPMB
Address:
BAh
(1)
SMC
IPMB
Address:
BCh
(1)
IPMB 0
IPMB 0
(1)
IPMB 1
2. IPMI Setup
2.1 IPMI in a CompactPCI Chassis
Kontron's IPMI implementation in the CompactPCI environment is compliant with the PICMG
2.9 R1.0 specification. This specification defines the pinout of the J1 and J2 Comp actPCI connectors as well as the addressing scheme. There should be only one BMC in the chassis, or at
least on the IPMB segment. The BMC may reside either on an CP6003-SA/RA/RC, or on an
external system management card, or in a shelf management controller (ShMC). The specification allows all of these variants. As a BMC in the system slot, the CP6003-SA/RA/RC supports dual-ported IPMB (IPMB-0 to the SMCs and IPMB-1 to the external segments via the
CompactPCI backplane connector in accordance with PICMG 2.9).
To use the IPMI resources in a rack requires an initial setup for IPMI operation. The following
actions must first be performed to achieve operable IPMI functionality.
P R E L I M I N A R Y
2.2 IPMI Setup for the CP6003-SA/RA/RC
Initially the default configuration for the IPMI controller of the CP6003-SA/RA/RC is:
• IRQ = none
• MODE = SMC
• IPMB = single-ported.
If this is the required configuration, no further action is required. If the configuration must be
modified, either the kipmi uEFI Shell command or on e of the open tools “ipmitool” or “ipmicmd”
may be used to modify the configuration as required.
Page 12 ID 1045-5656, Rev. 2.0
CP6003-SA/RA/RC IPMI Firmware
Fur further information on the kipmi uEFI Shell command, refer to the CP6003-SA/RA/RC uEFI
BIOS User Guide. When uEFI BIOS stores the configuration, it creates an “IPMI Device Information Record” entry in the SMBIOS table. This record contains information, among others,
about:
• Type of the supported interface (KCS style)
• Selected interrupt (10, 11 or none).
This information is required by the CP6003-SA/RA/RC payload’s IPMI OS kernel drivers for
Linux during their loading time. After the loading, most available IPMI communications tools
which access the IPMI controller via IPMI OS drivers should work (e.g. “ipmicmd”, “ipmitool”,
etc.).
Now it is possible to use such a tool to issue the Set Firmware Parameters OEM IPMI
command to modify the configuration again. Changing the interrupt number always requires a
uEFI BIOS restart for a correct setup of the SMBIOS table.
2.3 IPMI Setup for the Rack
For a working IPMI configuration the SDRR of the BMC must be filled with all sensor data records of all IPMI controllers in the rack. After every system start the BMC uses the SDRR to
initialize all sensors of all boards. The SDRR setup must be done by a management tool e.g.
the open Linux tool “ipmitool”. Then the command is:
ipmitool sdr fill sensors
This will work only if the IPMI controller configured as BMC is addressed. This addressing is
the default if the “ipmitool” is running on the payload side of the board where the BMC is residing.
3. IPMI Controller Hardware
On the CP6003-SA/RA/RC, the IPMI controller is implemented using the NXP ARM7 microcontroller with 512 kB of internal flash and 56 kB of RAM.
An external 64 kB serial EEPROM chip is used for firmware private data and FRU inventory
storage. An additional external 2 MB serial SPI flash is used for redundant firmware image storage.
The IPMI controller implements a local Keyboard Controller Style (KCS) interface (KCS) with
interrupt support for communication with system-side management software and the uEFI BIOS. The IPMB bus is used for interconnection with the BMC or the shelf manager.
IPMI over LAN (IOL) and Serial Over LAN (SOL) are supported on four Ethernet channels
(GbE A – GbE D) of the board. SOL is only available on one Ethernet channel at a time.
P R E L I M I N A R Y
The IPMI controller provides access to various board sensors which permit the monitoring of:
• System power voltages: 5V (PWR), 3.3V, IPMI 5V, 12V, IPMI controller supply 4.7V
• Temperatures: CPU die, chipset, and board temperature
• Power Good, IPMB-0 link, board reset, POST code, boot error, CPU states (processor
hot, THERMTRIP, …), IPMB-L state, Health error, IPMI watchdog etc.
ID 1045-5656, Rev. 2.0 Page 13
IPMI Firmware CP6003-SA/RA/RC
4. IPMI Firmware
4.1 Key Features
The following are key features of the CP6003-SA/RA/RC’s IPMI firmware:
• Compliant with IPMI specification 2.0
• Compliant with PICMG 2.9 specification
• Firmware designed and specially made for CompactPCI implementation and easy
integration with SAF-HPI
• KCS SMS interface with interrupt support
• Dual-port IPMB support
• Out-of-band management and monitoring using the IPMB interface permits access to
sensors regardless of the board's CPU state
• Sensor thresholds fully configurable
• Sensor names prefixed with identification of owner (BMC without slot number or SMC
with slot number)
• Complete IPMI watchdog functionality
• Complete SEL, SDR repository and FRU functionality on BMC
• Complete FRU functionality
• Master Write-Read I
EEPROM, FAN)
• Two IPMI firmware banks allow an automatic backup
This allows manual and automatic firmware image roll-back (in case of an upgrade
failure).
• The downloading of a new firmware image does not break currently running firmware or
payload activities.
• Firmware bank management is done by the open tool “ipmitool” function “fwum” which
can update the firmware in the field.
• Firmware fully customizable via OEM IPMI commands to satisfy customer requirements
P R E L I M I N A R Y
• Interoperable with other IPMI solutions
• OEM board supervision and control extensions such as boot flash selection and firmware
boot order configuration
• Automatic switching to an alternative uEFI image after having detected an inoperable
uEFI BIOS
• IPMI over LAN (IOL) support
• Serial over LAN (SOL) support
2
C support for external I2C devices communications (FRU,
• Graceful shutdown support
• Handle switch and blue Hot Swap LED operation
• The I0 and I1 LEDs indicate operational status of the IPMI firmware.
• The board's write protection feature for non-volatile memories is supported. These
memories are:
2
•I
C EEPROM for FRU data and parameters
• SPI flash memory for firmware banks
Page 14 ID 1045-5656, Rev. 2.0
Loading...