Kontron AM4010 User Manual

IPMI Firmware User Guide

for the

AM4010

Module

Manual ID: 36363, Rev. Index 1.1

Firmware: SK-IPMI-AM4010, EKS Idx 0101

June 12, 2007

IPMI Firmware User Guide: AM4010

1. Copyright

contents or use of this manual, and specifically disclaims any express or implied warranties of merchantability or fitness for any particular purpose.

Kontron Modular Computers makes no representations or warranties with respect to this embedded Linux package, and specifically disclaims any express or implied warranties of merchantability or fitness for any particular purpose.

Permission is granted to make and distribute verbatim copies of this manual provided that the copyright notice and this permission notice are preserved on all copies.

Permission is granted to copy and distribute modified versions of this documentation under the conditions for verbatim copying, provided also that the entire resulting derived work is distributed under the terms of a permission notice identical to this one.

Permission is granted to copy and distribute translations of this documentation into another language, under the above conditions for modified versions.

The PICMG® and CompactPCI® names and the PICMG®, CompactPCI®, ATCA®, and AdvancedTCA® logos are registered trademarks and AdvancedMC is a trademark of the PCI Industrial Computer Manufacturers Group.

Intel is a registered trademark of Intel Corporation. I2C is a trademark of Phillips Semiconductors. Linux is a registered trademark of Linus Torvalds. All other trademarks, registered trademarks, and trade names are the property of their

respective owners.

2. Revision History

IPMI Firmware User Guide: AM4010

Manual/Product Title:

Manual ID Number: xxxxx

Revision Index Brief Description of Changes Date of Issue

Draft / 0.0 Initial Issue May 3, 2007

1.0 Completed May 22, 2007

1.1 Revised June 12, 2007

IPMI Firmware User Guide for the AM4010 Module

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 © 2007 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.

IPMI Firmware User Guide: AM4010

3. Contents

1. Copyright............................................................................................................................2

2. Revision History.................................................................................................................3

3. Contents..............................................................................................................................4

4. Introduction ........................................................................................................................6

4.1 Acronym Definitions..................................................................................................6

4.2 Related Documentation..............................................................................................7

5. Introduction ........................................................................................................................8

5.1 IPMI in AdvancedMC / AdvancedTCA Environment...............................................8

5.2 The Module Management Controller Hardware ........................................................8

6. MMC Firmware..................................................................................................................9

6.1 Key Features...............................................................................................................9

6.2 Supported IPMI Commands.....................................................................................10

6.2.1 Standard commands..........................................................................................10

6.2.2 OEM Commands and Extensions.....................................................................17

6.2.2.1 Get Device ID command with OEM extensions..........................................17

6.2.2.2 Set Firmware Parameters..............................................................................18

6.2.2.3 Set Control State (Firmware Hub, Boot Order)............................................19

6.2.2.4 Get Control State (Firmware Hub, Boot Order)...........................................19

6.2.2.5 OEM Module Quiescence Feedback............................................................20

6.3 Sensors Implemented on the AM4010.....................................................................22

6.3.1 Sensor List........................................................................................................22

6.3.2 OEM Event / Reading Types............................................................................25

6.4 Firmware Code.........................................................................................................27

6.4.1 Structure and functionality ...............................................................................27

6.4.2 Firmware Upgrade............................................................................................27

6.5 Firmware Configuration...........................................................................................27

6.6 Firmware / Module Identification ............................................................................28

6.7 FRU Information ......................................................................................................28

6.7.1 Structure and functionality ...............................................................................28

6.7.2 Download .........................................................................................................28

6.8 E-Keying...................................................................................................................29

6.9 PCI Express Clock Source........................................................................................29

6.10 BIOS Supervisory and Automated Firmware Hub Switch.......................................29

IPMI Firmware User Guide: AM4010

6.11 Hot Swap ..................................................................................................................29

6.12 LAN functions..........................................................................................................31

6.12.1 Overview ..........................................................................................................31

6.12.2 Setting up the Ethernet channel........................................................................31

6.12.2.1 Setup by BIOS menu................................................................................31

6.12.2.2 Setup by ipmitool or IPMI commands .....................................................31

