Kontron AM4120 User Manual
» User Guide «
AM4120
IPMI Firmware
Doc. ID: 1045-9586, Rev. 1.0
November 3, 2011
If it’s embedded, it’s Kontron.
Preface AM4120 IPMI Firmware
Revision History
Publication Title:
Doc. ID: 1045-9586
Rev. Brief Description of Changes Date of Issue
1.0 Initial issue 3-Nov-2011
AM4120 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 web site:
www.kontron.com.
Disclaimer
Copyright © 2011 Kontron AG. All rights reserved. All data 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 ii ID 1045-9586, Rev. 1.0
AM4120 IPMI Firmware Preface
Table of Contents
Revision History .........................................................................................................ii
Imprint ........................................................................................................................ii
Disclaimer ..................................................................................................................ii
Table of Contents ......................................................................................................iii
List of Tables ..............................................................................................................v
1. Introduction ...................................................................................1
1.1 Terminology and Acronym Definitions .......................................................... 1
1.2 Related Publications .................................................................................... 2
1.3 IPMI in AdvancedMC / AdvancedTCA Environment .................................... 2
1.4 Module Management Controller Hardware .................................................. 2
2. MMC Firmware ...............................................................................3
2.1 Key Features ................................................................................................ 3
2.2 Supported IPMI and ATCA Commands ........................................................ 4
2.2.1 Standard IPMI Commands ................................................................... 4
2.2.2 AdvancedTCA and AMC Commands ................................................ 12
3. OEM Commands and Command Extensions ...........................14
3.1 Get Device ID Command with OEM Extensions ........................................ 14
3.2 Set Control State (Firmware Hub, Boot Order) .......................................... 15
3.3 Get Control State (Firmware Hub, Boot Order) .......................................... 16
3.4 OEM Module Quiescence Feedback ......................................................... 17
3.4.1 Usage if a Shutdown Daemon is Announced as Present .................. 18
3.4.2 Usage if no Shutdown Daemon is Announced as Present ................ 18
4. Sensors Implemented on the AM4120 .......................................19
4.1 Sensor List ................................................................................................. 20
4.2 Sensor Thresholds ..................................................................................... 22
4.3 OEM Event/Reading Types ........................................................................ 24
ID 1045-9586, Rev. 1.0 Page iii
Preface AM4120 IPMI Firmware
5. Firmware Code ............................................................................ 26
5.1 Structure and Functionality .........................................................................26
5.2 Firmware / Module Identification .................................................................26
5.3 Firmware Upgrade ......................................................................................27
5.3.1 Firmware File Formats .......................................................................27
5.3.2 Firmware Upgrade - “ipmitool hpm” ...................................................28
5.3.3 Firmware Upgrade - “ipmitool fwum” ..................................................29
6. FRU Information ......................................................................... 29
6.1 FRU Version Identification ..........................................................................29
6.2 FRU Data Update .......................................................................................30
7. E-Keying ...................................................................................... 30
7.1 Board Configuration for E-Keying ...............................................................30
7.2 PCI Express Reference Clock - FCLKA .....................................................30
8. U-Boot Failover Control - Automatic Flash Selection ............. 31
9. Hot Swap ..................................................................................... 31
9.1 General .......................................................................................................31
9.2 OS Requirements for Graceful Shutdown ..................................................32
10. OS Support / Tools ..................................................................... 32
10.1 Linux Tools ..................................................................................................32
10.2 OS Support - Board Support Packages ......................................................32
11. IPMI Module Management LEDs ............................................... 33
Page iv ID 1045-9586, Rev. 1.0
AM4120 IPMI Firmware Preface
List of Tables
1 Terminology and Acronym Definitions ............................................................ 1
2 Related Publications ...................................................................................... 2
3 Standard IPMI Commands ............................................................................. 4
4 AdvancedTCA and AMC Commands .......................................................... 12
5 Get Device ID Command with OEM Extensions .......................................... 14
6 Set Control State .......................................................................................... 15
7 Get Control State ......................................................................................... 16
8 OEM Module Quiescence Feedback ........................................................... 17
9 Sensor Name Prefix ..................................................................................... 19
10 Sensor List ................................................................................................... 20
11 Thresholds - Standard Temperature Range ................................................. 22
12 Thresholds - Extended Temperature Range ................................................ 22
13 Voltage Sensor Thresholds .......................................................................... 23
14 OEM Event/Reading Types .......................................................................... 24
15 IPMI Module Management LED Functions .................................................. 34
ID 1045-9586, Rev. 1.0 Page v
Preface AM4120 IPMI Firmware
This page has been intentionally left blank.
Page vi ID 1045-9586, Rev. 1.0
AM4120 IPMI Firmware Functional Description
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/ ACRONYM DESCRIPTION
AMC Advanced Mezzanine Card
BMC Baseboard Management Controller
BSP Board Support Package
FRU Field Replaceable Unit
FWH Firmware Hub
2
I
C
IPMB Intelligent Platform Management Bus
IPMB-0 AdvancedTCA shelf-level IPMB
IPMB-L Local, on-carrier IPMB that links the carrier IPMC with the MMCs of installed modules
IPMC Intelligent Platform Management Controller located on the AMC carrier
IPMI Intelligent Platform Management Interface
IOL IPMI over LAN. An MMC is accessed via LAN, not IPMB.
KCS Keyboard Controller Style
MMC Module Management Controller – an IPMI controller located on the AMC module
MP Management Power
PICMG PCI Industrial Computer Manufacturer Group
PWR Payload Power
SDR Sensor Data Record
SDRR Sensor Data Record Repository
Inter-Integrated Circuit
SEL System Event Log
SMBIOS System Management BIOS
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.
ID 1045-9586, Rev. 1.0 Page 1
Functional Description AM4120 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
MicroTCA PICMG® MTCA.0 Micro Telecommunications Computing Architecture R1.0
AMC PICMG® AMC.0, Advanced Mezzanine Card Specification R2.0
PICMG® AMC.1, PCI Express R2.0
PICMG® AMC.2, Gigabit Ethernet R1.0
PICMG® AMC.4, Serial RapidIO, Rev 1.0
AM4120 AM4120 User Guide, ID 1045-6958
Kontron’s “U-Boot” Bootloader User Guide, ID 1046-1856
IPMI Tools ipmitool documentation: http://ipmitool.sourceforge.net
IPMI Tools OpenIPMI documentation: http://www.openipmi.sourceforge.net
As a hot-swappable field-replaceable unit (FRU), the AM4120 follows the stringent carrier
grade RASM feature set, namely - Reliability, Availability, Serviceability, Maintainability.
Built in accordance with the AMC.0 specification, the AM4120 is also compliant with the AMC.1,
AMC.2 and AMC.4 specifications and is easily managed via its management features.
As with every Advanced Mezzanine Card (AMC), the AM4120 is equipped with a Module Management Controller (MMC).
1.3 IPMI in AdvancedMC / AdvancedTCA Environment
The Module Management Controller is a crucial component of any AMC module. Besides acting as a regular IPMI management controller (sensor monitoring, event logging, etc.), it also
provides an interface to all necessary data related to module power requirements and implemented interfaces (E-Keying). Further, it plays an active role in the module hot swap state management. The carrier IPMI Controller (IPMC) communicates with the MMC using the local IPMB
(IPMB-L) bus. In an ATCA/AMC environment, it is the IPMC that actually turns on/off module
(payload) power. However, before the IPMC enables the module payload power, various criteria must be satisfied by both the carrier and the module, including power requirements and capabilities, matching interfaces, current module hot swap state, and any other special conditions
as specified by the Shelf Manager policy.
1.4 Module Management Controller Hardware
On the AM4120 processor AMC module, the MMC is implemented using an NXP® ARM7
microcontroller with 512 kB of internal flash and 56 kB of RAM.
Page 2 ID 1045-9586, Rev. 1.0
AM4120 IPMI Firmware Functional Description
An external 64 kB serial EEPROM chip is used for firmware private data and for FRU inventory
storage. Furthermore, an external 4 MB serial SPI flash is used for additional firmware image
storage.
The MMC implements one local Keyboard Controller Style (KCS) interface with interrupt support for communication with the system side management software and the U-Boot bootloader.
The IPMB-L bus is used for interconnection with the IPMC.
The MMC provides access to various sensors which permit the monitoring of:
• System power voltages: +12V (PWR), +5V, +3.3V, +3.3V (MP)
• Temperatures: board and airflow near AMC edge-connector
• Power Good, LAN links, board reset, IPMB-L state, Health error, IPMI watchdog, Firmware update/rollback, etc.
2. MMC Firmware
2.1 Key Features
The following are key features of the AM4120 MMC firmware:
• Compliant with the related IPMI and PICMG® specifications
• Firmware designed and specially made for AdvancedMC environments (ATCA, µTCA)
• Supports one KCS interface with interrupt support
• Supports the local IPMB (IPMB-L) interface
• Out-of-Band management and monitoring using IPMB-L interface permits access to
sensors regardless of the module’s CPU state
• Sensor thresholds fully configurable
• Sensor names prefixed with AMC module Bay ID (A1…4, B1…4)
• Usable in µTCA slots 1…12. Sensor names for slots 9…12 are prefixed with C1…C4
• Complete IPMI watchdog functionality
• Complete FRU functionality
• Firmware can be updated in the field
• Firmware image management may be done by the open tool “ipmitool” (functions “hpm”
or “fwum”)
• Downloading new firmware image does not break currently running firmware activities
• Manual and automatic firmware image roll-back in case of upgrade failure
• Interoperable with other AMC, ATCA, or IPMI solutions
• U-Boot fail-over control for automatic U-Boot firmware bank switching after having
detected a non-working U-Boot
• OEM commands for U-Boot firmware bank selection
• Graceful shutdown support
• The “Health” LED shows MMC's heartbeat and pulses on KCS interface traffic
ID 1045-9586, Rev. 1.0 Page 3
Functional Description AM4120 IPMI Firmware
2.2 Supported IPMI and ATCA Commands
2.2.1 Standard IPMI Commands
The following table shows an excerpt from the command list specified in the IPMI specification
2.0. The shaded table cells indicate commands supported by the AM4120 MMC.
M = mandatory, O = optional
Table 3: Standard IPMI Commands
IPMI 2.0
COMMAND
SPEC.
NETFN CMD
SECTION
IPM DEVICE “GLOBAL” COMMANDS M
Get Device ID 20.1 App 01h
Cold Reset 20.2 App 02h
Warm Reset 20.3 App 03h O / No
Get Self Test Results 20.4 App 04h
Manufacturing Test On 20.5 App 05h O / No
Set ACPI Power State 20.6 App 06h O / No
Get ACPI Power State 20.7 App 07h O / No
Get Device GUID 20.8 App 08h O / No
Broadcast “Get Device ID” 20.9 App 01h
BMC WATCHDOG TIMER COMMANDS
KONTRON
SUPPORT
ON MMC
M / Yes
O / Yes
O / Yes
M / Yes
O
Reset Watchdog Timer 27.5 App 22h
Set Watchdog Timer 27.6 App 24h
Get Watchdog Timer 27.7 App 25h
BMC DEVICE AND MESSAGING COMMANDS O
Set BMC Global Enables 22.1 App 2Eh
Get BMC Global Enables 22.2 App 2Fh
Clear Message Flags 22.3 App 30h
Get Message Flags 22.4 App 31h
Enable Message Channel Receive 22.5 App 32h
Page 4 ID 1045-9586, Rev. 1.0
O / Yes
O / Yes
O / Yes
O / Yes
O / Yes
O / Yes
O / Yes
O / Yes
AM4120 IPMI Firmware Functional Description
Table 3: Standard IPMI Commands (Continued)
IPMI 2.0
COMMAND
SPEC.
NETFN CMD
SECTION
Get Message 22.6 App 33h
Send Message 22.7 App 34h
Read Event Message Buffer 22.8 App 35h
Get BT Interface Capabilities 22.9 App 36h O / No
Get System GUID 22.14 App 37h O / No
Get Channel Authentication Capabilities 22.13 App 38h O / No
Get Session Challenge 22.15 App 39h O / No
Activate Session 22.17 App 3Ah O / No
Set Session Privilege Level 22.18 App 3Bh O / No
Close Session 22.19 App 3Ch O / No
Get Session Info 22.20 App 3Dh O / No
KONTRON
SUPPORT
ON MMC
O / Yes
O / Yes
O / Yes
Get AuthCode 22.21 App 3Fh O / No
Set Channel Access 22.22 App 40h O / No
Get Channel Access 22.23 App 41h O / No
Get Channel Info 22.24 App 42h O / No
Set User Access 22.26 App 43h O / No
Get User Access 22.27 App 44h O / No
Set User Name 22.28 App 45h O / No
Get User Name 22.29 App 46h O / No
Set User Password 22.30 App 47h O / No
Activate Payload 24.1 App 48h O / No
Deactivate Payload 24.2 App 49h O / No
Get Payload Activation Status 24.4 App 4Ah O / No
Get Payload Instance Info 24.5 App 4Bh O / No
Set User Payload Access 24.6 App 4Ch O / No
Get User Payload Access 24.7 App 4Dh O / No
ID 1045-9586, Rev. 1.0 Page 5
Functional Description AM4120 IPMI Firmware
Table 3: Standard IPMI Commands (Continued)
IPMI 2.0
COMMAND
SPEC.
NETFN CMD
SECTION
Get Channel Payload Support 24.8 App 4Eh O / No
Get Channel Payload Version 24.9 App 4Fh O / No
Get Channel OEM Payload Info 24.10 App 50h O / No
Master Write-Read 22.11 App 52h O / No
Get Channel Cipher Suits 22.15 App 54h O / No
Suspend/Resume Payload Encryption 24.3 App 55h O / No
Set Channel Security Keys 22.25 App 56h O / No
Get System Interface Capabilities 22.9 App 57h O / No
CHASSIS DEVICE COMMANDS O
Get Chassis Capabilities 28.1 Chassis 00h
Get Chassis Status 28.2 Chassis 01h
KONTRON
SUPPORT
ON MMC
O / Yes
O / Yes
Chassis Control 28.3 Chassis 02h
Chassis Reset 28.4 Chassis 03h O / No
Chassis Identify 28.5 Chassis 04h O / No
Set Chassis Capabilities 28.7 Chassis 05h O / No
Set Power Restore Policy 28.8 Chassis 06h O / No
Get System Restart Cause 28.11 Chassis 07h O / No
Set System Boot Options 28.12 Chassis 08h O / No
Get System Boot Options 28.13 Chassis 09h O / No
Get POH Counter 28.14 Chassis 0Fh
EVENT COMMANDS M
Set Event Receiver 29.1 S/E 00h
Get Event Receiver 29.2 S/E 01h
Platform Event (a.k.a. “Event Message”) 29.3 S/E 02h
O / Yes
O / Yes
M / Yes
M / Yes
M / Yes
Page 6 ID 1045-9586, Rev. 1.0
Loading...