CP6003-SA/RA/RC IPMI Firmware Doc. ID: 1045-5656, Rev. 2.0 January 12, 2012 If it’s embedded, it’s Kontron.
Preface CP6003-SA/RA/RC Revision History Publication Title: CP6003-SA/RA/RC IPMI Firmware User Guide Doc. ID: 1045-5656 PRELIMINARY 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 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.
CP6003-SA/RA/RC Preface Table of Contents Revision History ........................................................................................................ 2 Imprint ....................................................................................................................... 2 Disclaimer ................................................................................................................. 2 Table of Contents .....................................................................
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 ...............................................................
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.
PRELIMINARY Preface CP6003-SA/RA/RC This page has been intentionally left blank. Page 6 ID 1045-5656, Rev. 2.
CP6003-SA/RA/RC Preface 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 ........................
PRELIMINARY Preface CP6003-SA/RA/RC This page has been intentionally left blank. Page 8 ID 1045-5656, Rev. 2.
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. Terminology and Acronym Definitions TERM or ACRONYM BMC DESCRIPTION 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.
IPMI Firmware Table 1: CP6003-SA/RA/RC Terminology and Acronym Definitions (Continued) TERM or ACRONYM PWR DESCRIPTION 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.
CP6003-SA/RA/RC 1.2 IPMI Firmware Related Publications The following publications contain information relating to this product. 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.
IPMI Firmware CP6003-SA/RA/RC 2. IPMI Setup 2.1 IPMI in a CompactPCI Chassis PRELIMINARY 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.
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).
IPMI Firmware 4. IPMI Firmware 4.1 Key Features CP6003-SA/RA/RC The following are key features of the CP6003-SA/RA/RC’s IPMI firmware: • Compliant with IPMI specification 2.0 • Compliant with PICMG 2.
CP6003-SA/RA/RC IPMI Firmware 5. Supported IPMI and ATCA Commands 5.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 CP6003-SA/RA/RC IPMI firmware. M = mandatory, O = optional Standard IPMI Commands COMMAND IPMI 2.0 SPEC. SECTION NETFN CMD IPM DEVICE “GLOBAL” COMMANDS KONTRON SUPPORT ON IPMI CONTROLLER M Get Device ID 20.1 App 01h M / Yes [1] Cold Reset 20.
IPMI Firmware Table 3: Standard IPMI Commands (Continued) COMMAND PRELIMINARY CP6003-SA/RA/RC IPMI 2.0 SPEC. SECTION NETFN CMD KONTRON SUPPORT ON IPMI CONTROLLER Get System GUID 22.14 App 37h O / No Get Channel Authentication Capabilities 22.13 App 38h O / Yes Get Session Challenge 22.15 App 39h O / Yes Activate Session 22.17 App 3Ah O / Yes Set Session Privilege Level 22.18 App 3Bh O / Yes Close Session 22.19 App 3Ch O / Yes Get Session Info 22.
CP6003-SA/RA/RC Standard IPMI Commands (Continued) COMMAND IPMI 2.0 SPEC. SECTION NETFN CMD KONTRON SUPPORT ON IPMI CONTROLLER Get Chassis Status 28.2 Chassis 01h O / Yes Chassis Control 28.3 Chassis 02h O / Yes 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.
IPMI Firmware Table 3: Standard IPMI Commands (Continued) COMMAND PRELIMINARY CP6003-SA/RA/RC IPMI 2.0 SPEC. SECTION NETFN CMD KONTRON SUPPORT ON IPMI CONTROLLER Set Sensor Event Enable 35.10 S/E 28h O / Yes Get Sensor Event Enable 35.11 S/E 29h O / Yes Re-arm Sensor Events 35.12 S/E 2Ah O / No Get Sensor Event Status 35.13 S/E 2Bh O / No Get Sensor Reading 35.14 S/E 2Dh M / Yes Set Sensor Type 35.15 S/E 2Eh O / No Get Sensor Type 35.
CP6003-SA/RA/RC Standard IPMI Commands (Continued) COMMAND IPMI 2.0 SPEC. SECTION NETFN CMD KONTRON SUPPORT ON IPMI CONTROLLER Partial Add SEL Entry 40.7 Storage 45h O / No 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.
IPMI Firmware 5.2 CP6003-SA/RA/RC AdvancedTCA and AMC Commands The following table shows an excerpt from the command list specified in the PICMG 3.0 R 2.0 AdvancedTCA Base Specification and the PICMG AMC.0 Advanced Mezzanine Card Specification, R 1.0. The shaded table cells indicate commands supported by the IPMI firmware. M = mandatory Table 4: AdvancedTCA and AMC Commands COMMAND PICMG 3.0 SPEC.
CP6003-SA/RA/RC IPMI Firmware 6. OEM Commands and Command Extensions 6.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 6.2 CP6003-SA/RA/RC 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 valid only until the next IPMI firmware reset.
CP6003-SA/RA/RC 6.3 IPMI Firmware Set Control State (SPI Boot Flash, Boot Order) Please note that parameters which are set while the board is write-protected are valid only until the next IPMI firmware reset.
IPMI Firmware CP6003-SA/RA/RC 6.4 Get Control State (SPI Boot Flash, Boot Order) Table 8: Get Control State COMMAND Get Control State (SPI Boot Flash, Boot Order) LUN NetFn CMD 00h OEM = 3Eh 21h REQUEST DATA Byte Data Field 1 Control ID: 00h = SPI boot flash selection 9Dh = uEFI BIOS Boot Order Configuration PRELIMINARY RESPONSE DATA Byte Data Field 1 Completion Code 4 Current Control State (see Chapter 6.3, Set Control State) 00h .. 01h for control ID = SPI boot flash selection 00h .
CP6003-SA/RA/RC 7.1 IPMI Firmware Sensor List The following table indicates all sensors available on the CP6003-SA/RA/RC. For further information on Kontron’s OEM-specific sensor types and sensor event type codes presented in the following table, please refer to Chapter 7.3, OEM Event/Reading Types. Sensor List SENSOR TYPE (CODE) / EVENT/READING TYPE (CODE) SENSOR NUMBER / ID STRING Ass. Mask / Deass.
IPMI Firmware Table 9: Sensor List (Continued) SENSOR NUMBER / ID STRING PRELIMINARY CP6003-SA/RA/RC SENSOR TYPE (CODE) / EVENT/READING TYPE (CODE) Ass. Mask / Deass.
CP6003-SA/RA/RC IPMI Firmware Table 10: Gigabit Ethernet Link Sensor Assignment SENSOR NUMBER / ID STRING CP6003-SA CP6003-RA/RC CP6003-RA GbE ROUTED TO FRONT GbE ROUTED TO REAR Front GbE A GbE B GbE D 18h / NNN:LanFrontB_Lk Front GbE B GbE A GbE C 19h / NNN:LanRearC_Lk Rear GbE A GbE A (Rear I/O module) GbE A (Rear I/O module) 1Ah / NNN:LanRearD_Lk Rear GbE B (Rear I/O module) GbE B (Rear I/O module) GbE B PRELIMINARY 17h / NNN:LanFrontA_Lk ID 1045-5656, Rev. 2.
IPMI Firmware 7.2 CP6003-SA/RA/RC Sensor Thresholds The following table provides the temperature sensor thresholds. PRELIMINARY Table 11: Thresholds - Standard Temperature Range Sensor Number / ID string 01h / NNN:Temp CPU 02h / NNN:Temp Chipset 03h / NNN:Temp Board 03h / NNN:Temp Board E2 Upper non-recoverable 110 °C 118 °C 85 °C 95 °C Upper critical 100 °C 108 °C 80 °C 90 °C Upper non-critical 90 °C 98 °C 70 °C 80 °C Normal max.
CP6003-SA/RA/RC 7.3 IPMI Firmware OEM Event/Reading Types OEM (Kontron) specific sensor types and codes are presented in the following table. Table 13: OEM Event/Reading Types OEM EVENT/READING TYPE (CODE) DESCRIPTION Firmware Info 1 (C0h) 70h Internal Diagnostic Data Firmware Info 2 (C0h) 71h Internal Diagnostic Data Initialization Agent (C2h) 03h (“digital” Discrete) Offsets / events: FRU Agent (C5h) 0Ah (Discrete) FRU initialization agent, using a standard reading type.
IPMI Firmware CP6003-SA/RA/RC Table 13: OEM Event/Reading Types (Continued) OEM SENSOR TYPE (CODE) Sensor-specific Offset Event Power Good Event 0h HS fault# 1h HS early fault# 2h DEG# 3h FAL# 4h BDSELState 5h n.a. 6h n.a. 7h vccMainGood 8h n.a. 9h n.a. Ah n.a. Bh n.a. Ch n.a. Dh n.a. Eh n.a Board revision (CEh) Page 30 73h DESCRIPTION Power Good / e.g.
CP6003-SA/RA/RC 8. IPMI Firmware Code 8.1 Structure and Functionality IPMI Firmware The IPMI firmware code is organized into boot code and operational code, both of which are stored in a flash device. Upon an IPMI controller reset, the IPMI controller first executes the boot code which does: • A self-test to verify the status of the IPMI controller's hardware including its memory • Performs a checksum of the operational code 8.
IPMI Firmware 8.4 CP6003-SA/RA/RC Firmware Identification There are two ways to verify that a IPMI controller resides on a CP6003-SA/RA/RC. Invoking the IPMI command Get Device ID returns among other information the following data: • Manufacturer ID = 3A98h (Kontron IANA ID) • Product ID = B3C0 for the firmware • Firmware revision in bytes 4:5 - depends on the core version of the running firmware.
CP6003-SA/RA/RC 8.5.2 IPMI Firmware Firmware Upgrade - “ipmitool hpm” Firmware upgrade using a HPM.1 file requires at least “ipmitool” version 1.8.10. The firmware upgrade procedure starts with downloading the HPM.1 file using, for example, the following command: ipmitool hpm upgrade .hpm all The next step is the activation of the newly downloaded IPMI firmware.
IPMI Firmware 8.5.3 CP6003-SA/RA/RC Firmware Upgrade - “ipmitool fwum” “ipmitool” version 1.8.9 doesn’t support HPM.1 correctly. Tool versions prior to this do not support HPM.1 at all. The firmware upgrade procedure starts with downloading the binary firmware file using, for example, the following command: ipmitool fwum download .bin The next step is the activation of the newly downloaded IPMI firmware.
CP6003-SA/RA/RC IPMI Firmware 9. FRU Data 9.1 Structure and Functionality The IPMI controller provides 4 kB non-volatile storage space for FRU information. For further information regarding the FRU data, refer to IPMI - Platform Management FRU Information Storage Definition v1.0, Document Revision 1.1. Full low-level access to read or write the board's FRU Information is provided by regular IPMI FRU Device commands.
IPMI Firmware 9.4 CP6003-SA/RA/RC FRU Data Update Typically, an update of the FRU data is not necessary because the board’s correct FRU data is installed at the factory. If an update of the FRU data is required, it can be done via regular IPMI FRU device commands. The correct FRU data must be prepared at the factory. Please contact Kontron for further assistance. 9.
CP6003-SA/RA/RC 11. IPMI Firmware uEFI BIOS Failover Control - Automatic SPI Boot Flash Selection When the CP6003-SA/RA/RC's payload starts, the first code to be executed is the uEFI BIOS. There are two SPI boot flash devices (standard and recovery), which may contain different uEFI BIOS codes. Which one of them will be utilized from the next boot process on is defined by one of two ways: • The IPMI controller determines whether to boot from the standard or the recovery SPI boot flash.
IPMI Firmware CP6003-SA/RA/RC 12. Hot Swap and Shutdown 12.
CP6003-SA/RA/RC 12.2 IPMI Firmware The Hot Swap and Shutdown Processes Hot Swap, as defined here, is the purposely initiated process to remove and replace an active board in a powered system. To accomplish this requires that the hot swap process provide for an orderly transition of the payload from the active to inactive state and vice versa. This is necessary to preclude improper system operation and possible loss of data.
IPMI Firmware 13. LAN Functions 13.1 Overview CP6003-SA/RA/RC All Ethernet channels except for the GbE E channel support IPMI over LAN (IOL) and Serial over LAN (SOL). Common for both types of communication is the use of the RMCP/RMCP+ protocol for the packing of the data to be transferred. The RMCP/RMCP+ protocol uses the TCP port 623 by default. PRELIMINARY While IOL serves to transport IPMI commands and their responses, SOL serves to transport any serial data.
CP6003-SA/RA/RC 13.3 IPMI Firmware Basic Setup from uEFI Shell With the kipmi net command from uEFI Shell some basic settings such as IP address, sub-net mask and gateway address can be set up for all of the four Ethernet channels. 13.4 Setup by “ipmitool” or IPMI Commands The open tool “ipmitool” offers commands for the setup of the four Ethernet channels.
IPMI Firmware 13.6 CP6003-SA/RA/RC IPMI Over LAN (IOL) IPMI over LAN is used to allow the IPMI controller to communicate with the IPMI controller via LAN using the RMCP or the RMCP+ protocol. The data transferred are IPMI commands and the responses to them. To enable LAN support after parameter setup the following command must be issued: ipmitool lan set access on Please note that the following commands must use the IP address which belongs to the enabled channel.
CP6003-SA/RA/RC IPMI Firmware The parameters for the IPMI controller's serial interface can be set by using the following command: ipmitool sol set This command shows all options that can be set. Further options are listed after issuing the following command: 14. OS Support / Tools 14.1 Linux Tools OpenIPMI - KCS driver Normally all drivers and kernel modules needed for communication between the payload sided software and the IPMI firmware via the KCS interface come with the distribution.
IPMI Firmware 15. CP6003-SA/RA/RC IPMI and Hot Swap LEDs On the CP6003-SA/RA, there are three LEDs controlled by the IPMI controller, two IPMI Status LEDs and a Hot Swap LED. All three LEDs are located on the front panel of the CP6003-SA/RA. On the CP6003-RC, there are two IPMI LEDs controlled by the IPMI controller. Both LEDs are located on the rear side of the CP6003-RC. PRELIMINARY The following figure illustrates the location of the two IPMI LEDs and the HS LED on the CP6003-SA/RA.
CP6003-SA/RA/RC IPMI Firmware The following figure illustrates the location of the two IPMI LEDs on the CP6003-RC. R771 R759 R778 R756 IPMI LED I0 Temperature Sensor IPMI LED I1 IPMI LEDs I0 and I1 DLED 0 DLED 1 DLED 2 The following table describes the functions of the IPMI LEDs and the Hot Swap LED.
PRELIMINARY IPMI Firmware CP6003-SA/RA/RC This page has been intentionally left blank. Page 46 ID 1045-5656, Rev. 2.