6.12.3 Setup of user and password..............................................................................31

6.12.4 IPMI over LAN (IOL)......................................................................................32

6.12.5 Serial over LAN (SOL) ....................................................................................32

6.13 OS Support / Tools...................................................................................................33

6.13.1 DOS..................................................................................................................33

6.13.2 Linux.................................................................................................................33

6.13.3 Windows...........................................................................................................33

7. IPMI Communication LEDs.............................................................................................34

IPMI Firmware User Guide: AM4010

4. Introduction

4.1 Acronym Definitions

AMC Advanced Mezzanine Card BSP Board Support Package DMI Desktop Management Interface FRU Field Replaceable Unit FWH Firmware Hub

C Inter-Integrated Circuit

I 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 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 controll er located on the AMC mo dule MP Management Power PICMG PCI Industrial Computer Manufacturer Group PWR Payload Pow er SDR Sensor Data Record SDRR Sensor Data Record Repository 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 RM CP+ protocol.

IPMI Firmware User Guide: AM4010

4.2 Related Documentation

IPMI specifications: (http://www.intel.com/design/servers/ipmi/spec.htm)

• IPMI-Intelligent Platform Management Interface Specification. Second Generation

v2.0, February 12, 2004 (part)

• [2] IPMI- Platform Management FRU Information Storage Definition v1.0,

Document Revision 1.1, September 1999

PICMG specifications: http://www.picmg.org

• PICMG® AMC.0 R1.0 - Advanced Mezzanine Card Base Specification

• PICMG® AMC.1 R1.0 - PCI Express and Advanced Switching on AdvancedMC

• PICMG® AMC.2 R1.0 – AMC Gigabit Ethernet/10 Gigabit XAUI Ethernet

Open tool’s documentation

• [1] Ipmitool documentation: http://ipmitool.sourceforge.net

• OpenIPMI documentation: http://www.openipmi.sourceforge.net

Kontron manuals and specifications: http://www.kontron.com/

• AM4010 User’s Guide

• [3] AM4010 Linux Board Support Package

As a hot-swappable field replaceable unit (FRU), the AM4010 follows the stringent carrier grade RASM feature set, namely - Reliability, Availability, Serviceability, Maintainability.

Built in accordance to the AMC.0 specification, the AM4010 is also AMC.1 and AMC.2 compliant and is easily managed via IPMI v1.5/v2.0.

As with every Advanced Mezzanine Card (AMC) the AM4010 is equipped with a Module Management Controller (MMC).

IPMI Firmware User Guide: AM4010

5. Introduction

5.1 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.

5.2 The Module Management Controller Hardware

On the AM4010 module, the MMC is implemented using the Renesas H8S/2166 controller with 512 kB of internal flash and 40 kB of RAM. An additional 1 MB serial EEPROM chip provides redundant firmware image storage. A separate 32 kB serial EEPROM chip is used for firmware private data and 4 kB FRU Inventory storage.

The MMC circuit implements two local Keyboard Style Interfaces (KCS) with interrupt support for communication with system side management software and the IPMB-L bus for interconnection with the IPMC.

IPMI over LAN (IOL) is supported by two Ethernet channels. The MMC implements a wide range of sensors that permit the monitoring of:

• main power voltages: +12V (PWR), +5V, +3.3V, +3.3V (MP), +1.5V, +1.8V,

+0.9V (DDR)

• temperatures: CPU die, MCH die, board inlet and outlet near CPU, board inlet and

outlet near MCH

• Power Good, LAN links, IPMB link, NMI and SMI lines, board reset, post code,

boot error, processor hot (>100 °C), IPMB-L state, Health error, IPMI watchdog etc.

6. MMC Firmware

6.1 Key Features

• compliant with the related IPMI and PICMG® specifications (refer to 4.2, Related

Documentation)

• firmware designed and specially made for AdvancedMC environments

• supports two KCS interfaces 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 module 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

R9…R12

IPMI Firmware User Guide: AM4010

• complete IPMI watchdog functionality

• complete FRU functionality (refer to 6.7)

• firmware can be updated in the field (refer to 6.4.2)

• two firmware banks implemented, firmware bank management is done by the open

tool ipmitool (function fwum) [1] (refer to 6.4.1)

• downloading new firmware image does not break currently running firmware

activities (refer to 6.4.2).

• manual and automatic firmware image roll-back (in case of upgrade failure). Refer

to 6.4.2.

• firmware customizable per BIOS menu or per OEM IPMI commands (refer to 6.5)

• interoperable with other AMC, ATCA, or IPMI solutions

• OEM board supervision and control extensions such as firmware hub select and

boot order configuration (refer to 6.2.2)

• BIOS supervisor and automated switch to recover image from second firmware

hub (refer to 6.10)

• Serial over LAN (SOL, refer to 6.12.5) support

• IPMI over LAN (IOL, refer to 6.12.4) support

• Graceful shutdown support (refer to 6.11)

• “Health” LED shows heartbeat and pulses if a KCS interface is active. The “out-

of-service” (OOS) LED pulses when IPMB-L is active (refer to 7).

• If the carrier supplies an external clock 3 the module will use it. Otherwise the

module will use the internal PCIe clock (refer to 6.9).

IPMI Firmware User Guide: AM4010

6.2 Supported IPMI Commands

6.2.1 Standard commands

Part of the command list in IPMI specification 2.0 M = mandatory, O = optional

IPMI 2.0 Spec. section

NetFn CMD

Kontron support On MMC

IPM Device “Global” Commands

Get Device ID 20.1 App 01h M / Yes [3] Cold Reset 20.2 App 02h

Warm Reset 20.3 App 03h Get Self Test Results 20.4 App 04h Manufacturing Test On 20.5 App 05h Set ACPI Power State 20.6 App 06h Get ACPI Power State 20.7 App 07h Get Device GUID 20.8 App 08h

Broadcast “Get Device ID”

BMC Watchdog Timer Commands

Reset Watchdog Timer 27.5 App 22h O / Yes Set Watchdog Timer 27.6 App 24h

Get Watchdog Timer 27.7 App 25h

20.9 App 01h

O / Yes O / No O / Yes O / No O / No O / No O / No M / Yes

O / Yes O / Yes

IPMI Firmware User Guide: AM4010

BMC Device and Messaging Commands

Set BMC Global Enables 22.1 App 2Eh O / Yes

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 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 Get System GUID 22.14 App 37h Get Channel Authentication

Capabilities Get Session Challenge 22.15 App 39h Activate Session 22.17 App 3Ah Set Session Privilege Level 22. 18 App 3Bh Close Session 22.19 App 3Ch Get Session Info 22.20 App 3Dh Get AuthCode 22.21 App 3Fh Set Channel Access 22.22 App 40h Get Channel Access 22.23 App 41h Get Channel Info 22.24 App 42h Set User Access 22.26 App 43h Get User Access 22.27 App 44h Set User Name 22.28 App 45h Get User Name 22.29 App 46h Set User Password 22.30 App 47h

Activate Payload 24.1 App 48h Deactivate Payload 24.2 App 49h Get Payload Activation Status 24.4 App 4Ah Get Payload Instance Info 24.5 App 4Bh Set User Payload Access 24.6 App 4Ch Get User Payload Access 24.7 App 4Dh Get Channel Payload Support 24.8 App 4Eh Get Channel Payload Version 24.9 App 4Fh Get Channel OEM Payload Info 24.10 App 50h Master Write-Read 22.11 App 52h

Get Channel Cipher Suits 22.15 App 54h Suspend/Resume Payload

Encryption Set Channel Security Keys 22.25 App 56h

Get System Interface Capabilities 22.9 App 57h

22.13 App 38h

24.3 App 55h

O / Yes O / Yes O / Yes O / Yes O / Yes O / Yes O / Yes O / Yes O / No O / Yes

O / Yes O / Yes O / Yes O / Yes O / Yes O / No O / Yes O / Yes O / Yes O / Yes O / Yes O / Yes O / Yes O / Yes

O / Yes O / Yes O / Yes O / Yes O / Yes O / Yes O / Yes O / Yes O / No O / Yes

O / No O / Yes

O / No O / No

+ 23 hidden pages

Kontron AM4010 User Manual

Specifications and Main Features

Frequently Asked Questions

User Manual