advertisement
IPMI Firmware User Guide for the
AM4010
Module
Manual ID: 36363, Rev. Index 1.1
Firmware: SK-IPMI-AM4010, EKS Idx 0101
June 12, 2007
IPMI Firmware User Guide: AM4010
1. Copyright
Copyright © 2007 Kontron AG
Kontron Modular Computers makes no representations or warranties with respect to the contents or use of this manual, and specifically disclaims any express or implied warranties of merchantability or fitness for any particular purpose.
Kontron Modular Computers makes no representations or warranties with respect to this embedded Linux package, and specifically disclaims any express or implied warranties of merchantability or fitness for any particular purpose.
Permission is granted to make and distribute verbatim copies of this manual provided that the copyright notice and this permission notice are preserved on all copies.
Permission is granted to copy and distribute modified versions of this documentation under the conditions for verbatim copying, provided also that the entire resulting derived work is distributed under the terms of a permission notice identical to this one.
Permission is granted to copy and distribute translations of this documentation into another language, under the above conditions for modified versions.
The PICMG® and CompactPCI® names and the PICMG®, CompactPCI®, ATCA®, and
AdvancedTCA® logos are registered trademarks and AdvancedMC is a trademark of the PCI
Industrial Computer Manufacturers Group.
Intel is a registered trademark of Intel Corporation.
I
2
C is a trademark of Phillips Semiconductors.
Linux is a registered trademark of Linus Torvalds.
All other trademarks, registered trademarks, and trade names are the property of their respective owners.
Page
2
© 2007 Kontron AG ID: 36363, Rev. 1.1
IPMI Firmware User Guide: AM4010
Manual/Product Title:
IPMI Firmware User Guide for the AM4010 Module xxxxx Manual ID Number:
Revision Index Brief Description of Changes Date of Issue
Draft / 0.0
1.0
Initial Issue
Completed
May 3, 2007
May 22, 2007
1.1 Revised June 12, 2007
Imprint
Kontron Modular Computers GmbH may be contacted via the following:
MAILING ADDRESS
TELEPHONE AND E-MAIL
Kontron Modular Computers GmbH
Sudetenstraße 7
D - 87600 Kaufbeuren Germany
+49 (0) 800-SALESKONTRON [email protected]
For further information about other Kontron products, please visit our Internet web site: www.kontron.com
Disclaimer
Copyright © 2007 Kontron AG. All rights reserved. All data is for information purposes only and not guaranteed for legal purposes. Information has been carefully checked and is believed to be accurate; however, no responsibility is assumed for inaccuracies. Kontron and the
Kontron logo and all other trademarks or registered trademarks are the property of their respective owners and are recognized. Specifications are subject to change without notice.
ID: 36363, Rev. 1.1 © 2007 Kontron AG Page
3
IPMI Firmware User Guide: AM4010
3. Contents
5.1 IPMI in AdvancedMC / AdvancedTCA Environment ............................................... 8
6.2.2.1 Get Device ID command with OEM extensions .......................................... 17
6.2.2.3 Set Control State (Firmware Hub, Boot Order)............................................ 19
6.2.2.4 Get Control State (Firmware Hub, Boot Order) ........................................... 19
6.10 BIOS Supervisory and Automated Firmware Hub Switch....................................... 29
Page
4
© 2007 Kontron AG ID: 36363, Rev. 1.1
IPMI Firmware User Guide: AM4010
6.12.2.2 Setup by ipmitool or IPMI commands ..................................................... 31
ID: 36363, Rev. 1.1 © 2007 Kontron AG Page
5
IPMI Firmware User Guide: AM4010
4. Introduction
KCS
MMC
MP
PICMG
PWR
SDR
SDRR
SEL
SMBIOS
SMS
SOL
AMC
BSP
DMI
FRU
FWH
I
2
C
IPMB
IPMB-0
IPMB-L
IPMC
IPMI
IOL
Advanced Mezzanine Card
Board Support Package
Desktop Management Interface
Field Replaceable Unit
Firmware Hub
Inter-Integrated Circuit
Intelligent Platform Management Bus
AdvancedTCA shelf-level IPMB
Local, on-carrier IPMB that links the carrier IPMC with the MMCs of installed modules
Intelligent Platform Management Controller located on AMC carrier
Intelligent Platform Management Interface
IPMI over LAN. An MMC is accessed via LAN, not IPMB
Keyboard Controller Style
Module Management Controller – an IPMI controller located on the AMC module
Management Power
PCI Industrial Computer Manufacturer Group
Payload Power
Sensor Data Record
Sensor Data Record Repository
System Event Log
System Management BIOS
System Management Software (designed to run under the OS)
Serial over LAN. A serial interface is redirected by LAN using the RMCP+ protocol.
Page
6
© 2007 Kontron AG ID: 36363, Rev. 1.1
IPMI Firmware User Guide: AM4010
IPMI specifications: ( http://www.intel.com/design/servers/ipmi/spec.htm
)
• IPMI-Intelligent Platform Management Interface Specification. Second Generation v2.0, February 12, 2004 (part)
• [2] IPMI- Platform Management FRU Information Storage Definition v1.0,
Document Revision 1.1, September 1999
PICMG specifications: http://www.picmg.org
• PICMG® AMC.0 R1.0 - Advanced Mezzanine Card Base Specification
• PICMG® AMC.1 R1.0 - PCI Express and Advanced Switching on AdvancedMC
• PICMG® AMC.2 R1.0 – AMC Gigabit Ethernet/10 Gigabit XAUI Ethernet
Open tool’s documentation
• [1] Ipmitool documentation: http://ipmitool.sourceforge.net
• OpenIPMI documentation: http://www.openipmi.sourceforge.net
Kontron manuals and specifications: http://www.kontron.com/
• AM4010 User’s Guide
• [3] AM4010 Linux Board Support Package
As a hot-swappable field replaceable unit (FRU), the AM4010 follows the stringent carrier grade RASM feature set, namely - Reliability, Availability, Serviceability, Maintainability.
Built in accordance to the AMC.0 specification, the AM4010 is also AMC.1 and AMC.2 compliant and is easily managed via IPMI v1.5/v2.0.
As with every Advanced Mezzanine Card (AMC) the AM4010 is equipped with a Module
Management Controller (MMC).
ID: 36363, Rev. 1.1 © 2007 Kontron AG Page
7
IPMI Firmware User Guide: AM4010
5. Introduction
5.1 IPMI in AdvancedMC / AdvancedTCA Environment
The Module Management Controller is a crucial component of any AMC module. Besides acting as a regular IPMI management controller (sensor monitoring, event logging, etc.), it also provides an interface to all necessary data related to module power requirements and implemented interfaces (E-Keying). Further, it plays an active role in the module hot swap state management. The carrier IPMI Controller (IPMC) communicates with the MMC using the local IPMB (IPMB-L) bus. In an ATCA/AMC environment, it is the IPMC that actually turns on/off module (payload) power. However, before the IPMC enables the module payload power, various criteria must be satisfied by both the carrier and the module, including power requirements and capabilities, matching interfaces, current module hot swap state, and any other special conditions as specified by the Shelf Manager policy.
5.2 The Module Management Controller Hardware
On the AM4010 module, the MMC is implemented using the Renesas H8S/2166 controller with 512 kB of internal flash and 40 kB of RAM. An additional 1 MB serial EEPROM chip provides redundant firmware image storage. A separate 32 kB serial EEPROM chip is used for firmware private data and 4 kB FRU Inventory storage.
The MMC circuit implements two local Keyboard Style Interfaces (KCS) with interrupt support for communication with system side management software and the IPMB-L bus for interconnection with the IPMC.
IPMI over LAN (IOL) is supported by two Ethernet channels.
The MMC implements a wide range of sensors that permit the monitoring of:
• main power voltages: +12V (PWR), +5V, +3.3V, +3.3V (MP), +1.5V, +1.8V,
+0.9V (DDR)
• temperatures: CPU die, MCH die, board inlet and outlet near CPU, board inlet and outlet near MCH
• Power Good, LAN links, IPMB link, NMI and SMI lines, board reset, post code, boot error, processor hot (>100 °C), IPMB-L state, Health error, IPMI watchdog etc.
Page
8
© 2007 Kontron AG ID: 36363, Rev. 1.1
IPMI Firmware User Guide: AM4010
• compliant with the related IPMI and PICMG® specifications (refer to 4.2, Related
• firmware designed and specially made for AdvancedMC environments
• supports two KCS interfaces with interrupt support
• supports the local IPMB (IPMB-L) interface
• out of band management and monitoring using IPMB-L interface permits access to sensors regardless of module CPU state
• sensor thresholds fully configurable
• sensor names prefixed with AMC module Bay ID (A1…4, B1…4)
• Usable in µTCA slots 1…12. Sensor names for slots 9…12 are prefixed with
R9…R12
• complete IPMI watchdog functionality
• complete FRU functionality (refer to 6.7)
• firmware can be updated in the field (refer to 6.4.2)
• two firmware banks implemented, firmware bank management is done by the open
tool ipmitool (function fwum) [1] (refer to 6.4.1)
• downloading new firmware image does not break currently running firmware
• manual and automatic firmware image roll-back (in case of upgrade failure). Refer
• firmware customizable per BIOS menu or per OEM IPMI commands (refer to 6.5)
• interoperable with other AMC, ATCA, or IPMI solutions
• OEM board supervision and control extensions such as firmware hub select and
boot order configuration (refer to 6.2.2)
• BIOS supervisor and automated switch to recover image from second firmware
• Serial over LAN (SOL, refer to 6.12.5) support
• IPMI over LAN (IOL, refer to 6.12.4) support
• Graceful shutdown support (refer to 6.11)
• “Health” LED shows heartbeat and pulses if a KCS interface is active. The “out-
of-service” (OOS) LED pulses when IPMB-L is active (refer to 7).
• If the carrier supplies an external clock 3 the module will use it. Otherwise the
module will use the internal PCIe clock (refer to 6.9).
ID: 36363, Rev. 1.1 © 2007 Kontron AG Page
9
IPMI Firmware User Guide: AM4010
Part of the command list in IPMI specification 2.0
M = mandatory, O = optional
IPMI 2.0
Spec. section
NetFn CMD
IPM Device “Global” Commands
Get Device ID 20.1
Cold Reset
Warm Reset
Get Self Test Results
Manufacturing Test On
Set ACPI Power State
Get ACPI Power State
Get Device GUID
Broadcast “Get Device ID”
BMC Watchdog Timer
Commands
Reset Watchdog Timer
Set Watchdog Timer
Get Watchdog Timer
20.2
20.3
20.4
20.5
20.6
20.7
20.8
20.9
27.5
27.6
27.7
App
App
App
App
App
App
App
App
App
App
App
App
01h
02h
03h
04h
05h
06h
07h
08h
01h
22h
24h
25h
Kontron support
On MMC
M
M / Yes [3]
O / Yes
O / No
O / Yes
O / No
O / No
O / No
O / No
M / Yes
O
O / Yes
O / Yes
O / Yes
Page
10
© 2007 Kontron AG ID: 36363, Rev. 1.1
IPMI Firmware User Guide: AM4010
BMC Device and Messaging
Commands
Set BMC Global Enables
O
22.1 App 2Eh O / Yes
Get BMC Global Enables 22.2 App 2Fh
O / Yes
Clear Message Flags 22.3 App 30h
O / Yes
Get Message Flags 22.4 App 31h
O / Yes
Enable Message Channel Receive 22.5 App 32h
O / Yes
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 / Yes
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.20 App 3Dh
O / Yes
Get AuthCode 22.21 App 3Fh
O / No
Set Channel Access 22.22 App 40h
O / Yes
Get Channel Access 22.23 App 41h
O / Yes
Get Channel Info 22.24 App 42h
O / Yes
Set User Access 22.26 App 43h
O / Yes
Get User Access 22.27 App 44h
O / Yes
Set User Name 22.28 App 45h
O / Yes
Get User Name 22.29 App 46h
O / Yes
Set User Password
Activate Payload
Deactivate Payload
Get Payload Activation Status
22.30
24.1
24.2
24.4
App
App
App
App
47h
48h
49h
4Ah
O / Yes
O / Yes
O / Yes
O / Yes
Get Payload Instance Info
Set User Payload Access
24.5
24.6
App
App
4Bh
4Ch
O / Yes
O / Yes
O / Yes
Get User Payload Access
Get Channel Payload Support
24.7
24.8
App
App
4Dh
4Eh
O / Yes
Get Channel Payload Version 24.9 App 4Fh O / Yes
Get Channel OEM Payload Info 24.10 App 50h
O / No
Master Write-Read 22.11 App 52h
O / Yes
22.15 App 54h
O / No
Get Channel Cipher Suits
Suspend/Resume Payload
Encryption
Set Channel Security Keys 22.25 App 56h
O / No
Get System Interface Capabilities 22.9 App 57h
O / No
ID: 36363, Rev. 1.1 © 2007 Kontron AG Page
11
IPMI Firmware User Guide: AM4010
Chassis Device Commands
Get Chassis Capabilities 28.1
Get Chassis Status
Chassis Control
Chassis Reset
Chassis Identify
Set Chassis Capabilities
Set Power Restore Policy
Get System Restart Cause
Set System Boot Options
Get System Boot Options
Get POH Counter
Event Commands
Set Event Receiver
Get Event Receiver
Platform Event (a.k.a. “Event
Message”)
PEF and Alerting Commands
Get PEF Capabilities
Arm PEF Postpone Timer
30.1
30.2
Set PEF Configuration Parameters 30.3
Get PEF Configuration Parameters 30.4
Set Last Processed Event ID 30.5
Get Last Processed Event ID 30.6
Alert Immediate
PET Acknowledge
30.7
30.8
28.13
28.14
29.1
29.2
28.2
28.3
28.4
28.5
28.7
28.8
28.11
28.12
Chassis
Chassis
Chassis
Chassis
Chassis
Chassis
Chassis
Chassis
Chassis
Chassis
Chassis
S/E
S/E
S/E
S/E
S/E
S/E
S/E
S/E
S/E
S/E
10h
11h
12h
13h
14h
15h
16h
17h
00h
09h
0Fh
01h
02h
01h
02h
03h
04h
05h
06h
07h
08h
O
O / No
O / No
O / No
O / No
O / No
O / No
O / No
O / No
O / Yes
O / Yes
O / Yes
O / No
O / No
O / No
O / No
O / No
O / No
O / No
O / No
O / Yes [1]
M
M / Yes
M / Yes
Page
12
© 2007 Kontron AG ID: 36363, Rev. 1.1
IPMI Firmware User Guide: AM4010
Sensor Device Commands
Get Device SDR Info
Get Device SDR
Reserve Device SDR Repository
Get Sensor Reading Factors
Set Sensor Hysteresis
Get Sensor Hysteresis
Set Sensor Threshold
Get Sensor Threshold
Set Sensor Event Enable
Get Sensor Event Enable
Re-arm Sensor Events
Get Sensor Event Status
Get Sensor Reading
Set Sensor Type
Get Sensor Type
FRU Device Commands
Get FRU Inventory Area Info
Read FRU Data
Write FRU Data
SDR Device Commands
Get SDR Repository Info
Get SDR Repository Allocation
Info
Reserve SDR Repository
Get SDR
Add SDR
Partial Add SDR
34.1
34.2
34.3
33.9
33.10
33.11
33.12
33.13
33.14
Delete SDR
Clear SDR Repository
Get SDR Repository Time
Set SDR Repository Time
Enter SDR Repository Update
Mode
33.15
33.16
33.17
33.18
33.19
Exit SDR Repository Update Mode 33.20
Run Initialization Agent 33.21
35.2
35.3
35.4
35.5
35.6
35.7
35.8
35.9
35.10
35.11
35.12
35.13
35.14
35.15
35.16
20h
21h
22h
23h
24h
25h
26h
27h
28h
29h
2Ah
2Bh
2Dh
2Eh
2Fh
10h
11h
12h
20h
21h
26h
27h
28h
29h
22h
23h
24h
25h
2Ah
2Bh
2Ch
S/E
S/E
S/E
S/E
S/E
S/E
S/E
S/E
S/E
S/E
S/E
S/E
S/E
S/E
S/E
Storage
Storage
Storage
Storage
Storage
Storage
Storage
Storage
Storage
Storage
Storage
Storage
Storage
Storage
Storage
Storage
O / No
O / No
O / No
O / No
O / No
O / No
O / No
O / No
O / No
M
M / Yes
M / Yes
M / Yes
O
O / No
O / No
M
M / Yes
M / Yes
M / Yes
O / No
O / Yes
O / Yes
O / Yes
O / Yes
O / Yes
O / Yes
O / No
O / No
M / Yes
O / No
O / No
O / No
O / No
ID: 36363, Rev. 1.1 © 2007 Kontron AG Page
13
IPMI Firmware User Guide: AM4010
SEL Device Commands
Get SEL Info 40.2
Get SEL Allocation Info
Reserve SEL
Get SEL Entry
Add SEL Entry
Partial Add SEL Entry
Delete SEL Entry
Clear SEL
Get SEL Time
Set SEL Time
Get Auxiliary Log Status 40.12
Set Auxiliary Log Status 40.13
LAN Device Commands
Set LAN Configuration Parameters 23.1
40.3
40.4
40.5
40.6
40.7
40.8
40.9
40.10
40.11
Get LAN Configuration Parameters 23.2
Suspend BMC ARPs 23.3
Get IP/UDP/RMCP Statistics 23.4
Serial/Modem Device Commands
Set Serial/Modem Configuration 25.1
Get Serial/Modem Configuration 25.2
Set Serial/Modem Mux
Get TAP Response Codes
25.3
25.4
Set PPP UDP Proxy Transmit Data 25.5
Get PPP UDP Proxy Transmit Data 25.6
Send PPP UDP Proxy Packet 25.7
Get PPP UDP Proxy Receive Data 25.8
Serial/Modem Connection Active 25.9
Callback 25.10
Set User Callback Options
Get User Callback Options
25.11
25.12
SOL Activating 26.1
Get SOL Configuration Parameters 26.2
Set SOL Configuration Parameters 26.3
40h
41h
42h
43h
44h
45h
46h
47h
48h
49h
5Ah
5Bh
01h
17h
18h
19h
1Ah
1Bh
20h
21h
22h
11h
12h
13h
14h
15h
16h
02h
03h
04h
10h
Storage
Storage
Storage
Storage
Storage
Storage
Storage
Storage
Storage
Storage
Storage
Storage
Transport
Transport
Transport
Transport
Transport
Transport
Transport
Transport
Transport
Transport
Transport
Transport
Transport
Transport
Transport
Transport
Transport
Transport
Transport
O / No
O / No
O / No
O / No
O / Yes
O / Yes
O / Yes
O
O / No
O / No
O / No
O / No
O / No
O / No
O / No
O / No
O
O / No
O / No
O / No
O / No
O / No
O / No
O / No
O / No
O / No
O / No
O / No
O / No
O
O / Yes
O / No
O / Yes
O / Yes
Page
14
© 2007 Kontron AG ID: 36363, Rev. 1.1
IPMI Firmware User Guide: AM4010
Bridge Management Commands
(ICMB)
Get Bridge State
Set Bridge State
Get ICMB Address
Set ICMB Address
Set Bridge Proxy Address
Get Bridge Statistics
Get ICMB Capabilities
Clear Bridge Statistics
Get Bridge Proxy Address
Get ICMB Connector Info
Get ICMB Connection ID
Send ICMB Connection ID
Discovery Commands (ICMB)
Prepare For Discovery
Get Addresses
Set Discovered
Get Chassis Device ID
Set Chassis Device ID
Bridging Commands (ICMB)
Bridge Request
Bridge Message
Event Commands (ICMB)
Get Event Count
Set Event Destination
Set Event Reception State
Send ICMB Event Message
Get Event Destination
Get Event Reception State
OEM Commands for Bridge
NetFn
OEM Commands
Other Bridge Commands
Error Report
[ICMB]
[ICMB]
[ICMB]
[ICMB]
[ICMB]
[ICMB]
[ICMB]
[ICMB]
[ICMB]
[ICMB]
[ICMB]
[ICMB]
[ICMB]
[ICMB]
[ICMB]
[ICMB]
[ICMB]
[ICMB]
[ICMB]
[ICMB]
[ICMB]
[ICMB]
[ICMB]
[ICMB]
[ICMB]
[ICMB]
[ICMB]
Bridge
Bridge
Bridge
Bridge
Bridge
Bridge
Bridge
Bridge
Bridge
Bridge
Bridge
Bridge
Bridge
Bridge
Bridge
Bridge
Bridge
Bridge
Bridge
Bridge
Bridge
Bridge
Bridge
Bridge
Bridge
Bridge
Bridge
11h
12h
13h
14h
20h
01h
02h
03h
04h
05h
06h
08h
09h
0Ah
0Bh
0Ch
10h
00h
21h
30h
31h
32h
33h
34h
35h
O
C0h-FEh O / No
FFh
O
O / No
O
O / No
O / No
O / No
O / No
O / No
O / No
O
O / No
O / No
O / No
O / No
O / No
O / No
O / No
O / No
O / No
O / No
O / No
O / No
O
O / No
O / No
O / No
O / No
O / No
O
O / No
O / No
ID: 36363, Rev. 1.1 © 2007 Kontron AG Page
15
IPMI Firmware User Guide: AM4010
AdvancedTCA
®[
10 ]
Get PICMG Properties
Get Address Info
Get Shelf Address Info
Set Shelf Address Info
FRU Control
Get FRU LED Properties
Get LED Color Capabilities
Set FRU LED State
Get FRU LED State
Set IPMB State
Set FRU Activation Policy
Get FRU Activation Policy
Set FRU Activation
Get Device Locator Record ID
Set Port State
Get Port State
Compute Power Properties
Set Power Level
Get Power Level
Renegotiate Power
Get Fan Speed Properties
Set Fan Level
Get Fan Level
Bused Resource
Get IPMB Link Info
AMC
Set AMC Port State
Get AMC Port State
PICMG
®
3.0
Table
3-9
Table 3-27
Table 3-28
PICMG
3-41
3-42
3-60
3-62
3-61
3-51
3-17
3-18
3-16
3-29
3-8
3-13
3-14
3-22
3-24
3-25
3-26
3-27
3-66
3-63
3-65
PICMG
PICMG
PICMG
3-64
3-44
PICMG
PICMG
3-49
AMC.0 Table
PICMG
PICMG
PICMG
PICMG
PICMG
PICMG
PICMG
PICMG
PICMG
PICMG
PICMG
PICMG
PICMG
PICMG
PICMG
PICMG
PICMG
PICMG
PICMG
PICMG
PICMG
00h
18h
19h
20h
0Eh
0Fh
10h
11h
12h
09h
0Ah
0Bh
0Ch
0Dh
13h
14h
15h
16h
17h
01h
02h
03h
04h
05h
06h
07h
08h
M
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
N/A
M / Yes
N/A
M / Yes
N/A
N/A
N/A
M / Yes [2]
M / Yes
M / Yes
M / Yes
M / Yes
N/A
O / Yes
O / Yes
[1] Response byte 2: hours, byte 3: minutes after module start. Bytes 4..6: void
[2] Request byte 3: = only 04h (quiesced) implemented.
[3] Has oem extensions. Please refer to 6.2.2.1, Get Device ID command with OEM extensions
Page
16
© 2007 Kontron AG ID: 36363, Rev. 1.1
IPMI Firmware User Guide: AM4010
6.2.2 OEM Commands and Extensions
6.2.2.1 Get Device ID command with OEM extensions
Get Device ID command with OEM extensions
LUN NetFn CMD
00h App = 06h 01h
Request Data
Response Data
Byte Data Field
-
2:12 Regular Get Device ID Command response fields
13 Release index (e.g. 101 denotes release index 1.01)
Please note: Some tools offer this as “SDR version”.
14 Module Geographical Address (site number):
1 … 8 = Module in AMC bay A1, A2 ,A3, A4, B1, B2, B3, B4
or in µTCA slot 1 … 8 with bus addresses
72h, 74h, 76h, 78h, 7ah, 7ch, 7eh, 80h
9 …12 = Module in µTCA slot 9 … 12 with bus addresses
82h, 84h, 86h,88h
0, > 12 = Module position is not in range. The IPMB-L bus is
switched off (ref. to 8.3).
15 Reserved
16 Reserved
ID: 36363, Rev. 1.1 © 2007 Kontron AG Page
17
IPMI Firmware User Guide: AM4010
6.2.2.2 Set Firmware Parameters
The command below permits the selection of interrupts to be used during KCS communication. The value of FFh instructs MMC not to drive the interrupt request line at all, while the value of 07h forces it to use the ISA style IRQ7 line. Please refer to chapter
6.5 of this manual for further details regarding MMC configuration.
Set Firmware Parameters
LUN NetFn CMD
03h OEM = 3Eh 05h
Request data
Byte Data Field
1 Reserved
B4h
2 Reserved
90h
3 Reserved
91h
4 Reserved
8Bh
[6:2] Reserved
[1] 0b = get only
[0] 0b = do not reset
[7:5] Reserved
[4] Reserved
[3:1] Reserved
[0] Reserved (=1b)
FFh = do not use interrupts
0Ah = use IRQ10
0Bh = use IRQ11
Any other values Reserved.
Response data
Page
18
© 2007 Kontron AG ID: 36363, Rev. 1.1
IPMI Firmware User Guide: AM4010
6.2.2.3 Set Control State (Firmware Hub, Boot Order)
Set Control State (Firmware Hub, Boot Order)
LUN NetFn CMD
00h OEM = 3Eh 20h
Request data
Byte Data Field
1 Control ID
00h: Firmware Hub Flash Select
9Dh: Boot Order Configuration
2 Control State (refer to AM4010 User Guide)
00h .. 01h for control ID = Firmware Hub Flash Select
00h .. FFh for control ID = Boot Order Configuration.
(These settings are stored in EEPROM and applied (to logic) each time the MMC detects power-on)
00h: No override, boot as usual
01h: Next boot device is: Floppy
02h: Next boot device is: HDD
03h: Next boot device is: CD
04h: Next boot device is: Network
Response data 1 Completion
6.2.2.4 Get Control State (Firmware Hub, Boot Order)
Get Control State (Firmware Hub, Boot Order)
LUN NetFn CMD
00h OEM = 3Eh 21h
Byte Data Field
Request data 1 Control ID
00h Firmware Hub Flash Select
9Dh Boot Order Configuration
Response data
4 Control State (refer to AM4010 User Guide)
00h .. 01h for control ID = Firmware Hub Flash Select
00h .. FFh for control ID = Boot Order Configuration
ID: 36363, Rev. 1.1 © 2007 Kontron AG Page
19
IPMI Firmware User Guide: AM4010
6.2.2.5 OEM Module Quiescence Feedback
Overview
Please refer to 6.11, Hot Swap.
If the OS doesn’t fully support ACPI this command provides support to control a graceful shut down of the AM4010. There is a Graceful Reboot and Shutdown Daemon (grnsd) for
Linux included in the newest Linux BSPs being offered by Kontron. It works as being described in the following (refer to “Usage for a self written shut down daemon” below).
If ACPI is fully supported this command can be used to set a timeout time for the case that the ACPI means (ACPI daemon etc.) are unable to shut down the system in time. As a default value at system start this time is set to 0 (endless wait).
Usage for a self written shut down daemon
This command normally is used by a shut down daemon in a non ACPI supporting software environment. If a timeout time has to be set to avoid an endless waiting for the sleep state the daemon calls this command after system start with the “set quiesce wait timeout” bit set and the “Quiesce wait timeout” time <> 0. Afterwards the daemon calls this command cyclically with the “OS daemon present” bit set. When the MMC gets a
FRU Control (Quiesce) request from the carrier (e.g. during a Hot Swap sequence) it sets the “quiesce request (FRU Control)” bit in its command response. After the daemon sees this bit set in the response it should shut down the system. After having set the
“quiesce request (FRU Control)” bit the MMC starts the timeout timer (if a timeout time was defined) and monitors the sleep signal line to recognize the sleep state which should be caused by the shut down. When the MMC detects the sleep state
(signal) or it receives a command with the “quiescence acknowledge” bit set or the timeout timer has expired, the MMC sends a “Module Hot Swap event” message to the carrier, and in the following the payload power will be switched off.
If no daemon is announced as present
If no command call announces that a daemon is present, the MMC automatically uses the default timeout time 0 (endless wait) during the Hot Swap process. But if the timeout time was set to a value 1…255 by this time will be used in any case while waiting for the sleep state (signal).
OEM Module Quiescence Feedback
LUN NetFn CMD
00h OEM = 3Eh 40h
Request data
Byte Data Field
1 Control bits:
[7] - 1b = set quiesce wait timeout
[6] - 1b = quiescence acknowledge (OS ready)
[5] - 1b = OS daemon present
[4:0] Reserved
Page
20
© 2007 Kontron AG ID: 36363, Rev. 1.1
IPMI Firmware User Guide: AM4010
Response data
2 Quiesce wait timeout [sec] a) An OS daemon is present (refer to bits above):
This is the maximum time from the moment on that the
MMC receives FRU Control (Quiesce) request until
it sends back the appropriate Module Hot Swap event
message. b) No OS daemon is present (refer to bits above):
This is the maximum time from the moment on that the
MMC receives FRU Control (Quiesce) request until
it sends back the appropriate Module Hot Swap event
message.
If sleep state is recognized before timeout then the
Module Hot Swap event message will be sent
immediately. If the time is set to 0 (default after reset)
then the Module Hot Swap event message will only be
sent after recognition of sleep state (signal).
1 Completion code: 00h
2 Control bits:
[7] - Reserved
[6] - 1b = quiescence acknowledge (OS ready)
[5] - 1b = OS daemon present
[4] - 1b = quiesce request (FRU Control)
[3] - Reserved
[2] - 1b = graceful reboot request (FRU Control)
[1] - 1b = quiescence reached (MMC acknowledge)
[0] - 1b = module hot swap switch opened
3 Quiesce wait timeout (valid only if OS daemon present = 1)
Settings changed with this command are volatile (in particular quiesce timeout and OS daemon present). Bits [6:5] are always settable, but once the quiesce request comes they cannot be cleared until quiescence state is entered and exited.
ID: 36363, Rev. 1.1 © 2007 Kontron AG Page
21
IPMI Firmware User Guide: AM4010
6.3 Sensors Implemented on the AM4010
The MMC includes many 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 sensors identification such as sensor type, sensor name, sensor unit.
SDRs also contain the configuration of a specific sensor such as threshold/hystheresis, event generation capabilities that specifies sensor behavior. Some field of the sensor SDR are configurable through IPMI v1.5 command and are set to built-in initial value. Finally one field which is the sensor owner must reflect the module addresses that allow the AMC Carrier to identify the owner of the SDR when it is scanned from the module management controller and merged within the AMC Carrier Device SDR repository.
From IPMI perspective, the MMC is set up as a satellite management controller (SMC). It does support sensor devices, and uses the IPMI static sensor population feature of IPMI v1.5.
All SDRs can be queried using Device SDR commands to the MMC.
The sensor name in its SDR has a name prefix which after module insertion is automatically adapted to the physical position of the module in a carrier or in a µTCA chassis. The format of this prefix is
• in AMC bay 1…8 or µTCA slot 1…8: ‘A1:’, ‘A2:’, ‘A3:’, ‘A4:’, ‘B1:’, ‘B2:’, ‘B3:’,
‘B4:’.
• in µTCA slot 9…12: ‘R9:’, ‘Ra:’, ‘Rb:’, ‘Rc:’.
Please note that in the case that the module is installed elsewhere, then the IPMB-L address of the module is unknown and the interface is off.
Module sensors that have been implemented are listed in the sensor list below.
For OEM (Kontron) specific sensor types and codes in the following table please refer to
SENSOR
NAME
IPMI Info-1
IPMI Info-2
SENSOR TYPE
(CODE) /
EVENT/READING
TYPE (CODE)
OEM Firmware Info 1
(C0h) / OEM (70h)
OEM Firmware Info 2
(C0h) / OEM (71h)
IPMI Watchdog Watch dog (23h) /
Sensor-specific
FRU Agent OEM (C5h) / Discrete
(0Ah)
Ass. Mask
/ Deass.
Mask /
Reading
Mask
0003h /
0000h /
7FFFFh
0003h /
0000h /
7FFFFh
010Fh /
0000h /
010Fh
0140h /
0000h /
0147h
DESCRIPTION
For internal use only
For internal use only
Watchdog 2
FRU agent
Causes red
Health LED on error
N
N
Y
N
Page
22
© 2007 Kontron AG ID: 36363, Rev. 1.1
IPMI Firmware User Guide: AM4010
Hot swap sensor N ModuleHotSwap
IPMBL State
Storage Err
Board Reset
Board 3.3V
OEM (F2h) / Sensorspecific
OEM (C3h) / Sensorspecific
Management subsystem health (28h) / Sensorspecific
OEM (C4h) / Sensorspecific
Voltage (02h) / Threshold (
01h)
0007h /
0000h /
0007h
000Fh /
0000h /
000Fh
0002h /
0000h
Board 3.3vIPM
Board 12.0v
Board 1.8V
Board Vtt0.9V
Board 5.0V
Board 1.5V
Temp CPU
Temp MCH
Temp CPU In
Temp AMC Out
Temp AMC In
Temp CPU Out
CPU status
Voltage (02h) / Threshold (
01h)
Voltage (02h) / Threshold (
01h)
Voltage (02h) / Threshold (
01h)
Voltage (02h) / Threshold (
01h)
Voltage (02h) / Threshold (
01h)
Voltage (02h) / Threshold (
01h)
Temperature (01h) /
Threshold (01h)
Temperature (01h) /
Threshold (01h)
Temperature (01h) /
Threshold (01h)
Temperature (01h) /
Threshold (01h)
Temperature (01h) /
Threshold (01h)
Temperature (01h) /
Threshold (01h)
Processor (07h) / Sensorspecific (6Fh)
0280h /
3280h /
1818h
0280h /
3280h /
1818h
0002h /
0002h /
0002h
0280h /
3280h /
1818h
0280h /
3280h /
1818h
0280h /
3280h /
1818h
0280h /
3280h /
1818h
2204h /
2204h /
1212h
2204h /
2204h /
1212h
2204h /
2204h /
1212h
2204h /
2204h /
1212h
04DEh /
0000h
2204h /
2204h /
1212h
2204h /
2204h /
1212h
2204h /
2204h /
1212h
State of IPMB-L bus
Storage error
Board reset event
Board 3.3V supply
AMC Management
Power (MP) 3.3V
AMC Payload Power
(PWR) 12V
Board 1.8V supply
DDR termination supply
Board 5V supply
Board 1.5V supply
CPU die temperature
MCH die temperature
Inlet temperature near CPU
Outlet temperature near AMC connector
Inlet temperature near AMC connector
Outlet temperature near CPU
CPU thermal alarm sensor
N
N
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
Y
N
ID: 36363, Rev. 1.1 © 2007 Kontron AG Page
23
IPMI Firmware User Guide: AM4010
POST Value
FWH0 Boot Err
FWH1 Boot Err
Pwr Good
Pwr Good Evt
Board NMI
SMI Timeout
Lan Front0 Lk
OEM Post Value (C6h) /
OEM (78h)
Boot Error (1Eh) / Sensorspecific
Boot Error (1Eh) / Sensorspecific
Power supply (08h) / OEM
(77h)
Power supply (08h) / OEM
(77h)
Critical interrupt (13h) /
Digital discrete (03h)
Critical interrupt (13h) /
Digital discrete (03h)
LAN (27h) / Sensorspecific
0000h /
18B7h /
18B7h
0002h /
0000h /
0003h
0002h /
0000h /
0003h
0000h /
0000h /
0003h
0000h /
0000h /
00FFh
0008h /
0008h /
0008h
0008h /
0008h /
0008h
0000h /
0000h /
18B7h
Lan Front1 Lk LAN (27h) / Sensorspecific
Lan AMC0 Link LAN (27h) / Sensorspecific
Lan AMC1 Link LAN (27h) / Sensorspecific
Health Error
MMC Reboot
Ver change
Platform Alert (24h) /
Digital discrete (03h)
Platform Alert (24h) /
Digital discrete (03h)
Version change (2Bh) /
Digital discrete (03h)
Proc hot>100C OEM (CFh) / Digital discrete (03h)
0002h /
0000h /
0003h
0002h /
0000h /
0003h
0002h /
0000h /
0003h
0000h /
0000h /
0003h
0000h /
0000h /
0003h
0000h /
0000h /
0003h
0000h /
0000h /
0003h
POST Value (from host I/O port 80h)
Firmware Hub 0 boot error
Firmware Hub 1 boot error
Statuses of all power lines
Power fail events for all power lines
CPU NMI signal
Time out during SMI processing
LAN Front link status or LAN port 8 status
(if supported by the module)
LAN port 9 status (if supported by the module)
LAN port 0 status
LAN port 1 status
Aggregate states
(power, temperatures etc.). Visualization by the Health LED.
MMC reboot active state. Is asserted during boot time.
Version change
Monitors the CPU’s
“Processor Hot“ signal ( > 100 C)
N
Y
N
N
N
N
N
N
N
Y
N
Y
N
N
Y
Page
24
© 2007 Kontron AG ID: 36363, Rev. 1.1
6.3.2 OEM Event / Reading Types
IPMI Firmware User Guide: AM4010
OEM
SENSOR
TYPE (CODE)
Firmware Info 1 (C0h)
Firmware Info 2 (C0h)
Board Reset (C4h)
IPMBL State (C3h)
OEM
EVENT/READING
TYPE (CODE)
70h
71h
6Fh (sensor type specific)
6Fh (sensor type specific)
DESCRIPTION
Internal Diagnostic Data
Internal Diagnostic Data
Sensor-specific
Offset
Event
00h Reserved
01h HwPowerReset
02h PCIReset
03h HwWatchDogReset
04h SoftReset
05h Reserved
06h ColdReset
07h IPMICommand
08h Reserved
09h Reserved
0Ah BMCWatchdog
Sensor discrete State
Meaning
Post Value (C6h) 6Fh (sensor type specific) others
Sensor discrete State
Bits [7:0]
IPMB-L not running
Meaning
Bits [15:8]
Post Value (read from host I/O port
80h)
Reserved
ID: 36363, Rev. 1.1 © 2007 Kontron AG Page
25
IPMI Firmware User Guide: AM4010
i.e. for
Power Good /
Power Good Event
77h Sensor-specific
Offset
Event
3h Reserved
6h Reserved
8h Reserved
Ah Reserved
Hot swap sensor (F2h) 6Fh (sensor type specific)
Sensor-specific
Offset
Event
02h Quiesced
Page
26
© 2007 Kontron AG ID: 36363, Rev. 1.1
IPMI Firmware User Guide: AM4010
6.4.1 Structure and functionality
MMC firmware code is organized into boot code and operational code, both of which are stored in a flash module. Upon an MMC reset, the MMC executes the boot code and performs the following:
1- Self test to verify the status of its hardware and memory.
2- Performs a checksum of the operational code.
3- Communicates with the Firmware Upgrade Manager (FWUM) in order to inform the MC watchdog that the actual MMC firmware is suitable for execution. Upon successful verification of the operational code checksum, the firmware will jump to the operational code.
Operational code is upgradeable in-the-field.
The standard way to upgrade the MMC’s operational code is to use the open tool ‘ipmitool’
[1] together with an image file. Ipmitool allows the downloading (‘ipmitool download …’)
and activation (‘ipmitool upgrade’) of the new operational code and saves an existing one.
The rollback to the formerly running operational code is possible as well (‘ipmitool rollback’)..
All IPMI interfaces which are offered by ipmitool are usable (KCS interface, IPMB bus,
LAN). This allows local upgrade or remote upgrade.
Files which contain an image of operational code have the module type (AM4010) and the string “FWUM” in its name.
During the download process the currently running operational code operates as usual until the upgrade command is issued. During the upgrade process the MMC is off line for about 45 seconds when the boot code is re-organizing the firmware storage and afterwards starts the new operational code. If this doesn’t succeed after a time out the boot code performs an automatic rollback to the last working operational code.
For software that uses the local KCS connection to the MMC, it may be may be more favorable to set up interrupt based KCS communications. This may help to speed up data exchange via KCS considerably. By default, the MMC does not generate interrupts to the local CPU at all. The best way to change this is to use the IPMI menu in BIOS (Advanced ->
IPMI 1.5 Configuration -> KCS-SMS IRQ). Possible options are: IRQ10, IRQ11 or disabled
(default setting).
Another method of interrupt configuration is to do it ‘manually’ executing an ‘OEM Set
Firmware Parameters Command’ (refer to 6.2.2.2, Set Firmware Parameters.
It is strongly recommended to make changes in this area with the help of the BIOS. The BIOS code creates an ‘IPMI Device Information Record (Type 38h)’ entry in the SMBIOS Table.
The information provided there includes: IPMI specification revision (v1.5), type of supported interface (KCS), its base address (CA2h) and interrupt number for it (10, 11 or none), and the IPMB address of the controller (depending on the module slot/bay). Some of this information may be needed by software drivers or applications, for example the Linux
OpenIPMI driver looks for the SMBIOS IPMI entry while detecting system interfaces and it
ID: 36363, Rev. 1.1 © 2007 Kontron AG Page
27
IPMI Firmware User Guide: AM4010
does make usage of the interrupt number provided there. Making changes ‘manually’ leaves
SMBIOS IPMI entry with not-up-to-date values until next reboot.
6.6 Firmware / Module Identification
There are two ways to determine via IPMI that a MMC resides on an AM4010.
1. The response on the IPMI command “Get Device ID” offers among others the the following response data:
• Manufacturer ID = 3A98h (Kontron IANA ID)
• Device ID = 04h (H8S2166)
• Product ID = 4010
• Firmware Revision - depends on running firmware.
2. The Device ID String which can be found by reading the the Management Controller
Device Locator Record (SDR Type 12h) contains the string “AM4010”. For a module being placed in bay B3 the Device ID String will be “B3: AM4010”.
6.7.1 Structure and functionality
The MMC provides 4 kB non-volatile storage space for FRU information. Some of the data stored there, like Module Current Requirements record or E-Keying information (refer to
AMC.0 specification for details), are mandatory for module functionality in the ATCA/AMC
environment. Refer to [2] Platform Management FRU Information Storage Definition
document for details).
Please note that missing FRU information will prevent the AMC module from being accepted by the carrier controller during the Hot Swap process and the module will get no payload power.
Full low level access to read or write a module’s FRU Information is provided by regular
IPMI FRU Device commands. Please be careful when writing FRU information directly using standard IPMI commands. Damaging the FRU Information may lead to a non working payload.
To avoid this danger there exists a Kontron Linux tool ‘frum’ (refer to section 12.2), which allows to display and partially modify FRU data. E.g. the ‘frum’ tool makes it easy to modify
Product Info Area fields (like Product Version or Product Serial Number).
6.7.2 Download
Normally the user needs not download the FRU information because the module is shipped with the data which describes best the module capabilities and requirements. Remember that
FRU information might be damaged by a write access to the IPMI FRU Device using standard IPMI commands.
Page
28
© 2007 Kontron AG ID: 36363, Rev. 1.1
IPMI Firmware User Guide: AM4010
If needed the standard way to download FRU information to the module is to use the open
tool ‘ipmitool’ [1] for the download of an image file. Ipmitool allows the downloading
(‘ipmitool fru write …’). The rollback to the formerly running operational code is possible as well (‘ipmitool rollback’).
All IPMI interfaces which are offered by ipmitool are usable (KCS interface, IPMB bus,
LAN). This allows local upgrade or remote upgrade. Note that the KCS interface is only usable on a powered payload.
6.8 E-Keying
E-Keying has been defined in the AMC.0 R1.0 Specification to prevent module damage, prevent misoperation, and verify bay connection compatibility. The FRU data contains the
AMC point-to-point connectivity record as described in Section 3.9.2 of the AMC.0 R1.0 specification. The Set/Get AMC Port State IPMI commands defined by the AMC.0 specification are used by the carrier for either granting or rejecting the E-keys.
6.9 PCI Express Clock Source
The PCI-E reference clock may be generated locally by the module (default configuration) or acquired via the AMC connector (common/external reference clock). The standard FRU E-
Keying data for the AM4010 contains an AMC Link Descriptor for the PCI-E clock. If an external clock is available the carrier’s IPMC provides it by a “Set AMC Port State” command. The appropriate control signal is latched by the on-board FPGA during payload power on and cannot be changed until payload power off.
The common reference clock provided by the carrier may be slightly modulated (Spread
Spectrum Clock - SSC). Standard FRU E-Keying data for AM4010 contains two AMC Link
Descriptors for the PCI-E channel, describing how the module works with non-SSC or with
SSC. The carrier’s IPMC makes this selection during E-keying by “Set AMC Port State” commands“. The clock selection will be latched by the on-board FPGA during payload power on and can’t be changed until payload power off.
6.10 BIOS Supervisory and Automated Firmware Hub Switch
After each payload reset, the MMC expects a special message from the BIOS i.e. the BIOS checksum report. If the checksum (computed by the BIOS boot block) is incorrect or the message itself is not available within 15 seconds after payload reset, then the currently used firmware hub is assumed to contain an invalid or a corrupted BIOS image. In this case an automatic switch to another firmware hub is done and another reset is initiated and the “Boot
Error (Invalid boot sector) event” for the failing firmware hub is generated. Refer to 6.3.1,
sensors ‘FWHx Boot Err’. x = 0..1
.
6.11 Hot Swap
As a hot-swappable field replaceable unit (FRU), the AM4010 also follows the same stringent carrier grade RASM feature set, namely - Reliability, Availability, Serviceability,
Maintainability. When offered in combination with AdvancedTCA platforms, TEM (Telecom
Equipment Manufacturers) clients literally conserve valuable system AdvancedTCA system slots. The AM010 supports Full Hot Swap capability as per PICMG 3.0. It can be removed from or installed in the system while it is on (without powering-down the system). Please refer to the PICMG 3.0 specification for additional details.
ID: 36363, Rev. 1.1 © 2007 Kontron AG Page
29
IPMI Firmware User Guide: AM4010
During Hot Swap of a working module the payload side has to be shut down automatically on command of the MMC and the end of shut down has to be signalled back to the MMC.
Because the AM4010 supports ACPI, an OS on payload side which supports this too makes shut down very easy. If the OS doesn’t support ACPI there is a special method to be used.
Method 1. The payload OS supports ACPI
Requirements:
• ACPI support must be enabled in the BIOS menu.
• The ACPI daemon must be active.
• An ACPI power button event must result in a sleep state.
Part of the Hot Swap 0peration sequence to be processed by MMC and OS:
• On command of the carrier controller the MMC simulates the pressing and release of the “power button” to force an ACPI event.
• The ACPI daemon detects this ACPI event and initiates the shut down of the payload software system.
• At the end of shut down the payload hardware system reports the sleep state to the
MMC by setting the appropriate signal line.
• The MMC detects the sleep state and reports this to the carrier controller so that the
Hot Swap processing can be continued and finished.
By default the MMC waits endless for the sleep state. If an endless wait shall be avoided in each case it is possible to set a timeout time after which the system will be switched off
unconditionally. For the setting of the timeout refer to 6.2.2.5, OEM Module Quiescence
Method 2. The payload OS does not support ACPI
Requirements:
• At system start on payload side the Kontron shutdown daemon ‘grnsd’ has to be started. It is included in the Linux board support packages for the AM4010 (refer to
[
3 ]). This daemon communicates cyclically with the MMC for the exchange of states,
commands and acknowledges. For this it uses the “ OEM Module Quiescence
Feedback ” command. Refer to 6.2.2.5. In principle it plays the same role as the ACPI
daemon of method 1, above.
Part of the Hot Swap 0peration sequence to be processed by MMC and OS:
• On command of the carrier controller the MMC sets a “shut down request” flag.
• The grnsd daemon recognizes this request in the response to its cyclical “
Module Quiescence Feedback ” command and initiates the shut down of the payload
software system.
• At the end of the shut down process the grnsd daemon informs the MMC by setting the appropriate flag when calling the “
OEM Module Quiescence Feedback ” command.
• The MMC reports this to the carrier controller so that the Hot Swap processing can be continued and finished.
By default the MMC waits endless for this information. If an endless wait shall be avoided in each case it is possible to set a timeout time after which the system will be switched off
unconditionally. For the setting of the timeout refer to 6.2.2.5, OEM Module Quiescence
Page
30
© 2007 Kontron AG ID: 36363, Rev. 1.1
IPMI Firmware User Guide: AM4010
6.12 LAN functions
6.12.1 Overview
The two Ethernet channels which reside on port 0 (channel 0) and port 1 (channel 1) at the
AMC Fabric Interface can – in parallel to their ‘normal’ use - be used for the following special purposes:
• IPMI over LAN (IOL)
• Serial over LAN
Common for both kinds of communication is the use of the RMCP/RMCP+ for the packing of the data to be transferred. On Ethernet the port 623 is used for transfers with this protocol.
While IOL serves to transport IPMI commands and their responses the SOL serves to transport any serial data. In each case the MMC serves as a protocol encoder and decoder.
Please note that IOL is able to use both RMCP and RMCP+ protocols. SOL works only with the RMCP+ protocol.
6.12.2 Setting up the Ethernet channel
There are two methods to prepare the MMC’s SOL and IOL LAN parameters for the two possible Ethernet channels:
• During the BIOS setup
• 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 both channels. When the MAC addresses are set the ones which are programmed into the hardware have to be re-used. This is a restriction. The IP addresses being used by ‘normal’ payload use and IOL/SOL use may differ but need not differ as long as the RMCP port 623 is not used in parallel.
6.12.2.1 Setup by BIOS menu
The BIOS setup menu “Advanced>IPMI 1.5 Configuration>Set LAN Configuration” offers the setting of some LAN parameters for both channels (1, 2). After this setup IOL is not yet
ready for use. Refer to 6.12.2.2, Setup by ipmitool or IPMI commands.
6.12.2.2 Setup by ipmitool or IPMI commands
The open tool ipmitool offers commands for the setup of the two Ethernet channels. All possible options are showed by issuing
If ipmitool is not usable the LAN parameters can be set by using the generic IPMI commands which are defined for this.
To enable the LAN support after parameter setup this command has to be issued: ipmitool lan set access on
6.12.3 Setup of user and password
The open tool ipmitool offers commands for the listing and manipulation of user accounts for channel 1 and 2. An overview can be obtained by putting in
ID: 36363, Rev. 1.1 © 2007 Kontron AG Page
31
IPMI Firmware User Guide: AM4010
Ipmitool user
The predefined users for a channel can be listed by the command
The AM4010 has for every channel 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 admin’s password is preset with ‘kontron’.
Changed users and passwords stay valid after payload power off.
6.12.4 IPMI over LAN (IOL)
IPMI over LAN is used for to communicate with an IPMI controller as e.g. the AM4010’s
MMC via LAN using the RMCP or RMCP+ protocol. The data which is transferred are IPMI commands and the responses to them.
The open tool ‘ipmitool’ can serve as a control program and user interface for this. ipmitool allows to issue generic IPMI commands as e.g.:
ipmitool -I lanplus -H 192.168.3.189 -U admin -P admin raw 6 1 or to call complex functions like ‘mc .info’:
ipmitool -I lanplus -H 192.168.3.189 -U admin -P admin mc info
This uses many generic IPMI commands to get all needed information.
6.12.5 Serial over LAN (SOL)
Serial over LAN connects the COM1 or /dev/ttyS0 respectively of the AM4010’s payload side to an Ethernet channel. The MMC 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 AM4010 e.g. the open tool ipmitool can be used to drive the SOL session i.e. it offers a console function to communicate via Ethernet with the
AM4010’s serial interface.
The serial interface can be used as a connection to
1) a user program on the AM4010 payload
2) the BIOS console redirection function. Refer to the BIOS setup menu
“Advanced>Console Redirection”. There the serial parameters for this purpose can be set. Please note that after BIOS start, the OS gets active in most cases (except e.g.
DOS) and the console redirection stops working because the OS doesn’t use BIOS functions to drive the console.
3) a Linux login console. This can be activated after payload start e.g. by the command
getty –h 115200 /dev/ttyS0
4) etc.
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 parameters for the used payload side serial interface and the MMC’s serial interface have to be used. The parameters for the MMC’s serial interface can be set by the “ipmitool sol set …” command.
Calling “ipmitool sol set” shows all options that can be set.
Other commands which are possible are showed when issuing “ipmitool sol help”.
Page
32
© 2007 Kontron AG ID: 36363, Rev. 1.1
IPMI Firmware User Guide: AM4010
6.13 OS Support / Tools
6.13.1 DOS
There is a low-level DOS command line tool provided by Intel that allows hex-formatted
IPMI commands to be sent to the management controller via KCS interface. The IPMI
Command Test Tool can be found at: http://www.intel.com/design/servers/ipmi/tools.htm
6.13.2 Linux
Normally all drivers and kernel modules needed for communication between the payload sided software and the MMC 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. One of the applications is ‘ipmicmd’ which makes it possible to send and receive raw IPMI sequences; another, the ‘ipmi_ui’, provides a higher level interface and thus it does not require deep IPMI knowledge from the user side.
Another very useful all-in-one tool is the ipmitool ( http://ipmitool.sourceforge.net
). It provides a user friendly interface to many IPMI features and extensions, for example to
PICMG LED control and Kontron FWUM.
There is a Kontron Modular Computers’ IPMI ToolKit which contains some tools for the customer for the monitoring and the maintenance of some IPMI functionalities.
The following command line tools are included in the IPMI ToolKit:
• frum: display and modification of FRU data
• temptool: selection, display, and storage of temperature and voltage sensor values
All these tools are OpenIPMI based. This toolkit is available on the “AMC Kit CD”. If this
CD was not shipped with your module then please contact our support ( [email protected]
).
Please refer to the manual "MAN_LIN_IPMI_TOOLKIT_0103.pdf" being included in the package.
6.13.3 Windows
Intel provides KCS reference drivers for Windows and the IPMI Conformance Test Suite
(ICTS), they are available at the following address: http://www.intel.com/design/servers/ipmi/tools.htm
ID: 36363, Rev. 1.1 © 2007 Kontron AG Page
33
IPMI Firmware User Guide: AM4010
7. IPMI Communication LEDs
There are three IPMI communication LEDs on the face plate.
LED 0
Color: Blue
Position: Bottom right
Labeled: ./.
Meaning: Indicates the Hot Swap state of the inserted and powered module.
Meaning: On: Module may be extracted.
Blinking: Hot Swap active, don’t extract
Off: Module in normal operation. Don’t extract.
Index in “Get/Set LED State” commands: 0
LED 1
Color: Red
Position: Top left
Labeled: by a crossed out plus sign
Meaning: Indicates the “Out Of Service” state of the powered module.
Behavior: Solid red = module out of service
Off = module powered/running
Pulsing red = Traffic on the IPMB-L bus
Index in “Get/Set LED State” commands: 1
LED 2
Color: Green / red
Position: Top right
Labeled: by a plus sign Meaning: Indicates the “Health” state of a running/powered module.
Behavior: Blinking slow: Module MMC is running, showing its heart beat.
Pulsing: The KCS interface is active.
Solid: Module MMC not running or firmware is a non heart
beat version (version dependent, standard is heart beat).
Off: Module MMC not running.
Is green: No health error detected (refer to sensor “
Health Error
“,
Is red: Health error detected.
Index in “Get/Set LED State” commands: 2
Page
34
© 2007 Kontron AG ID: 36363, Rev. 1.1
advertisement
* Your assessment is very important for improving the workof artificial intelligence, which forms the content of this project
advertisement