» User Guide « IPMI Firmware User Guide for the CP6002 CPU Board Doc.ID: 1039-1613, Rev. 2.0 October 26, 2012 If it’s embedded, it’s Kontron.
IPMI Firmware User Guide CP6002 Revision History Publication Title: IPMI Firmware User Guide for the CP6002 CPU Module Doc. ID: 1039-1613 Rev. Brief Description of Changes Date of Issue 1.0 Initial issue 21-Oct-2010 2.0 Various minor changes incorporated 26-Oct-2012 Imprint Kontron Europe GmbH may be contacted via the following: MAILING ADDRESS TELEPHONE AND E-MAIL Kontron Europe GmbH +49(0)800-SALESKONTRON Sudetenstraße 7 sales@kontron.
CP6002 IPMI Firmware User Guide Table of Contents Revision History ........................................................................................................ 2 Imprint ....................................................................................................................... 2 Disclaimer ................................................................................................................. 2 Table of Contents .............................................................
IPMI Firmware User Guide 6. CP6002 Hot Swap and Shut Down ........................................................................... 16 6.1 Hot Swap Handle and Hot Swap (Blue) LED ............................................. 16 6.2 The Hot Swap and Shut Down Processes ................................................. 17 7. Setting of the SEL time ................................................................................ 18 8. XMC Card Support ..................................................
CP6002 IPMI Firmware User Guide List of Tables 1 Terminology and Acronym Definitions ........................................................... 7 2 Related Publications ..................................................................................... 9 3 Standard IPMI Commands .......................................................................... 19 4 AdvancedTCA and AMC Commands ......................................................... 25 5 Get Device ID Command with OEM Extensions ....
IPMI Firmware User Guide CP6002 This page has been intentionally left blank. Page 6 ID: 1039-1613, Rev. 2.
CP6002 IPMI Firmware User Guide 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 BMC DESCRIPTION Baseboard Management Controller In a compact CPCI chassis, there can be only one BMC present. The BMC administrates the SEL and the SDRR for the complete system.
IPMI Firmware User Guide Table 1: Terminology and Acronym Definitions TERM or ACRONYM SDR CP6002 DESCRIPTION Sensor Data Record This is the IPMI data structure that defines a sensor. SDRR Sensor Data Record Repository Is the device in the BMC where all SDRs of the chassis’ boards are administrated. A free Linux utility named ‘ipmitool’ makes a full chassis discovery and fills the SDRR with the SDRs being found. The factory default repository contains only the local board’s SDRs.
CP6002 1.2 IPMI Firmware User Guide Related Publications The following publications contain information relating to this product. Table 2: Related Publications PRODUCT PUBLICATION IPMI IPMI Specification V2.0 (without LAN support) 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.
IPMI Firmware User Guide CP6002 2. IPMI Setup 2.1 IPMI in a Compact PCI 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 CompactPCI 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 CP6002, or on an external system management card, or in a shelf management controller (ShMC).
CP6002 IPMI Firmware User Guide To use the “kipmi” command, refer to the CP6002 uEFI BIOS User Guide. When EFI stores the configuration, it creates an ‘IPMI Device Information Record’ entry in the SMBIOS table. This record contains information about (among others): • Type of the supported interface (KCS style) • Selected interrupt (10, 11 or none). This information is required by the CP6002 payload’s IPMI OS kernel drivers for Linux during their loading time.
IPMI Firmware User Guide 3. CP6002 Board Management Controller Hardware On the CP6002 CPU board, the BMC 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 for FRU Inventory storage. An additional external 4 MB serial SPI-Flash is used for redundant firmware image storage.
CP6002 IPMI Firmware User Guide • 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 • FRU data can be updated in the field by the open tool ‘ipmitool’ function ‘fru write’ • Interoperable with other IPMI solutions OEM board supervision and control e
IPMI Firmware User Guide 4.2.2 CP6002 Firmware Upgrade Firmware upgrading is only possible when write protection is not set. The standard way to upgrade the IPMI controller's operational code is to use the open tool ‘ipmitool’ together with an image file. ‘ipmitool’ allows the downloading (‘ipmitool fwum download …’) and activation (‘ipmitool fwum upgrade’) of the new operational code and saves an existing one.
CP6002 IPMI Firmware User Guide • The contents of a user (payload) writeable register (refer to the CP6002 User Guide) defines which Boot Flash to use. This is the primary selection. • The firmware's parameter EEPROM contains a parameter whose value is used to determine whether or not to invert the primary selection register's contents when the Management Controller's firmware selects the Boot Flash.
IPMI Firmware User Guide 5. CP6002 Communication Between the Management Controller and EFI For communication between EFI and the Management Controller there is a “private” KCS interface. During the boot process the EFI sends the following IPMI commands to the Management Controller: • An OEM command which reports a good or a bad checksum. • A Standard IPMI command “Set Watchdog Timer” to stop a possibly running IPMI watchdog timer.
CP6002 IPMI Firmware User Guide Normally the logical states “active” and “inactive” of a payload are identical to the physical states “handle open” and “handle closed” or “payload power off” and “payload power on”. If, however, power is switched on or off using IPMI chassis commands or the payload is shut down by the OS, then the position of the Hot Swap Handle and the power state may become asynchronous.
IPMI Firmware User Guide CP6002 When the handle is opened, the Management Controller asserts the “power button” signal to notify the OS. The OS then shuts down all processes and afterwards causes the transmission of the IPMI command “Set ACPI Power State / S3/G2 soft off” to the Management Controller which then switches the power off. 7. Setting of the SEL time The Management Controller does not have its own hardware real time clock.
CP6002 IPMI Firmware User Guide 9. Supported IPMI and ATCA Commands 9.1 Standard IPMI Commands Part of the command list in IPMI specification 2.0 M = mandatory, O = optional Table 3: Standard IPMI Commands COMMAND IPMI 2.0 SPEC. SECTION NETFN CMD IPM DEVICE “GLOBAL” COMMANDS KONTRON SUPPORT ON BMC M Get Device ID 20.1 App 01h M / Yes [1] Cold Reset 20.2 App 02h O / Yes Warm Reset 20.3 App 03h O / No Get Self Test Results 20.4 App 04h O / Yes Manufacturing Test On 20.
IPMI Firmware User Guide Table 3: CP6002 Standard IPMI Commands IPMI 2.0 SPEC. SECTION NETFN CMD KONTRON SUPPORT ON BMC Get Message 22.6 App 33h O / Yes Send Message 22.7 App 34h O / Yes Read Event Message Buffer 22.8 App 35h O / Yes 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.
CP6002 Table 3: IPMI Firmware User Guide Standard IPMI Commands IPMI 2.0 SPEC. SECTION NETFN CMD KONTRON SUPPORT ON BMC 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 / Yes 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.
IPMI Firmware User Guide Table 3: CP6002 Standard IPMI Commands COMMAND IPMI 2.0 SPEC. SECTION NETFN CMD PEF AND ALERTING COMMANDS KONTRON SUPPORT ON BMC O Get PEF Capabilities 30.1 S/E 10h O / No Arm PEF Postpone Timer 30.2 S/E 11h O / No Set PEF Configuration Parameters 30.3 S/E 12h O / No Get PEF Configuration Parameters 30.4 S/E 13h O / No Set Last Processed Event ID 30.5 S/E 14h O / No Get Last Processed Event ID 30.6 S/E 15h O / No Alert Immediate 30.
CP6002 Table 3: IPMI Firmware User Guide Standard IPMI Commands COMMAND IPMI 2.0 SPEC. SECTION NETFN CMD FRU DEVICE COMMANDS KONTRON SUPPORT ON BMC M Get FRU Inventory Area Info 34.1 Storage 10h M / Yes Read FRU Data 34.2 Storage 11h M / Yes Write FRU Data 34.3 Storage 12h M / Yes SDR DEVICE COMMANDS O Get SDR Repository Info 33.9 Storage 20h O / Yes Get SDR Repository Allocation Info 33.10 Storage 21h O / Yes Reserve SDR Repository 33.
IPMI Firmware User Guide Table 3: CP6002 Standard IPMI Commands IPMI 2.0 SPEC. SECTION NETFN CMD KONTRON SUPPORT ON BMC Delete SEL Entry 40.8 Storage 46h O / Yes Clear SEL 40.9 Storage 47h O / Yes Get SEL Time 40.10 Storage 48h O / Yes Set SEL Time 40.11 Storage 49h O / Yes Get Auxiliary Log Status 40.12 Storage 5Ah O / No Set Auxiliary Log Status 40.13 Storage 5Bh O / No COMMAND SERIAL/MODEM DEVICE COMMANDS O Set Serial/Modem Configuration 25.
CP6002 9.2 IPMI Firmware User Guide AdvancedTCA and AMC Commands Part of the command list in PICMG 3.0 R 2.0 AdvancedTCA Base Specification and the PICMG AMC.0 Advanced Mezzanine Card Specification, R 1.0, M = mandatory, O = optional Table 4: AdvancedTCA and AMC Commands COMMAND PICMG 3.0 SPEC.
IPMI Firmware User Guide Table 4: CP6002 AdvancedTCA and AMC Commands PICMG 3.0 SPEC. TABLE NETFN CMD KONTRON SUPPORT ON MMC Set Fan Level 3-65 PICMG 15h N/A Get Fan Level 3-64 PICMG 16h N/A Bused Resource 3-44 PICMG 17h N/A Get IPMB Link Info 3-49 PICMG 18h N/A COMMAND Page 26 ID: 1039-1613, Rev. 2.
CP6002 IPMI Firmware User Guide 10. OEM Commands and Command Extensions 10.1 Get Device ID Command with OEM Extensions The IPMI specification defines four optional bytes in the response to 'Get Device ID'. The response bytes [13:16] hold the 'Auxiliary Firmware Revision Information'.
IPMI Firmware User Guide 10.2 CP6002 Set Firmware Parameters This command permits the selection of interrupts to be used during KCS communication. Please note that parameters which are set while the board is write protected are only valid until the next IPMI firmware reset.
CP6002 10.3 IPMI Firmware User Guide Set Control State (Firmware Hub, Boot Order) Please note that parameters which are set while the board is write protected are only valid until the next IPMI firmware reset.
IPMI Firmware User Guide CP6002 10.4 Get Control State (Firmware Hub, Boot Order) Table 8: Get Control State COMMAND LUN NetFn CMD Get Control State (Firmware Hub/EFI Flash, Boot Order) 00h OEM = 3Eh 21h REQUEST DATA Byte Data Field 1 Control ID: 00h = EFI Flash selection 9Dh = EFI Boot Order Configuration RESPONSE DATA Byte Data Field 1 Completion Code 4 Current Control State (see 10.3, Set Control State) 00h .. 01h for control ID = EFI Flash Select 00h ..
CP6002 11. IPMI Firmware User Guide Sensors Implemented on the CP6002 The sensor name (ID string) has a name prefix which is ‘NNN:’ in the lists below. When reading the sensor name after module insertion this prefix becomes automatically adapted to the role (BMC or SMC) and the physical position (slot number) of the module in a rack. If the module's Management Controller is set up as a BMC the prefix will be ‘BMC:’ independent of the slot where it resides.
IPMI Firmware User Guide Table 9: CP6002 Sensor List LED I1on error / Reading Mask SENSOR Number / ID string SENSOR TYPE (CODE) / EVENT/READING TYPE (CODE) Ass. Mask / Deass.
CP6002 Table 9: IPMI Firmware User Guide Sensor List LED I1on error / Reading Mask SENSOR Number / ID string SENSOR TYPE (CODE) / EVENT/READING TYPE (CODE) Ass. Mask / Deass.
IPMI Firmware User Guide 11.2 CP6002 Sensor Thresholds The CP6002 CPU module is available for two different operating temperature ranges. For each operating temperature range, standard and extended (E2), a set of temperature thresholds for the sensors is defined. The thresholds defined in Table 10 are the same for both temperature ranges except for sensor 04h. The far right column indicates the thresholds for the E2 range for the sensor 04h. Table 11 provides voltage sensor thresholds.
CP6002 11.3 IPMI Firmware User Guide OEM Event/Reading Types OEM (Kontron) specific sensor types and codes are presented in the following table.
IPMI Firmware User Guide CP6002 Table 12: OEM Event/Reading Types OEM SENSOR TYPE (CODE) OEM EVENT/READING TYPE (CODE) 73h DESCRIPTION Sensor-specific Offset Event Power Good / Power Good Event 0h HS fault# 1h HS early fault# 2h DEG# 3h FAL# 4h n.a. 5h n.a. 6h n.a. 7h n.a. 8h n.a. 9h n.a. Ah n.a. Bh n.a. Ch n.a. Dh n.a. Eh vccMainGood e.g.
CP6002 12.
IPMI Firmware User Guide 13. OS Support / Tools 13.1 Linux Tools CP6002 OpenIPMI - KCS driver Normally all drivers and kernel modules needed for communication between the payload sided software and the Management Controller firmware via the KCS interface come with the distribution. Newest sources can be downloaded from: ‘http://openipmi.sourceforge.net’. There may be downloaded the OpenIPMI project as well. The OpenIPMI library package includes some applications and the needed libraries.
CP6002 14. IPMI Firmware User Guide IPMI Module Management LEDs There are three IPMI Module Management LEDs on the front panel of the CP6002. The following figure illustrates the location of the LEDs. IPMI LEDS I0 and I1 HOT SWAP LED CP6002-R1 CP6002-R1-MC CP6002-R2-MC ID: 1039-1613, Rev. 2.
IPMI Firmware User Guide CP6002 The following table describes the functioning of the Module Management LEDs.
