14IPMI and Hot Swap LEDs Function .............................................................45
P R E L I M I N A R Y
ID 1045-5656, Rev. 2.0Page 7
PrefaceCP6003-SA/RA/RC
This page has been intentionally left blank.
P R E L I M I N A R Y
Page 8ID 1045-5656, Rev. 2.0
CP6003-SA/RA/RCIPMI Firmware
1.Introduction
1.1Terminology 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 ACRONYMDESCRIPTION
BMCBaseboard 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.
BSPBoard Support Package
FRUField 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.
FWHFirmware Hub memory location where a complete uEFI BIOS code is stored.
2
I
C
IPMBIntelligent Platform Management Bus
IPMB-0Intelligent Platform Management Bus which connects all SMCs with the BMC or the
IPMIIntelligent Platform Management Interface
IOLIPMI over LAN. An IPMI controller is accessed via LAN, not IPMB.
KCSKeyboard 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
MPManagement Power
This powers the BMC or SMC controller.
PICMGPCI Industrial Computer Manufacturer Group
ID 1045-5656, Rev. 2.0Page 9
IPMI FirmwareCP6003-SA/RA/RC
Table 1:Terminology and Acronym Definitions (Continued)
TERM or ACRONYMDESCRIPTION
PWRPayload 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.
SDRSensor Data Record
This is the IPMI data structure that defines a sensor.
SDRRSensor 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.
SELSystem 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.
SMBIOSSystem Management BIOS
SMCSatellite 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.
SMSSystem Management Software (designed to run under the OS)
SOLSerial 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 10ID 1045-5656, Rev. 2.0
CP6003-SA/RA/RCIPMI Firmware
1.2Related Publications
The following publications contain information relating to this product.
IPMIAddenda, Errata, and Clarifications document revision 4 for IPMI v2.0 rev 1.0
specification
IPMIIntelligent Platform Management Bus Communications Protocol Specification v1.0
Document Revision 1.0, November 1999
IPMIIPMB v1.0 Address Allocation Document Revision 1.0, September 1998
PICMGCompactPCI 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/RCCP6003-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 ToolsOpenIPMI documentation: http://www.openipmi.sourceforge.net
1.3IPMI 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.0Page 11
IPMI FirmwareCP6003-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.1IPMI 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.2IPMI 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 12ID 1045-5656, Rev. 2.0
CP6003-SA/RA/RCIPMI 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.3IPMI 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:
•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.0Page 13
IPMI FirmwareCP6003-SA/RA/RC
4.IPMI Firmware
4.1Key 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 14ID 1045-5656, Rev. 2.0
CP6003-SA/RA/RCIPMI Firmware
5.Supported IPMI and ATCA Commands
5.1Sta ndard 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
Table 3:Standard IPMI Commands
IPMI 2.0
COMMAND
SPEC.
NETFNCMD
SECTION
IPM DEVICE “GLOBAL” COMMANDSM
Get Device ID20.1App01h
Cold Reset20.2App02h
Warm Reset20.3App03hO / No
Get Self Test Results20.4App04h
Manufacturing Test On20.5App05hO / No
Set ACPI Power State20.6App06h
Get ACPI Power State20.7App07h
Get Device GUID20.8App08hO / No
Broadcast “Get Device ID”20.9App01h
BMC WATCHDOG TIMER COMMANDS
Reset Watchdog Timer27.5App22h
Set Watchdog Timer27.6App24h
KONTRON
SUPPORT
ON IPMI
CONTROLLER
M / Yes [1]
O / Yes
O / Yes
O / Yes
O / Yes
M / Yes
O
O / Yes
O / Yes
Get Watchdog Timer27.7App25h
BMC DEVICE AND MESSAGING COMMANDSO
Set BMC Global Enables22.1App2Eh
Get BMC Global Enables22.2App2Fh
Clear Message Flags22.3App30h
Get Message Flags22.4App31h
Enable Message Channel Receive22.5App32h
Get Message22.6App33h
Send Message22.7App34h
Read Event Message Buffer22.8App35h
Get BT Interface Capabilities22.9App36hO / No
ID 1045-5656, Rev. 2.0Page 15
O / Yes
O / Yes
O / Yes
O / Yes
O / Yes
O / Yes
O / Yes
O / Yes
O / Yes
P R E L I M I N A R Y
IPMI FirmwareCP6003-SA/RA/RC
Table 3:Standard IPMI Commands (Continued)
IPMI 2.0
COMMAND
SPEC.
NETFNCMD
SECTION
Get System GUID22.14App37hO / No
Get Channel Authentication Capabilities22.13App38h
Get Session Challenge22.15App39h
Activate Session22.17App3Ah
Set Session Privilege Level22.18App3Bh
Close Session22.19App3Ch
Get Session Info22.20App3Dh
Get AuthCode22.21App3FhO / No
Set Channel Access22.22App40h
Get Channel Access22.23App41h
Get Channel Info22.24App42h
Set User Access22.26App43h
Get User Access22.27App44h
KONTRON
SUPPORT
ON IPMI
CONTROLLER
O / Yes
O / Yes
O / Yes
O / Yes
O / Yes
O / Yes
O / Yes
O / Yes
O / Yes
O / Yes
O / Yes
Set User Name22.28App45h
Get User Name22.29App46h
Set User Password22.30App47h
Activate Payload24.1App48h
Deactivate Payload24.2App49h
Get Payload Activation Status24.4App4Ah
Get Payload Instance Info24.5App4Bh
Set User Payload Access24.6App4Ch
P R E L I M I N A R Y
Get User Payload Access24.7App4Dh
Get Channel Payload Support24.8App4Eh
Get Channel Payload Version24.9App4Fh
Get Channel OEM Payload Info24.10App50hO / No
Master Write-Read22.11App52h
Get Channel Cipher Suits22.15App54hO / No
Suspend/Resume Payload Encryption24.3App55h
Set Channel Security Keys22.25App56hO / No
Get System Interface Capabilities22.9App57hO / 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
CHASSIS DEVICE COMMANDSO
Get Chassis Capabilities28.1Chassis00h
Page 16ID 1045-5656, Rev. 2.0
O / Yes
CP6003-SA/RA/RCIPMI Firmware
Table 3:Standard IPMI Commands (Continued)
IPMI 2.0
COMMAND
SPEC.
NETFNCMD
SECTION
Get Chassis Status28.2Chassis01hO / Yes
Chassis Control28.3Chassis02h
Chassis Reset28.4Chassis03hO / No
Chassis Identify28.5Chassis04hO / No
Set Chassis Capabilities28.7Chassis05hO / No
Set Power Restore Policy28.8Chassis06hO / No
Get System Restart Cause28.11Chassis07hO / No
Set System Boot Options28.12Chassis08hO / No
Get System Boot Options28.13Chassis09hO / No
Get POH Counter28.14Chassis0Fh
EVENT COMMANDSM
Set Event Receiver29.1S/E00h
Get Event Receiver29.2S/E01h
KONTRON
SUPPORT
ON IPMI
CONTROLLER
O / Yes
O / Yes
M / Yes
M / Yes
Platform Event (a.k.a. “Event Message”)29.3S/E02h
PEF AND ALERTING COMMANDSO
Get PEF Capabilities30.1S/E10hO / No
Arm PEF Postpone Timer30.2S/E11hO / No
Set PEF Configuration Parameters30.3S/E12hO / No
Get PEF Configuration Parameters30.4S/E13hO / No
Set Last Processed Event ID30.5S/E14hO / No
Get Last Processed Event ID30.6S/E15hO / No
Alert Immediate30.7S/E16hO / No
PET Acknowledge30.8S/E17hO / No
SENSOR DEVICE COMMANDSM
Get Device SDR Info35.2S/E20h
Get Device SDR35.3S/E21h
Reserve Device SDR Repository35.4S/E22h
Get Sensor Reading Factors35.5S/E23hO / No
Set Sensor Hysteresis35.6S/E24h
Get Sensor Hysteresis35.7S/E25h
M / Yes
M / Yes
M / Yes
M / Yes
O / Yes
O / Yes
P R E L I M I N A R Y
Set Sensor Threshold35.8S/E26h
Get Sensor Threshold35.9S/E27h
ID 1045-5656, Rev. 2.0Page 17
O / Yes
O / Yes
IPMI FirmwareCP6003-SA/RA/RC
Table 3:Standard IPMI Commands (Continued)
IPMI 2.0
COMMAND
SPEC.
NETFNCMD
SECTION
Set Sensor Event Enable35.10S/E28hO / Yes
Get Sensor Event Enable35.11S/E29h
Re-arm Sensor Events35.12S /E2AhO / No
Get Sensor Event Status35.13S/E2BhO / No
Get Sensor Reading35.14S/E2Dh
Set Sensor Type35.15S/E2EhO / No
Get Sensor Type35.16S/E2FhO / No
FRU DEVICE COMMANDSM
Get FRU Inventory Area Info34.1Storage10h
Read FRU Data34.2Storage11h
Write FRU Data 34.3Storage12h
SDR DEVICE COMMANDSO
Get SDR Repository Info33.9Storage20h
KONTRON
SUPPORT
ON IPMI
CONTROLLER
O / Yes
M / Yes
M / Yes
M / Yes
M / Yes
O / Yes
Get SDR Repository Allocation Info33.10Storage21h
Reserve SDR Repository33.11Storage22h
Get SDR33.12Storage23h
Add SDR33.13Storage24h
Partial Add SDR33.14Storage25h
Delete SDR33.15Storage26h
Clear SDR Repository33.16Storage27h
Get SDR Repository Time33.17S torage28hO / No
P R E L I M I N A R Y
Set SDR Repository Time33.18Storage29hO / No
Enter SDR Repository Update Mode33.19Storage2AhO / No
Exit SDR Repository Update Mode33.20Storage2BhO / No
Run Initialization Agent33.21Storage2Ch
SEL DEVICE COMMANDS O
Get SEL Info40.2Storage40h
Get SEL Allocation Info40.3Storage41h
Reserve SEL40.4Storage42h
O / Yes
O / Yes
O / Yes
O / Yes
O / Yes
O / Yes
O / Yes
O / Yes
O / Yes
O / Yes
O / Yes
Get SEL Entry40.5Storage43h
Add SEL Entry40.6Storage44h
Page 18ID 1045-5656, Rev. 2.0
O / Yes
O / Yes
CP6003-SA/RA/RCIPMI Firmware
Table 3:Standard IPMI Commands (Continued)
IPMI 2.0
COMMAND
SPEC.
NETFNCMD
SECTION
Partial Add SEL Entry40.7Storage45hO / No
Delete SEL Entry40.8Storage46h
Clear SEL40.9Storage47h
Get SEL Time40.10Storage48h
Set SEL Time40.11Storage49h
Get Auxiliary Log Status40.12Storage5AhO / No
Set Auxiliary Log Status40.13Storage5BhO / No
LAN DEVICE COMMANDSO
Set LAN Configuration Parameters23.1Transport01h
Get LAN Configuration Parameters23.2Transport02h
Suspend BMC ARPs23.3Transport03hO / No
Get IP/UDP/RMCP Statistics23.4Transport04h
SERIAL/MODEM DEVICE COMMANDSO
KONTRON
SUPPORT
ON IPMI
CONTROLLER
O / Yes
O / Yes
O / Yes
O / Yes
O / Yes
O / Yes
O / Yes
Set Serial/Modem Configuration25.1Transport10hO / No
Get Serial/Modem Configuration25.2Transport11hO / No
Set Serial/Modem Mux25.3Transport12hO / No
Get TAP Response Codes25.4Transport13hO / No
Set PPP UDP Proxy Transmit Data25.5Transport14hO / No
Get PPP UDP Proxy Transmit Data25.6Transport15hO / No
Send PPP UDP Proxy Packet25.7Transport16hO / No
Get PPP UDP Proxy Receive Data25.8Transport17hO / No
Serial/Modem Connection Active25.9Transport18hO / No
Callback25.10Transport19hO / No
Set User Callback Options25.11Transport1AhO / No
Get User Callback Options25.12Transport1BhO / No
SOL Activating26.1Transport20h
Get SOL Configuration Parameters26.2Transport21h
Set SOL Configuration Parameters26.3Transport22h
O / Yes
O / Yes
O / Yes
[1] Has OEM extensions. Please refer to 6.1, Get Device ID Command with OEM Extensions.
P R E L I M I N A R Y
Note ...
Some of the above-mentioned commands, such as SDR commands, work
only if the IPMI controller is configured as BMC. For further information, refer
to the IPMI specification 2.0.
ID 1045-5656, Rev. 2.0Page 19
IPMI FirmwareCP6003-SA/RA/RC
5.2AdvancedTCA 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
PICMG 3.0
COMMAND
SPEC.
NETFNCMD
TABLE
AdvancedTCA
Get PICMG Properties3-9PICMG00h
Get Address Info3-8PICMG01hN/A
Get Shelf Address Info3-13PICMG02hN/A
Set Shelf Address Info3-14PICMG03hN/A
FRU Control3-22PICMG04hN/A
Get FRU LED Properties3-29PICMG05h
Get LED Color Capabilities3-25PICMG06h
Set FRU LED State3-26PICMG07h
Get FRU LED State3-27PICMG08h
Set IPMB State3-51PICMG09hN/A
Set FRU Activation Policy3-17PICMG0AhN/A
KONTRON
SUPPORT
ON IPMI
CONTROLLER
M
M / Yes
M / Yes
M / Yes
M / Yes
M / Yes
Get FRU Activation Policy3-18PICMG0BhN/A
Set FRU Activation3-16PICMG0ChN/A
Get Device Locator Record ID3-29PICMG0Dh
P R E L I M I N A R Y
Set Port State3-41PICMG0EhN/A
Get Port State3-42PICMG0FhN/A
Compute Power Properties3-60PICMG10hN/A
Set Power Level3-62PICMG11hN/A
Get Power Level3-61PICMG12hN/A
Renegotiate Power3-66PICMG13hN/A
Get Fan Speed Properties3-63PICMG14hN/A
Set Fan Level3-65PICMG15hN/A
Get Fan Level3-64PICMG16hN/A
Bused Resource3-44PICMG17hN/A
Get IPMB Link Info3-49PICMG18hN/A
M / Yes
Page 20ID 1045-5656, Rev. 2.0
CP6003-SA/RA/RCIPMI Firmware
6.OEM Commands and Command Extensions
6.1Get 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”.
Table 5:Get Device ID Command with OEM Extensions
COMMANDLUNNetFnCMD
Get Device ID command with OEM extensions00hApp = 06h01h
REQUEST DATA
ByteData Field
--
RESPONSE DATA
ByteData Field
1Completion Code
2:12Regular Get Device ID Command response fields
13Release number of the IPMI firmware:
10h for R10,
11h for R11,
…
Release number 1… of the IPMI firmware. The open tool “ipmitool” displays this as “SDR” in
the response to the command “ipmitool fwum status”.
14Board Geographical Address (slot number):
1 … = Board in chassis slot 1…
15Reserved
16Reserved
P R E L I M I N A R Y
ID 1045-5656, Rev. 2.0Page 21
IPMI FirmwareCP6003-SA/RA/RC
6.2Set 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-protecte d are valid only until
the next IPMI firmware reset.
Table 6:Set Firmware Parameters
COMMANDLUNNetFnCMD
Set Firmware Parameters03hOEM = 3Eh05h
REQUEST DATA
ByteData Field
1Reserved
B4h
2Reserved
90h
3Reserved
91h
4Reserved
8Bh
5Cmd Flags
[6:2] Reserved
[1] 0b = get only, 1b = set parameters
[0] 0b = do not reset, 1b = reset IPMI controller after setting parameters
1Completion Code
4Current Control State (see Chapter 6.3, Set Control State)
00h .. 01h for control ID = SPI boot flash selection
00h .. FFh for control ID = uEFI BIOS Boot Order Configuration
7.Sensors Implemented on the CP6003-SA/RA/RC
The IPMI controller includes several sensors for voltage or temperature monitoring and various
others for pass/fail type signal monitoring.
Every sensor is associated with a Sensor Data Record (SDR). Sensor Data Records contain
information about the sensor’s identification such as sensor type, sensor name, and sensor
unit. SDRs also contain the configuration of a specific sensor such as threshold, hysteresis or
event generation capabilities that specify sensor's behavior . So me fields of the sensor SDR are
configurable using IPMI commands; others are always set to built-in default values.
The IPMI controller supports sensor device commands and uses the static sensor population
feature of IPMI. All Sensor Data Records can be queried using Device SDR commands.
P R E L I M I N A R Y
The sensor name (ID string) has a name prefix which is ‘NNN:’ in the lists below . When reading
the sensor name after board insertion, this prefix becomes automatically adapted to the role
(BMC or SMC) and the physical position (slot number) of the board in a rack. If the IPMI controller is set up as a BMC, the prefix will be ‘BMC:’ independent of the slot where it resides. If
the IPMI controller is set up as an SMC, the prefix will be ‘Sxx:’ where xx is the slot number
(e.g. 09).
The sensor number is the number which identifies the sensor e.g. when using the IPMI command Get Sensor Reading. Please note that “ipmitool” accepts sensor numbers in deci-
mal (e.g. “10”) or hexadecimal (e.g. “0xa”) notation.
The IPMI tool “ipmitool” displays for the command “ipmitool sdr list” the contents of the sensor
data record repository (SDRR) of the whole rack if the SDRR has been generated. The generation of the SDRR must always be redone after adding or removing a board from the rack. Refer to Chapter 2.3, IPMI Setup for the Rack for further information.
Page 24ID 1045-5656, Rev. 2.0
CP6003-SA/RA/RCIPMI Firmware
7.1Sensor List
The following table indicates all sensors available on the CP6003-SA/RA/RC. Fo r 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.
Table 9:Sensor List
SENSOR NUMBER/
ID STRING
00h /
NNN:Hot Swap
01h /
NNN:Temp CPU
02h /
NNN:Temp Chipset
03h /
NNN:Temp Board
04h /
NNN:Pwr Good
05h /
NNN:Pwr Good Evt
06h /
NNN:Board 3.3V
07h /
NNN:Board 5VIPMI
08h /
NNN:Board 5V
09h /
NNN:Board 12V
0Ah /
NNN:IPMB 5V
0Bh /
NNN:Fan1 Speed
0Ch /
NNN:Fan2 Speed
0Dh /
NNN:Last Reset
0Eh /
NNN:Slot System
0Fh /
NNN:PCI Present
10h /
NNN:CTCA chassis
11h /
NNN:IPMI WD
12h /
NNN:IPMB State
13h /
NNN:ACPI State
SENSOR TYPE (CODE) /
EVENT/READING TYPE
(CODE)
Hot Swap (F0h) /
Sensor-specific (6Fh)
Temperature (01h) /
Threshold (01h)
Temperature (01h) /
Threshold (01h)
Temperature (01h) /
Threshold (01h)
Power supply (08h) /
OEM (73h)
Power supply (08h) /
OEM (73h)
Voltage (02h) /
Threshold (01h)
Voltage (02h) /
Threshold (01h)
Voltage (02h) /
Threshold (01h)
Voltage (02h) /
Threshold (01h)
Voltage (02h) /
Threshold (01h)
Fan (04h) /
Threshold (01h)
Fan (04h) /
Threshold (01h)
OEM (CFh) /
“digital” Discrete (03h)
Entity presence (25h) /
Sensor-specific (6Fh)
Entity presence (25h) /
Sensor-specific (6Fh)
Entity presence (25h) /
Sensor-specific (6Fh)
Watchdog2 (23h) /
Sensor-specific (6Fh)
IPMB status change (F1h) /
Sensor-specific (6Fh)
System ACPI Power State
(022h) / Sensor-specific (6Fh)
Ass. Mask /
Deass. Mask /
Reading Mask
001Fh / 0000h /
001Fh
1A81h / 7A81h /
3939h
0A80h / 7A80h /
3838
7A95h / 7A95h /
3F3F
0000h / 0000h /
009Fh
009Fh / 009Fh /
009Fh
2204h / 2204h /
1212h
2204h / 2204h /
1212h
2204h / 2204h /
1212h
2204h / 2204h /
1212h
2204h / 2204h /
1212h
0000h / 0000h /
1B1Bh
0000h / 0000h /
1B1Bh
0002h / 0000h /
0003h
0000h / 0000h /
0003h
0000h / 0000h /
0003h
0000h / 0000h /
0003h
010Fh / 0000h /
010Fh
000Fh / 0000h /
000Fh
7FFFh / 0000h /
7FFFh
LED I1on
error /
DESCRIPTION
Reading
Mask
Hot swap sensorN
CPU die temperatureY
/ 0F3Ch
Temp ChipsetY
/ 0F3Ch
Temp BoardY
/ 0F3Ch
Status of all power linesN
Power fail events for all
power lines
Board 3.3V supplyY
Management Power (MP)
5V
Board 5V supplyY
Board 12V supplyY
IPMB 5V supplyN
Speed [rpm] Fan 1N
Speed [rpm] Fan 2N
Board reset eventY
Board is in system slot
(SYSEN)
Board is selected (BDSEL)
and in system slot (SYSEN)
Value is always 1N
IPMI WatchdogY
IPMB-0 state (refer to
PICMG 3.0 Rev 2.0, 3.8.4.1)
System ACPI power stateN
/ 009Fh
/ 0F3Ch
/ 0F3Ch
/ 0F3Ch
/ 0F3Ch
/ 0002h
/ 010Fh
Y
Y
P R E L I M I N A R Y
N
N
N
ID 1045-5656, Rev. 2.0Page 25
IPMI FirmwareCP6003-SA/RA/RC
Table 9:Sensor List (Continued)
SENSOR NUMBER/
ID STRING
14h /
NNN:Health Error
15h /
NNN:CPU 0 Status
16h /
NNN:POST Value
17h /
NNN:LanFrontA_Lk
18h /
NNN:LanFrontB_Lk
19h /
NNN:LanRearC_Lk
1Ah /
NNN:LanRearD_Lk
1Bh /
NNN:FWH0 BootErr
1Ch /
NNN:FWH1 BootErr
1Dh /
NNN:XMC present
1Eh /
NNN:FRU Agent
1Fh /
NNN:IPMC Storage
20h /
P R E L I M I N A R Y
NNN:IpmC Reboot
21h /
NNN:Ver change
22h /
NNN:SEL State
23h /
NNN:IPMI Info-1
24h /
NNN:IPMI Info-2
25h /
NNN:IniAgent Err
26h /
NNN:Board Rev
SENSOR TYPE (CODE) /
EVENT/READING TYPE
(CODE)
Platform Alert (24h) /
“digital” Discrete (03h)
Processor (07h) /
Sensor-specific (6Fh)
POST value OEM (C6h) /
Sensor-specific (6Fh)
LAN (27h) /
Sensor-specific (6Fh)
LAN (27h) /
Sensor-specific (6Fh)
LAN (27h) /
Sensor-specific (6Fh)
LAN (27h) /
Sensor-specific (6Fh)
Boot error (1Eh) /
Sensor-specific (6Fh)
Boot error (1Eh) /
Sensor-specific (6Fh)
Entity Presence (25h) /
Sensor-specific (6Fh)
OEM FRU Agent (C5h) /
Discrete (0Ah)
Management Subsystem
Health (28h) /
Sensor-specific (6Fh)
Platform Alert (24h) /
“digital” Discrete (03h)
Firmware version changed
(2Bh) /
Sensor-specific (6Fh)
Aggregates states (power,
temperatures etc.).
Visualization by the Health
LED (LED I1, red).
CPU status: “Processor
Throttled, THERMTRIP or
CAT error”
POST code value (port 80h)N
LAN link status –
Front Eth. port A (lower)
LAN link status –
Front Eth. port B (upper)
LAN link status –
Rear Eth. port C
LAN link status –
Rear Eth. port D
Boot error on standard SPI
boot flash
Boot error on recovery SPI
boot flash
Presence of XMC boardN
FRU initialization agent
state
IPMI controller storage
access error
2 = IPMI controller is (re)booting
Firmware version changed,
update sensor data record
repository
State of event loggingN
For internal use onlyN
For internal use onlyN
Initialization agent error
status. Used on BMC only.
1 = error free
Board revision informationN
/ 0403h
/ 0008h
/ 0008h
/ 0140h
/ 0002h
/ 0002h
N
Y
N
N
N
N
Y
Y
Y
Y
N
N
Y
Page 26ID 1045-5656, Rev. 2.0
CP6003-SA/RA/RCIPMI Firmware
Table 10:Gigabit Ethernet Link Sensor Assignment
SENSOR NUMBER/
ID STRING
17h /
NNN:LanFrontA_Lk
18h /
NNN:LanFrontB_Lk
19h /
NNN:LanRearC_Lk
1Ah /
NNN:LanRearD_Lk
CP6003-SA
Front GbE A GbE BGbE D
Front GbE B GbE AGbE C
Rear GbE A
(Rear I/O module)
Rear GbE B
(Rear I/O module)
GbE ROUTED TO FRONT
CP6003-RA
GbE A
(Rear I/O module)
GbE B
(Rear I/O module)
CP6003-RA/RC
GbE ROUTED TO REAR
GbE A
GbE B
ID 1045-5656, Rev. 2.0Page 27
P R E L I M I N A R Y
IPMI FirmwareCP6003-SA/RA/RC
7.2Sensor Thresholds
The following table provides the temperature sensor thresholds.
Table 11:Thresholds - Standard Temperature Range
Sensor Number /
ID string
Upper non-recoverable
Upper critical
Upper non-critical
Normal max.
Nominal
Normal min.
Lower non-critical
Lower critical
Lower non-recoverable
The following table provides the voltage sensor thresholds.
Table 12:Voltage Sensor Thresholds
01h /
NNN:Temp
CPU
110 °C118 °C85 °C95 °C
100 °C108 °C80 °C90 °C
90 °C98 °C70 °C80 °C
85 °C93 °C65 °C75 °C
75 °C83 °C55 °C65 °C
3 °C3 °C0 °C0 °C
1 °Cn.a.- 1 °C- 40 °C
n.a.n.a.- 2 °C- 42 °C
n.a.n.a.- 5 °C- 45 °C
02h /
NNN:Temp
Chipset
03h /
NNN:Temp
Board
03h /
NNN:Temp
Board E2
Sensor Number /
ID string
Upper non-recoverable
Upper critical
P R E L I M I N A R Y
Upper non-critical
Normal max.
Nominal
Normal min.
Lower non-critical
Lower critical
Lower non-recoverable
06h /
NNN:Board
3.3V
n.a.n.a.n.a.n.a.n.a.
3.488 V5.289 V5.289 V12.773 V5.289 V
n.a.n.a.n.a.n.a.n.a.
3.460 V5.245 V5.245 V12.598 V5.245 V
3.302 V5.007 V5.007 V12.012 V5.007 V
3.129 V4.508 V4.747 V11.426 V4.747 V
n.a.n.a.n.a.n.a.n.a.
3.101 V4.465 V4.703 V11.250 V4.703 V
n.a.n.a.n.a.n.a.n.a.
07h /
NNN:Board
5VIPMI
08h /
NNN:Board
5V
09h /
NNN:Board
12V
0Ah /
NNN:Board
IPMB 5V
Page 28ID 1045-5656, Rev. 2.0
CP6003-SA/RA/RCIPMI Firmware
7.3OEM Event/Reading Types
OEM (Kontron) specific sensor types and codes are presented in the following table.
Table 13:OEM Event/Reading Types
OEM
SENSOR
TYPE (CODE)
Firmware Info 1 (C0h)70hInternal Diagnostic Data
Firmware Info 2 (C0h)71hInternal Diagnostic Data
Initialization Agent (C2h)03h
(“digital” Discrete)
FRU Agent (C5h)0Ah
(Discrete)
Post Value (C6h)6Fh
(sensor type specific)
Firmware Upgrade Manager
(C7h)
6Fh
(sensor type specific)
OEM
EVENT/READING
TYPE (CODE)
DESCRIPTION
Offsets / events:
0: Initialization O.K.
1: Initialization Error
FRU initialization agent, using a standard reading type.
Error is detected if the POST code is != 0 and doesn't
change for a defined amount of time.
In case of no error:
Bits [7:0] = POST code (payload Port 80h)
In case of error:
Bits [15:0] = 4000h
Data2 = POST code, low nibble
Data3 = POST code, high nibble
Offsets / events:
0 : First Boot after upgrade
1 : First Boot after rollback (error)
2 : First Boot after errors (watchdog)
3 : First Boot after manual rollback
Bits [7:0] = Board Revision number
This corresponds to Board and PLD Revision register
described in CP6003-SA/RA/RC User Guide.
P R E L I M I N A R Y
Page 30ID 1045-5656, Rev. 2.0
CP6003-SA/RA/RCIPMI Firmware
8.IPMI Firmware Code
8.1Structure and Functionality
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
After successful verification of the operational code checksum, the firmware will execute the
operational code. Only the operational code is upgradable in the field.
8.2uEFI BIOS/IPMI Controller Interaction
For communication between the uEFI BIOS and the IPMI controller there is a “private” KCS interface. During the boot process the uEFI BIOS sends the following IPMI commands to the
IPMI 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
•A standard IPMI command Set SEL Time to set the event log time to the time which
is kept by the RTC
•The OEM IPMI command Set Firmware Parameters with some parameters which,
for example, sets the IPMI controller to a BMC or an SMC as selected in the uEFI Shell.
•
A standard IPMI command
•Etc.
Set ACPI Power State
to set the state
ACPI legacy on
8.3IPMI Firmware Configuration
To select the BMC or SMC mode, the kipmi uEFI Shell command (mode, IRQ functions) is
used. Upon every board reset, the uEFI BIOS forwards the user settings (BMC or SMC mode)
to the IPMI controller.
P R E L I M I N A R Y
ID 1045-5656, Rev. 2.0Page 31
IPMI FirmwareCP6003-SA/RA/RC
8.4Firmware Identification
There are two ways to verifythat 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.
•The SDR revision in byte 13 (OEM part of the response) is a sub-revision of the firmware
revision. It is unique for all versions of the board's firmware.
•The device ID string which can be found by reading the Device Locator Record (SDR
Type 12h) contains the string “BMC:x ... x”. For example, invoking the ipmitool command
ipmitool sdr list mcloc will return the device ID strings of all available boards. If
the CP6003-SA/RA/RC’s IPMI controller is in BMC mode, this string will be displayed
without change. If the CP6003-SA/RA/RC’s IPMI controller is in SMC mode, then the
string will be changed into “Sxx: x ... x” where xx is the slot number where the board is
residing, e.g. “S09: x ... x”.
8.5Firmware Upgrade
The standard way to upgrade the IPMI's operational code is to use the open tool “ipmitool” (see
Table 2, Related Publications). This tool allows download and activation of new operational
code and also rollback to the “last known good” operational code. Additionally, the status and
the firmware version of the redundant firmware copies can be checked.
For local or remote firmware upgrade, the following IPMI interfaces are available:
•KCS interface (locally, requires active payload, but fast)
•IPMB (remote, independent of the payload state)
•LAN (remote, via IOL, requires also active payload)
During the download process, the currently running operational code operates as usual until
the activation command is issued. During the activation process, the IPMI controller is off-line
P R E L I M I N A R Y
for about 20 seconds while the boot code is re-organizing the firmware storage. Afterwards, it
starts the new operational code. If this doesn't succeed, after a timeout the boot code performs
an automatic rollback to the “last known good” operational code.
8.5.1Firmware File Formats
Firmware images for upgrade are provided in two formats:
•Firmware in binary format, e.g. FW_IPMI_<BOARD>_<REL>_FWUM.bin,
for usage with “ipmitool fwum ..” commands
•Firmware images in the PICMG defined HPM.1 file format,
e.g. FW_IPMI_<BOARD>_<REL>_FWUM.hpm,
for usage with “ipmitool hpm ..” commands.
where:
<BOARD>identifies to board family of the IPMI firmware (B3C0)
<REL>identifies to release (version) of IPMI firmware.
Page 32ID 1045-5656, Rev. 2.0
CP6003-SA/RA/RCIPMI Firmware
8.5.2Firmware 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.1_FWFile>.hpm all
The next step is the activation of the newly downloaded IPMI firmware. This is done using:
ipmitool hpm activate
Detailed information about the currently active firmware versions or the redundant copies can
be obtained using the commands mentioned below.
To obtain detailed version information of the active IPMI firmware, use the following command:
ipmitool hpm compprop 1 1
To obtain the version of the rollback copy (only valid if a newly downloaded firmware is already
activated), use the following command:
ipmitool hpm compprop 1 3
To obtain the version of the newly downloaded IPMI firmware (only valid after download and
before activation), use the following command:
ipmitool hpm compprop 1 4
To obtain detailed information about the IPMI HPM.1 upgrade capabilities, use the following
command:
ipmitool hpm targetcap
P R E L I M I N A R Y
ID 1045-5656, Rev. 2.0Page 33
IPMI FirmwareCP6003-SA/RA/RC
8.5.3Firmware 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 <Binary_FWFile>.bin
The next step is the activation of the newly downloaded IPMI firmware. This is done using
ipmitool fwum upgrade
Detailed information about the currently active firmware versions and the redundant copies
can be obtained using the following command:
ipmitool fwum status
Some information about the IPMI’s upgrade capabilities can be determined using the command:
ipmitool fwum info
8.6Setting the SEL Time
The IPMI controller does not have its own hardware real time clock. Therefore, after start-up,
restart or upgrade of the IPMI controller , it s software clock first must be supplied with the curr ent
time. The IPMI controller uses the time when handling event messages which otherwise will
have an out-of-date time stamp.
Every time when the uEFI BIOS starts up, it supplies the IPMI controller with the payload's current real time clock time.
Restarts of the IPMI controller without a following uEFI BIOS reboot will result in invalid date
and time indication. In order to apply correct timestamps to the SEL records, issue the IPMI
P R E L I M I N A R Y
command Set SEL Time. This may be done by application software on the payload side via
the KCS interface or by a remote IPMI controller via the IPMB-0.
8.7IPMI Firmware Write Protection
If the CP6003-SA/RA/RC is plugged in a write-protected CompactPCI slot, the system write
protection bit SWP in the Device Protection Register (0x284) is set to “1”. In this case, the IPMI
firmware cannot be updated or reprogrammed neither through KCS, nor through IPMB nor
through LAN. The IPMI firmware stores the write protect state in it’s local NV-RAM. The write
protect state changes if the payload is on and the system write prote ction bit SWP is set to “0”.
This bit can be read only when the payload is on.
Note ...
The write protection mode is still active when the payload is off even if the IPMI
firmware reboots. To disable the write protection mode, plug the board in a
non-write-protected CompactPCI slot and switch the payload on.
Page 34ID 1045-5656, Rev. 2.0
CP6003-SA/RA/RCIPMI Firmware
9.FRU Data
9.1Structure 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. Care must be taken when writing FRU informatio n directly using standard IPMI commands because there is no write protection. Invalid FRU information may disturb
a shelf management software which uses the FRU data.
9.2FRU Version Identification
The FRU data fields, as defined in the IPMI specification , are used to record the ve rsion of the
FRU installed. The revision number is incremented for each new release of FRU data.
Example of board FRU ID: “STD_R10”
Example of product FRU ID: “STD_R10”
9.3Board-Specific FRU Data
The following FRU data areas and data fields are supported:
FRU Board Info Area
•Manufacturing date / time
•Board manufacturer(C7): “Kontron”
•Board Product Name(C6): “CP6003-SA/RA/RC”
•Board Serial Number(CF): “123456789012345”
•Board Part Number(C9): “123456789”
•FRU File ID(C7): “STD_R10”
FRU Product Info Area
•Product manufacturer(C7): “Kontron”
•Product Name(C6): “CP6003-SA/RA/RC”
•Product Part Number(C2): “00”
•Product Version(D9): “0000000000000000000000000”
•Product Serial Number(D9): “0000000000000000000000000”
•Asset Tag(D9): “_________________________”
1)
1)
1)
P R E L I M I N A R Y
2)
2)
2)
•FRU File ID(C7): “STD_R10”
•CustomData(D5): “MAC=CC:CC:CC:CC:CC:CC”
1)
Field will be modified during the manufacturing process
2)
Field is free for user. Please note that changes need special care (checksums).
ID 1045-5656, Rev. 2.0Page 35
1)
IPMI FirmwareCP6003-SA/RA/RC
9.4FRU Data Update
Typically, an update of the FRU da ta is not n ecessary because the board’ s correct FRU dat a is
installed at the factory . If an upda te 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 f actory. Please contact
Kontron for further assistance.
9.5FRU Data Write Protection
If the write protection mode of the IPMI firmware is active, the FRU data cannot be updated,
reprogrammed or modified. For further information on the IPMI firmware write protection,
please refer to Chapter 8.7.
10.XMC Card Support
The presence or absence of an XMC card is reported by the “XMC present” sensor (refer to
sensor description).
If an XMC card is present, the card's FRU data EEPROM is readable/writable. The size of the
EEPROM must be smaller or equal to 256 bytes because of 8-bit EEPROM addressing. Note
that XMC FRU size is always reported as 256 bytes and writing to locations that are higher than
the real capacity should be avoided.
The FRU data of the XMC can be read under Linux using ipmitool fru print 1.
P R E L I M I N A R Y
Page 36ID 1045-5656, Rev. 2.0
CP6003-SA/RA/RCIPMI Firmware
11.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 an d recovery), which may contain dif ferent 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. The IPMI firmware’s parameter used for this function is configured via the
OEM IPMI command Set Control State. The IPMI controller stores this p arameter
in the EEPROM (refer to Chapter 6.3, Set Control State).
•Setting the DIP Switch SW1, switch 2, to ON results in booting from the recovery SPI boot
flash regardless of the IPMI firmware setting.
11.1Automatic SPI Boot Flash Selection During the Boot Process
After each payload reset the IPMI controller selects the SPI boot flash by applying the related
EEPROM parameter.
Physically the IPMI controller sets or resets a signal line. Afterwards, it waits for a special
message from the uEFI BIOS. This message contains the checksum report, i.e. it indicates the
validity of the SPI boot flash's checksum.
If the Set Control St ate OEM command byte 2 is set to 00h and the DIP switch SW1, switch 2,
is OFF, the uEFI BIOS boots from the st andard SPI b oot flash. If the checksum is wrong or the
message is not received within 60 seconds, then the standard SPI boot flash is assumed to
contain an invalid or a corrupted image. In this case, the IPMI controller selects the recovery
SPI boot flash and reset the board again.
If the Set Control State OEM command byte 2 is set to 01h or the DIP switch SW1, switch 2, is
ON, the uEFI BIOS boots from the recovery SPI boot flash. With this setting, the IPMI controller
does not switch over to the standard SPI boot flash if the checksum is wrong or the message
is not received. In this case, the board freezes. For this reason, it is recommended to use the
standard SPI boot flash as a default boot flash.
In case of a boot failure, the IPMI controller issues a “Boot Error (Invalid boot sector) event” by
setting the appropriate sensor value (sensor “FWHx Boot Err”. x = 0..1). “x” is the number of
the used SPI boot flash (0 = standard SPI boot flash; 1 = recovery SPI boot flash). Afterwards,
it causes a payload-off/on cycle and continues as described at the beginning of this chapter.
P R E L I M I N A R Y
11.2OS Boot Order Selection by OEM IPMI
Normally the uEFI BIOS will apply the OS boot order which was selected in the uEFI BIOS
menu “uEFI Boot/Boot Option Priorities”. But there is another alternative boot order which is
stored in the IPMI controller's non-volatile memory . This boot order can be set and read by IPMI
OEM commands. At payload start the IPMI controller writes this boot order into a register where
the uEFI BIOS can read it. If this IPMI controller's boot order has a non-zero value, the uEFI
BIOS will use it instead of its own boot order.
ID 1045-5656, Rev. 2.0Page 37
IPMI FirmwareCP6003-SA/RA/RC
12.Hot Swap and Shutdown
12.1Hot Swap Handle and Hot Swap (Blue) LED
To perform the actions required for hot swapping of the CP6003-SA/RA/RC, a hot swap state
machine with the following M-states generated by the IPMI controller is used:
•M0:Board Not Installed
•M1:Board Inactive
•M2:Board Activation Request
•M3:Board Activation in Progress
•M4:Board Active
•M5:Board Deactivation Request
•M6:Board Deactivation in Progress
The blue Hot Swap LED (HS LED) of an inserted board in a powered rack is normally used to
indicate the board's operational status so as to facilitate hot-swapping of the board:
•Hot Swap LED On
The payload is inactive:
•The board may be activated by closing the Hot Swap handle, or
•The board may be extracted. The M-state is 1.
When payload power is off e.g. after a shutdown via an IPMI chassis command and
the handle is still closed, the M-state is 1.
•Hot Swap LED Blinking
Changing from active state to inactive state or vice versa.
Don't extract the board now. The M-state is 2, 5 or 6.
•Hot Swap LED Off
The payload is active.
Don't extract the board now. Normally the extraction is impossible because the handle is
P R E L I M I N A R Y
closed and locked. The M-state is 3 or 4.
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, the 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. In this case the blue LED is switched on indicating that the payload power
is switched off although the handle is closed. Such actions are not part of the Hot Swap process
and are governed by their own functionality which is not within the scope of this document.
Page 38ID 1045-5656, Rev. 2.0
CP6003-SA/RA/RCIPMI Firmware
12.2The 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 st ate and vice versa. This is necessary to preclude improper system operation and possible loss of data. The CP6003-SA/RA/
RC has all the necessary features including hardware and IPMI software to support hot swapping. On the software side, however , not all available OS’s su pport hot swapping, not even partially . Three possible cases for hot swapping based on OS capabilities are described as follows.
Case 1: Involves an OS which does not support ACPI
After payload power on, the starting uEFI BIOS will inform the IPMI controller by sending the
IPMI command Set ACPI Power State / Set Legacy on. This means that a Hot Swap
(opening of the closed handle) shall immediately lead to payload power-off by the IPMI
controller.
In this event, the application/operator is responsible for the termination of all payload processes
prior to initiating removal/replacement of the board to avoid improper operation or loss of data.
Case 2: Involves an OS which emulates ACPI support
An OS which does not really support ACPI, such as VxWorks, is able to obt ain “Graceful Shutdown” support from the IPMI controller by performing in the following way.
After start-up, such an OS must manipulate the chipset in a way that prevents an immediate
power-off when the “power button” is logically activated.
Then it must send the IPMI command Set ACPI Power State / S0/G0 working to the
IPMI controller to enable this to process later on an S3/G2 soft off command.
During application operation the system must cyclically read the “Hot Swap Sensor” (sensor
#0) using the IPMI command Get Sensor Reading. This allows the tracking of the board's
state. After the board has once reached M-state 4 (sensor reading is 10h) the leaving of this
announces that the handle was opened. Now the time has come to terminate all processes.
After all critical processes have been terminated, the OS must send the IPMI command SetACPI Power State / S3/G2 soft off to the IPMI controller which will set the power off
immediately.
Case 3: Involves an OS which supports ACPI
When an OS is started which supports ACPI, the IPMI command Set ACPI Power State
/ S0/G0 working is sent to the IPMI controller. This indicates that the OS has repro-
grammed the chipset in such a manner tha t a “power button” signa l does not le ad to an immediate power-off but only causes an event that can be detected by the OS.
P R E L I M I N A R Y
When the handle is opened, the IPMI 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 IPMI controller which then
switches the power off.
ID 1045-5656, Rev. 2.0Page 39
IPMI FirmwareCP6003-SA/RA/RC
13.LAN Functions
13.1Overview
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.
While IOL serves to transport IPMI commands and their responses, SOL serves to transport
any serial data. In each case, the IPMI controller serves as a protocol encoder and decoder.
IOL is able to use both RMCP and RMCP+ protocols. SOL works only with the RMCP+
protocol.
Please note that IOL and SOL need the Ethernet device to be powered. Therefore, the module
(payload) must be fully powered.
13.2Setting Up the Ethernet Channel
There are two methods to configure the LAN settings (IOL/SOL) for the four Ethernet channels:
•By use of the kipmi net uEFI Shell command in the uEFI BIOS
•By use of the open tool “ipmitool” or IPMI commands
The setup methods are compatible, i.e. both methods show the parameters which are set by
the other one.
The setup is separate for all four channels. When the MAC addresses are set, the ones which
are programmed into the hardware must be re-used. This is a restriction. The IP addresses of
a channel being used by “normal” payload traffic and IOL/SOL traffic may differ but need not
differ as long as port 623 is not used in parallel by payload and IOL/SOL.
The four Ethernet ports provided by the CP6003-SA are assigned to the following channels:
Channel 2: Rear port GbE D
Channel 3: Rear port GbE C
Channel 4: Front port GbE B
P R E L I M I N A R Y
Channel 5: Front port GbE A
The four Ethernet ports provided by the CP6003-RA are assigned to the following channels:
Channel 2: Rear port GbE D
Channel 3: Rear port GbE C
Channel 4: Front/Rear port GbE A
Channel 5: Front/Rear port GbE B
The four Ethernet ports provided by the CP6003-RC are assigned to the following channels:
Channel 2: Rear port GbE D
Channel 3: Rear port GbE C
Channel 4: Rear port GbE B
Channel 5: Rear port GbE A
Page 40ID 1045-5656, Rev. 2.0
CP6003-SA/RA/RCIPMI Firmware
13.3Basic 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.4Setup by “ipmitool” or IPMI Commands
The open tool “ipmitool” offers commands for the setup of the four Ethernet channels. All possible options are shown by issuing:
ipmitool lan set
If “ipmitool” is not usable, the LAN parameters can be set by using standard IPMI commands
as defined in the IPMI specification.
To show the current LAN parameters for a channel, “ipmitool” offers the command:
ipmitool lan print <channel = 2, 3, 4, 5>
13.5Setup of User Accounts and Password
The open tool “ipmitool” offers commands for the listing and manipulation of user accounts for
channels 1 through 4. An overview can be obtained by issuing:
ipmitool user
The predefined user accounts for a channel can be listed using the following command:
ipmitool user list <channel = 2, 3, 4, 5>
For every channel, the CP6003-SA/RA/RC has these predefinitions in non-volatile memory:
ID Name Callin Link Auth IPMI Msg Channel Priv Limit
1 false true true USER
2 admin false true true ADMINISTRATOR
Please note that the ADMINISTRATOR password is preset with admin.
Changed accounts and passwords stay valid after payload power-off.
The accounts must be activated using the following command:
ipmitool user enable <user number>
P R E L I M I N A R Y
ID 1045-5656, Rev. 2.0Page 41
IPMI FirmwareCP6003-SA/RA/RC
13.6IPMI 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 <channel = 2, 3, 4, 5> access on
Please note that the following commands must use the IP address which belongs to the enabled channel.
The open tool “ipmitool” can serve as a control program and user interface for this. “ipmitool”
allows the issuing of generic IPMI commands such as:
ipmitool -I lan -H 192.168.3.189 -U adm in -P adm in -A PA SSWOR D raw 6 1
or to call complex functions like “mc.info”:
ipmitool -I lan -H 192.168.3.189 -U admin -P admin -A PASSWORD mc info
This uses many generic IPMI commands to get the information needed.
13.7Serial Over LAN (SOL)
Serial over LAN connects the COM1 or /dev/ttyS0 respectively of the CP6003-SA/RA/RC's
payload side to an Ethernet channel. The IPMI controller resides between this serial interface
and one of the Ethernet channels. It serves as an encoder and a decoder for the used RMCP+
protocol and controls the data stream. Outside the CP6 003-SA/RA/RC, for examp le, the op en
tool “ipmitool” can be used to drive the SOL session, i.e. it of fers a console function to communicate via Ethernet with the CP6003-SA/RA/RC's serial interface.
The IPMI firmware supports only “straight password authentication” SOL sessions with default
privilege level USER.
Opening an SOL session requires special parameters as shown below:
P R E L I M I N A R Y
ipmitool -I lanplus -H 192.168.3. 18 9 -U adm in -P adm in -L USE R -C 0 sol
activate
The serial interface can be used as a connection, for example:
•To a user program on the CP6003-SA/RA/RC payload
•To the uEFI BIOS. Refer to the Main Setup menu, Serial Port Console Redirection
function in the CP6003-SA/RA/RC uEFI BIOS User Guide. The serial parameters can be
set via this function.
•To a Linux login console. This can be activated after payload start, for example, by the
command:
getty -h 115200 /dev/ttyS0
SOL supports and requires serial hardware handshake. This should be activated for the serial
port. Otherwise transmitted data might get lost. In any case the same serial p arameters for the
payload side serial interface and the IPMI controller's serial interface must be used.
Page 42ID 1045-5656, Rev. 2.0
CP6003-SA/RA/RCIPMI 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:
ipmitool sol help
14.OS Support / Tools
14.1Linux 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. 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.
ipmitool
Another very useful all-in-one tool is “ipmitool” (http://ipmitool.sourceforge.net ). It provides a
user-friendly interface to many IPMI features and extensions, for example, to get sensor readings, change sensor thresholds or to access other IPMI controlle rs via IPMB. Befor e “ipmitool”
can be used the OpenIPMI driver, mentioned above, must be loaded too.
14.2OS Support - Board Support Packages
For information on the operating systems supported with the CP6003-SA/RA/RC, please refer
to the CP6003-SA/RA/RC’s data sheet. Please visit “http://www.kontron.com” to download the
data sheet. Please also have a look at the download section for the latest versions of Board
Support Packages or Firmware Updates.
For further information concerning IPMI, refer to the BSP documentation for the respective OS.
P R E L I M I N A R Y
ID 1045-5656, Rev. 2.0Page 43
IPMI FirmwareCP6003-SA/RA/RC
HS LED
IPMI LEDs
I0 and I1
HS LED
CP6003-SACP6003-RA
IPMI LEDs
I0 and I1
15.IPMI and Hot Swap LEDs
On the CP6003-SA/RA, there are three LEDs controlled by the IPMI controller, two IPMI S t atus
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.
The following figure illustrates the location of the two IPMI LEDs and the HS LED on the
CP6003-SA/RA.
P R E L I M I N A R Y
Page 44ID 1045-5656, Rev. 2.0
CP6003-SA/RA/RCIPMI Firmware
Temperature Sensor
JP1
DLED 0
DLED 1
DLED 2
DLED 3
R778R756
R771 R759
IPMI LED I1
IPMI LED I0
IPMI LEDs
I0 and I1
The following figure illustrates the location of the two IPMI LEDs on the CP6003-RC.
The following table describes the functions of the IPMI LEDs and the Hot Swap LED.
Table 14:IPMI and Hot Swap LEDs Function
LEDCOLORNORMAL MODEOVERRIDE MODE
I0 (right)redOff = board powered / runningSelectable by user
On = board out of service (frmware not running)
greenPulsing = traffic on the IPMB bus
I1 (left)redOn = health error detectedSelectable by user
greenOff = no health error detected
Pulsing = KCS interface active
Blinking = IPMI controller running showing its heart beat
red/amberSlow blinking = health error detected, IPMI controller running
showing its heart beat
Pulsing = health error detected, KCS interface active
HS LEDblueOn = a) board ready for hot swap extraction, or
b) board has just been inserted in a powered system
Off = board in normal operation (do not extract the board)
Blinking = board hot swap in progress; board not ready for
extraction
• Only lamp test
• Only lamp test
Selectable by user
• Only lamp test
P R E L I M I N A R Y
ID 1045-5656, Rev. 2.0Page 45
IPMI FirmwareCP6003-SA/RA/RC
This page has been intentionally left blank.
P R E L I M I N A R Y
Page 46ID 1045-5656, Rev. 2.0
Loading...
+ hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.