n.a.t.-emch technical reference manual · nat will not be responsible for any direct or indirect...

32
N.A.T.-EMCH – Technical Reference Manual NAT-eMCH Technical Reference Manual V1.2 HW Revision 1.0 (151001)

Upload: others

Post on 29-Sep-2020

5 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

NAT-eMCH

Technical Reference Manual V1.2

HW Revision 1.0 (151001)

Page 2: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

Version 1.2 © N.A.T. GmbH 2

The NAT-eMCH has been designed by:

NAT GmbH

Konrad-Zuse-Platz 9

D-53227 Bonn

Phone: +49 / 228 / 965 864 - 0

Fax: +49 / 228 / 965 964 - 10

Internet: http://www.nateurope.com

Page 3: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

Version 1.2 © N.A.T. GmbH 3

Disclaimer

The following documentation, compiled by NAT GmbH (henceforth called NAT), repre-

sents the current status of the product´s development. The documentation is updated on

a regular basis. Any changes which might ensue, including those necessitated by updated

specifications, are considered in the latest version of this documentation. NAT is under no

obligation to notify any person, organization, or institution of such changes or to make

these changes public in any other way.

We must caution you, that this publication could include technical inaccuracies or

typographical errors.

NAT offers no warranty, either expressed or implied, for the contents of this

documentation or for the product described therein, including but not limited to the

warranties of merchantability or the fitness of the product for any specific purpose.

In no event will NAT be liable for any loss of data or for errors in data utilization or

processing resulting from the use of this product or the documentation. In particular,

NAT will not be responsible for any direct or indirect damages (including lost profits, lost

savings, delays or interruptions in the flow of business activities, including but not limited

to, special, incidental, consequential, or other similar damages) arising out of the use of

or inability to use this product or the associated documentation, even if NAT or any

authorized NAT representative has been advised of the possibility of such damages.

The use of registered names, trademarks, etc. in this publication does not imply, even in

the absence of a specific statement, that such names are exempt from the relevant

protective laws and regulations (patent laws, trade mark laws, etc.) and therefore free

for general use. In no case does NAT guarantee that the information given in this

documentation is free of such third-party rights.

Neither this documentation nor any part thereof may be copied, translated, or reduced to

any electronic medium or machine form without the prior written consent from NAT

GmbH.

This product (and the associated documentation) is governed by the NAT General

Conditions and Terms of Delivery and Payment.

Note:

The release of the Hardware Manual is related to a certain HW board revision given in

the document title. For HW revisions earlier than the one given in the document title please contact N.A.T. for the corresponding older Hardware Manual release.

Page 4: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

Version 1.2 © N.A.T. GmbH 4

Table of Contents

TABLE OF CONTENTS .......................................................................................... 4

LIST OF TABLES .................................................................................................. 6

LIST OF FIGURES ................................................................................................ 6

CONVENTIONS .................................................................................................... 7

1 INTRODUCTION ........................................................................................... 8

2 OVERVIEW ................................................................................................... 9

2.1 BOARD SPECIFICATION .................................................................................. 9 2.1.1 CPU and Memory ............................................................................... 9 2.1.2 IPMI and Management ....................................................................... 9 2.1.3 Supported Fabrics and Compliance .....................................................10 2.1.4 LEDs ...............................................................................................10

2.2 BLOCK DIAGRAM OF NAT-EMCH .....................................................................13 2.3 CARRIER CHASSIS INCLUDING NAT-EMCH .........................................................11 2.4 FRONT PANEL AND LEDS ...............................................................................13 2.5 LOCATION DIAGRAM ....................................................................................15 2.6 BACKPLANE CONNECTOR ...............................................................................16

3 OPERATION ............................................................................................... 17

3.1 SYSTEM STARTUP AND REDUNDANCY OPERATION...................................................17 3.2 AMC MODULE STARTUP SEQUENCING ................................................................17 3.3 LOCAL SHELF MANAGER ................................................................................18

3.3.1 System Event Log .............................................................................18 3.3.2 Temperature Management .................................................................18

4 COMMAND LINE INTERFACE ....................................................................... 19

4.1 COM-SETTINGS .........................................................................................19 4.2 SUPPORTED COMMANDS ................................................................................19 4.3 BOOT-MANAGER .........................................................................................21

5 UPDATING THE FIRMWARE ........................................................................ 21

6 MANAGEMENT INTERFACE ......................................................................... 23

6.1 SOFTWARE STRUCTURE .................................................................................23 6.2 COMMUNICATION BETWEEN HOST SYSTEM AND EMCH .............................................24

6.2.1 Remote management control protocol .................................................24 6.2.2 Supported IPMI messages .................................................................25

6.3 HOST SOFTWARE OVERVIEW ...........................................................................25 6.3.1 Ipmitool ..........................................................................................25 6.3.2 NAT JAVA GUI application ‘NATView’ ...................................................26

6.3.2.1 Supported Java Releases ........................................................................... 26 6.3.2.2 Getting NATView ...................................................................................... 27 6.3.2.3 Installing and running NATView .................................................................. 27 6.3.2.4 Further information .................................................................................. 27

7 KNOWN BUGS / RESTRICTIONS ................................................................. 28

Page 5: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

Version 1.2 © N.A.T. GmbH 5

APPENDIX A: UPDATING THE BOOTLOADER ..................................................... 29

APPENDIX B: UPDATING THE BACKPLANE EEPROM .......................................... 29

APPENDIX C: COOLING CONCEPT OF SHELF-MANGER ....................................... 30

APPENDIX D: DOCUMENT’S HISTORY ............................................................... 32

APPENDIX E: REFERENCE DOCUMENTATION .................................................... 32

Page 6: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

Version 1.2 © N.A.T. GmbH 6

List of Tables Table 1: List of used abbreviations .......................................................................... 7 Table 2: Board specification .................................................................................... 9 Table 3: Description of front plate ..........................................................................15 Table 4: Backplane connector pin assignment ..........................................................16 Table 5: COM port settings ....................................................................................19 Table 6: List of CLI commands ...............................................................................21 Table 7: Standard interface config ..........................................................................21

List of Figures Figure 2: NAT-eMCH circuit board ............................................................................ 8 Figure 3: NAT-eMCH block diagram.........................................................................13 Figure 4: Carrier chassis ........................................................................................11 Figure 5: Backplane connections ............................................................................12 Figure 6: Front plate drawing .................................................................................14 Figure 7: Location diagram ....................................................................................15 Figure 8: Login Page .............................................................................................22 Figure 9: Upload page ...........................................................................................22 Figure 10: Upload done page .................................................................................22 Figure 11: Error page ............................................................................................22 Figure 12: Software structure overview ...................................................................23 Figure 13: Software structure details ......................................................................24

Page 7: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

Version 1.2 © N.A.T. GmbH 7

Conventions

If not otherwise specified, addresses and memory maps are written in hexadecimal

notation, identified by 0x. The following gives a list of the abbreviations used in this

document:

Abbreviation Description

AMC Advanced Mezzanine Card

MicroTCA Micro Telecommunication Computing Architecture

MCU Microcontroller Unit

MCH MicroTCA Carrier Hub

eMCH Embedded MCH

GbE Gigabit Ethernet

CLI Command Line Interface

FRU Field Replaceable Unit

MII Medium Independent Interface

MPU Memory Protection Unit

GMAC Ethernet Medium Access Controller

UART Universal Asynchronous Receiver Transmitter

TWI Two Wire Interface

SWD Serial Wire Debug

Table 1: List of used abbreviations

Page 8: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

Version 1.2 © N.A.T. GmbH 8

1 Introduction

The NAT-eMCH (Embedded MicroTCA Carrier Hub) is intended to provide basic MicroTCA

functionality for switching and managing two AMC (Advanced Mezzanine Card) modules

carried by the two slot chassis “Native-Mini”. It delivers switching and hub functionality

for the system fabric gigabit ethernet (GbE) as defined in the AMC.0 standard series.

Furthermore it supports the typical hot swap management and its transition state

machine (M0 to M6) for each AMC module. In addition to that, the embedded MCH

monitors and verifies local sensor data of the chassis and installed FRU devices and

supplies MicroTCA power and cooling concepts by accessing the chassis integrated power

supply and fan coolers. Remote administration can be done locally over the CLI

(Command Line Interface) served by the front USB port. Figure 1 shows a photo of the

NAT-eMCH PCB.

Figure 1: NAT-eMCH circuit board

Page 9: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

Version 1.2 © N.A.T. GmbH 9

2 Overview

2.1 Board Specification

Processor Atmel ATSAM4E16C: Cortex-M4 running at 120 MHz

Front-I/O 1 RJ45 connector, 1 Micro-USB connector

Main Memory 128 kByte embedded SRAM

Flash PROM 1024 kByte embedded FLASH ROM

Operating System FreeRTOS 7.3.0

Power consumption Max. 1 Watt

Environmental

conditions

Temperature (operating):

Temperature (storage):

Humidity:

0°C to +65°C with forced cooling

-40°C to +85°C

10 % to 90 % rh non-condensing

Standards

compliance

PICMG AMC.0 Rev. 2.0

PICMG AMC.2 Rev. 1.0

IPMI Specification V1.5 Rev. 1.0

PICMG µTCA.0 Rev. 1.0

Table 2: Board specification

2.1.1 CPU and Memory

ATSAM4E16C, Cortex-M4 running at 120 MHz

128 kByte embedded SRAM

1024 kByte embedded FLASH

2.1.2 IPMI and Management

The eMCH supports Management and IPMI Interfaces for:

AMCs

1 cooling unit

1 power module

Page 10: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

Version 1.2 © N.A.T. GmbH 10

2.1.3 Supported Fabrics and Compliance

Fabric A: Gigabit Ethernet Option

non-blocking, low-latency Layer 2 Gigabit Ethernet switch

Support for 2 AMCs and 1 GbE Uplink Port

PICMG AMC.2 R1.0

2.1.4 LEDs

2 LEDs (Green) for status indication of each of the 2 AMC modules

2 LEDs (Green/Red) for status indication of eMCH module

Page 11: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

Version 1.2 © N.A.T. GmbH 11

2.2 Carrier Chassis including NAT-eMCH

The eMCH is located in a two slot chassis manufactured by Pentair-Schroff. Figure 2

shows the chassis without cover to see its inner life. The chassis has an integrated open

frame power supply for serving the necessarily overall power and fan units for cooling the

system. All units are completely managed by the NAT-eMCH. As this manual is intended

to be focused on the NAT-eMCH, only the relevant information of the chassis is appointed

within this document. For further detailed information please contact Pentair

http://www.pentairprotect.de/

Figure 2: Carrier chassis

Page 12: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

Version 1.2 © N.A.T. GmbH 12

Figure 3 shows the inner port assignment of the backplane and the way how the NAT-

eMCH is connected to it. To each of the AMC-Modules, the eMCH has radial connection

including 1000Base-BX Ethernet (Port 0 and 1), I2C-IPMB for management based on

IPMI messages and enable / power switch signals for serving MTCA hot swap capabilities.

Ports 2-11 of the AMC modules are directly crossover connected without having a

conjunction to the eMCH. Fabric and telecom clocks are connected the same way.

Powers for payload (12 V) and management (3.3V) for each installed AMC are circuit

switched by a hot swap controller that remains on the backplane and which is available

over a further i2c-bus to the eMCH. A current sensor and the backplane FRU-EEPROM is

also connected to that bus.

DC/DC Converter

10

3.3V

Current Sense

INT_HS

PPWRPPWR_1

PPWR_2

MPMP_1

MP_2

EN_HS

FRU-Data

FAN 1,2,3,4,5

I²C

5

eMCH AMC#1 AMC#2

FAN_CTL

FAN_RPM

A A

BB

C C

DD

AMC Clocks – FCKLA

AMC Clocks – TCLKA

AMC Clocks – TCLKB

AMC Clocks – TCLKC

Fabric 1/A (1000Base-BX)

AMC-Ports 2-11

IPMB_L

AMC Clocks – TCLKD

Backplane

Ho

t Sw

ap

12V

EN#EN#

PS1#PS1#

Fabric 2/A (1000Base-BX)

Figure 3: Backplane connections

Page 13: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

Version 1.2 © N.A.T. GmbH 13

2.3 Block Diagram of NAT-eMCH

The following figure shows a block diagram of the NAT-eMCH.

Microcontroller

10

00

Bas

e-B

X

MII

10

00

Bas

e-B

X

1000Base-T (Uplink)

IPM

B-L

#2

IPM

B-L

#1

Gigabit-Ethernet-

Switch

Status-LEDs

FAN

Sig

na

ls

PS1

#[0

,1]

EN# [

0,1

]

Hot-Swap-Controller

Current Sensor

I2C

I²C

Backplane

USB-SerialPort

HSC

_CTL

AMC#2

10

00

Ba

se-B

X

IPM

B-L

EN#

/ P

S#

AMC#1

10

00

Ba

se-B

X

IPM

B-L

EN#

/ P

S#

Power Supply

FANs

FAN

Sig

na

ls

3.3

V /

12

V

eMCH

FRUEEPROM

Figure 4: NAT-eMCH block diagram

Page 14: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

Version 1.2 © N.A.T. GmbH 14

2.4 Front Panel and LEDs

The NAT-eMCH front plate (see Figure below) consists of two status LEDs for the AMCs,

and each one LED (OK, FAIL) for the system’s operation status. In addition to the LEDs,

you can find sockets for a RJ45 plug and a micro USB cable.

Figure 5: Front plate drawing

Page 15: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

Version 1.2 © N.A.T. GmbH 15

A more detailed overview of the front plate functions is explained in Table 3 below.

Type Function

LED AMC1 Blink Short: Reading FRU information (M1)

Blink Slow: Waiting for HS-Handle being closed (M1)

ON: FRU operating state (M4)

OFF: No Module installed

LED AMC2 Blink Short: Reading FRU information (M1)

Blink Slow: Waiting for HS-Handle being closed (M1)

ON: FRU operating state (M4)

OFF: No Module installed

LED OK Blink Slow: -

Blink Short: Test Mode

ON: Normal operating status. No error

OFF:-

LED FAIL Blink Slow: -

Blink Short: -

ON: Hard fault

OFF: -

Micro USB Type A Used for virtual COM-Port. Direct connection to PC

RJ45 Gigabit-Ethernet 1000Base-T Uplink for remote control

Table 3: Description of front plate

- Note: When executing the bootloader, all LEDs will be put on.

2.5 Location Diagram

The position of important components is shown in the following location overview (Figure

6). Depending on the board type it may be that the board does not include all

components named in the location diagram.

Ethernet-Switch (GbE)

MCU

V-Reg

IPMBBuffer

SWD RJ45

IPMBBuffer

Mic

roU

SB

Temp Sensor

FTDI ChipClock

BufferV-Reg

Figure 6: Location diagram

Page 16: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

Version 1.2 © N.A.T. GmbH 16

2.6 Backplane Connector

The mapping of the backplane edge connector is shown at Table 4.

Bottom Top

Pin # Signal Signal Pin # 1 +12V +12V 2

3 +12V +12V 4

5 +12V +12V 6

7 GND GND 8

9 GND GND 10

11 +3.3V +3.3V 12

13 +3.3V +3.3V 14

15 +3.3V +3.3V 16

17 GND GND 18

19 VTEMP1 GND 20

21 VTEMP2 GND 22

23 PS1_AMC1# GND 24

25 PS1_AMC2# EN_AMC1# 26

27 PS1_AMC3# EN_AMC2# 28

29 PS1_AMC4# EN_AMC3# 30

31 GND EN_AMC4# 32

33 TxFA-1+ GND 34

35 TxFA-1- PWM_FAN_CTL 36

37 GND PWM_FAN1 38

39 RxFA-1+ PWM_FAN2 40

41 RxFA-1- PWM_FAN3 42

43 GND PWM_FAN4 44

45 RxFA-2- PWM_FAN5 46

47 RxFA-2+ GND 48

49 GND I2C_SCL 50

51 TxFA-2+ I2C_SDA 52

53 TxFA-2- HSC1_EN 54

55 GND HSC2_EN 56

57 TxFA-3+ HSC1_INT# 58

59 TxFA-3- HSC2_INT# 60

61 GND GND 62

63 RxFA-3+ IPMB_SCL_AMC1 64

65 RxFA-3- IPMB_SDA_AMC1 66

67 GND IPMB_SCL_AMC2 68

69 RxFA-4- IPMB_SDA_AMC2 70

71 RxFA-4+ IPMB_SCL_AMC3 72

73 GND IPMB_SDA_AMC3 74

75 TxFA-4- IPMB_SCL_AMC4 76

77 TxFA-4+ IPMB_SDA_AMC4 78

79 GND GND 80

Table 4: Backplane connector pin assignment

Page 17: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

Version 1.2 © N.A.T. GmbH 17

3 Operation

3.1 System Startup and Redundancy Operation

After power-up the NAT-eMCH tries to read the backplane FRU information and locates

the available power module and cooling unit. After that, it starts scanning for installed

AMC modules.

3.2 AMC Module Startup Sequencing

After the NAT-eMCH has completed its initial startup sequence it scans the system for

available AMC modules. For any slot which is populated by an AMC module, a green LED

on the face plate is lit. For all AMC modules found in the system, the eMCH reads in the

FRU information and sensor data records. If power negotiation is successful, it directs the

power module to power up the AMC modules either in the activation sequence defined in

the “Carrier Activation and Current descriptor“ record of the backplane FRU device or - if

the record is not found - according to the site number.

Page 18: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

Version 1.2 © N.A.T. GmbH 18

3.3 Local Shelf Manager

The local Shelf manager of the NAT-eMCH provides management of the following

resources within an uTCA system:

Sensor Event Log (SEL)

Temperature management and Cooling Unit control

3.3.1 System Event Log

The eMCH provides a System Event Log (SEL) that stores all events that occur in an

uTCA system. The stored events are kept in the eMCH’s SRAM and are not stored into

persistent memory.

Events can be read by an application using the IPMI message GET_SEL_ENTRY_REQ.

Events are removed from the SEL on read. To remove single events from the SEL in this

configuration IPMI message DELETE_SEL_ENTRY_REQ has to be sent to the eMCH, to clear

the whole SEL IPMI message CLEAR_SEL_REQ has to be sent to the eMCH.

Please note that some events (e.g. temperature events) are handled by the local shelf

manager.

3.3.2 Temperature Management

The local shelf manager receives temperature events from the following sources

Local temperature sensors on the eMCH

Temperature sensors on the AMC modules

Temperature sensors on Cooling Units and Power Modules

In case the eMCH receives a temperature event (temperature going high event) from a

FRU, i.e. the temperature of a certain module has reached a critical level, it increases the

fan speed of the cooling units to the maximum level and starts monitoring the

temperature sensors of the respective FRU. As soon as the temperature returns to

normal level the fan speed will be decreased to a level which is 10% higher than the level

it was when the temperature event occurs. In case of being the temperature stable for a

long time, it will decrease the fan speed step by step.

Page 19: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

Version 1.2 © N.A.T. GmbH 19

4 Command Line Interface

4.1 COM-Settings

The NAT-eMCH has a command line interface which allows users to initially set up

configuration parameters as well as supplying low level diagnostic information. The

command line interface is available at the console port and telnet.

To establish a local connection to a host PC over USB, first download a serial terminal

program e.g. Terra-Term, HTerm, Putty, e.g. Then configure the COM port settings as

followed by Table 5:

Baudrate 115200

Data 8 bit

Parity None

Stop 1 bit

Flow control None

COM The devices COM address defined by host

pc

Table 5: COM port settings

If the terminal is opened, press enter to see if the connection is established successfully.

You can now type “help” to see the list of available commands. Press enter to call the

previous command again.

NOTE: Depending on your operating system, you need to download and install

the FTDI-chip driver manually. Drivers can be downloaded at

http://www.ftdichip.com/FTDrivers.htm. Installing the driver automatically by

the windows update may take up to a few minutes.

4.2 Supported commands

The commands supported by the command line interface may vary with the firmware

version. For an actual list of available commands enter “?” at the command line prompt.

Please note that some commands are intentionally not listed in the table because they

are used for testing purpose only.

Page 20: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

Version 1.2 © N.A.T. GmbH 20

The command line interface supports the following commands:

Command Parameter Description

bi Board Information

Prints the vital product information record (i.e. Serial

number, Hardware revision and release codes).

ip IP configuration

Configures IP addresses, net mask, broadcast

address and gateway.

password Password Configuration

Allows changing the password which is verified

before starting a telnet session or accessing the

webserver. A password length of not less than 8 to

maximum 16 characters is required.

The default password is set to “nat”.

reboot Reboot the eMCH

cmu_dbg Configure CM upper part debug

csif_dbg Configure CM/ShM interface debug

imsg_dbg Configure IPMI message debug

lshm_dbg Configure local ShM debug

rmcp_dbg Configure RMCP interface debug

sdrrep_dbg Configure SDR repository debug

sel_dbg Configure System Event Log debug

imsg_info IPMI message information

Prints the implementation status of the supported

IPMI messages on the Host (RMCP) interface and can

be used to print a list of IPMI messages that are

supported by the eMCH.

lshm_info Print local ShM information

idb_info Print IPMI data base information

sdrrep_info SDR repository information

Prints an overview of the Sensor Data Repository of

the eMCH.

sel_info System Event Log information

Prints the Sensor Event Log status and stored events

in raw and decoded format.

session_info Session information

Print status of currently active sessions.

show_ekey Show all activated connections

show_fru Show all FRUs

show_fruinfo

fru_id FRU contents

Shows the contents of a FRU device selected by

<fru_id>. For valid FRU numbers please refer to

MTCA R1.0 table 3-3.

show_pwrconf Power Configuration

Displays the power channel assignment by the

backplane FRU device

show_cu Show cooling unit

show_pm Power Module Status

Shows the actual power allocation status for all AMC

modules and Cooling Units.

Page 21: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

Version 1.2 © N.A.T. GmbH 21

show_sensorinfo fru_id Shows the sensor values of the selected FRU

version Print firmware version information

ni Print network configuration

ti Print task runtime information and memory

usage

ping IP address Issue ICMP echo request

This command supports several command line

options. For more information on the command’s

usage type ‘ping -?’

diag Menu driven diagnostic tool

This menu shall be used on NAT’s explicit

advice only!

fan_ctl FAN control

Command to get fan properties and speed level and

to set the fan speed level.

shutdown <fru_id/all> Graceful shutdown of FRU or all AMCs

fru_start <fru_id> Graceful start for FRU

Table 6: List of CLI commands

4.3 Boot-Manager

The device contains a boot manager that normally executes either the firmware or the

bootloader. By pressing “x” to CLI at the boot process within half a second, the boot

menu of the boot manager will be called. Use this menu only with NAT’s explicit

advice. In this menu, the user is able to choose the boot option (firmware, bootloader)

manually. Furthermore the user is able to restore the default configuration (e.g. IP

settings, web password and so on) or to delete the device S/N and HW-Revision

(CAUTION, read below).

Caution: The devices IEEE address (MAC) is based on the eMCH serial number. The user

will have to replace the serial number, otherwise the device will not boot.

5 Updating the Firmware

The eMCH serves a web based front end to easily upgrade the devices firmware in field.

To use this utility, first establish an ethernet link over the eMCH uplink port. If not

changed, the standard interface config is as followed by Table 7:

IP address: 192.168.1.138

Netmask: 255.255.255.0

Gateway: 0.0.0.0

Table 7: Standard interface config

For the firmware upgrade, you will have to call the devices bootloader first. To do so, you

have to type http://192.168.1.138/ in your web browser. Your browser should show the

index page with a button “call bootloader”. By clicking on this button, a software reset

will be triggered and the system will boot into the bootloader. Wait a few seconds and

call http://192.168.1.138/ again. The page should have changed slightly and will prompt

you to enter a password (Figure 7). By default, the password is “nat”. By clicking on

Page 22: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

Version 1.2 © N.A.T. GmbH 22

“submint” the following page should open (see Figure 8). To leave the bootloader without

touching anything, just click on “Leave Bootloader”. Alternatively you can call the

bootloader by typing “bl” to the command line interface.

Figure 7: Login Page

Figure 8: Upload page

Now select a proper N.A.T firmware image with the file extension “.srec”. Click upload to

flash the image into the device memory.

NOTE: The upload process will take a few seconds, please don’t interrupt or

close the browser while upgrading.

If succeed, the following page (Figure 9) is shown. Click on “Reset MCU” to trigger a

software reset. The device should now boot into the new firmware.

Figure 9: Upload done page

NOTE: If something went wrong during the firmware upgrade (e.g. lost of

power or communication during file transfer), the device will boot into the

bootloader again instead of loading the firmware. In this case you can easily

repeat the firmware upgrade. The following page (see Figure 10) is shown on

an error.

Figure 10: Error page

Page 23: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

6 Management Interface

For interfacing to an system controller the NAT-eMCH is equipped with an Ethernet based

management port. The management port resides on the front panel 1000 BaseT port. An

external system controller can communicate with the eMCH by the exchange of IPMI

messages. The IPMI messages are encapsulated in RMCP packets for transport via

Ethernet. By this standard interface the user has access to a broad range of open source

and commercial tools to access and manage the eMCH.

The NAT graphical system management JAVA application “NAT NatView” utilizes this

interface as well.

6.1 Software structure

The following figure gives a basic overview about software structure on the eMCH.

Figure 11: Software structure overview

The System management software (SMS) is running on a host system that

communicates via the Remote management control protocol (RMCP) via Ethernet with

the eMCH. The eMCH itself implements base management controller (BMC) functionality

and communicates via IPMI messages via I2C with hardware modules (e.g. Cooling Units,

Power Modules, AMC cards) that run hardware module specific software.

The next figure gives an example for a software implementation that uses a graphical

JAVA application running on the host system:

Page 24: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

Version 1.2 © N.A.T. GmbH 24

Figure 12: Software structure details

The system management software is described more detailed in the following chapters.

The software on the eMCH can be divided up into two parts: first a layer structured stack

that implements the interfaces to external systems (host and hardware) and the

message handling, and second helper modules to save data (IPMI data base, FRU

inventory, SDR repository, SEL) and communication information (session management).

Note that the SEL on the eMCH is kept in memory but not stored into persistent memory.

6.2 Communication between host system and eMCH

Communication between a host system and the eMCH is done via IPMI messages. To

allow a flexible and common available transport of these IPMI messages the eMCH offers

an Ethernet based management interface.

6.2.1 Remote management control protocol

Transport over Ethernet usually requires some high level protocols to be used. The eMCH

implements a ‘Remote Management Control Protocol’ (RMCP, defined by the Distributed

Management Task Force (DMTF, http://www.dmtf.org/) interface whereby the IPMI

Page 25: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

Version 1.2 © N.A.T. GmbH 25

messages are embedded into the RMCP messages that are sent using UDP via an

Ethernet channel.

The RMCP fulfills all requirements that are necessary to transfer IPMI messages over the

Ethernet:

Presence echo mechanism (RMPC ping/pong messages)

Message flow control via sequence numbers

Support for multi-session

Transfer of session header

Support for authenticated access

Per-message authentication disable

User-level authentication disable

The eMCH supports access to the RMPC interface via its front Ethernet interface.

6.2.2 Supported IPMI messages

Handling of IPMI messages is done within a separate module of the software. The

message module’s configuration and a list of supported messages can be obtained using

the CLI command ‘imsg_info’. This command allows printing the compile time

configuration (list of supported message modules), the run time configuration and a list

of request messages that are supported.

6.3 Host software overview

6.3.1 Ipmitool

Ipmitool (available at http://ipmitool.sourceforge.net/) is an open source utility that runs

on a Linux PC for managing and configuring devices that support the Intelligent Platform

Management Interface. IPMI is an open standard for monitoring, logging, recovery,

inventory, and control of hardware that is implemented independent of the main CPU,

BIOS, and OS. The service processor (or Baseboard Management Controller, BMC) is the

brain behind platform management and its primary purpose is to handle the autonomous

sensor monitoring and event logging features.

The ipmitool program provides a simple command-line interface to this BMC. It features

the ability to read the sensor data repository (SDR) and print sensor values, display the

contents of the System Event Log (SEL), print Field Replaceable Unit (FRU) inventory

information, read and set LAN configuration parameters, and perform remote chassis

power control.

Ipmitool was not written to provide large-scale management application functionality.

The functionality is easily accomplished by sending simple IPMI request messages and

parsing the returned response. It is intended to be used by system administrators who

like the simplicity and scriptability of command-line utilities, as well as those debugging

or developing their own BMC implementations.

Please note that ipmitool is still under development. NAT recommends to use at least

version 1.8.11 since this version fixes some already known bugs (e.g. wrong decoding of

SEND_MESSAGE responses).

Page 26: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

Version 1.2 © N.A.T. GmbH 26

ipmitool call syntax

The following list gives examples for ipmitool call syntax:

Common syntax to access the NAT-eMCH over RMCP:

ipmitool –H <ip_address> -P “” <command>

Common syntax to access a target device behind the NAT-eMCH:

ipmitool –H <ip_address> -P “” –t <target_I2c> <command>

Common syntax to access a target device behind the NAT-eMCH using ‘double bridged’

OEM messages:

ipmitool –H <ip_address> -P “” –t <target_I2c> -T <target2_I2c> raw

<nfn> <cmd> <data>

where nfn is the network function code, cmd the IPMI message command and data the

IPMI message data part given as hexadecimal values.

6.3.2 NAT JAVA GUI application ‘NATView’

NATView is a graphical application that can be used to monitor and control an uTCA

system using IPMI messages. The application is written entirely in Java – it should

therefore run on every operating system that is able to execute the Sun Java Runtime

Environment (JRE).

6.3.2.1 Supported Java Releases

NATView requires Sun Java 1.6 or higher. This Sun Java version was chosen to guarantee

the largest possible JRE installation basis on Window, Linux and Mac OS X systems. If in

doubt enter

java –version

Page 27: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

Version 1.2 © N.A.T. GmbH 27

to a command prompt window. An appropriate copy of the Sun JRE can be obtained at java.sun.com.

6.3.2.2 Getting NATView

NATView can be downloaded from the NAT FTP server ftp.nateurope.com. Username is

natmch, password is natmch as well.

6.3.2.3 Installing and running NATView

NATView is usually distributed as a zip archive. The following steps will install NatView on

the system:

1. Extract the content of the zip archives to an empty directory. This empty directory

will be the root directory of the application.

2. Start the application from within the root directory. (Otherwise the application

cannot find the board images in the subdirectory images.) From the command line type

cd <root-directory>

java –jar natview.jar

6.3.2.4 Further information

More detailed information can be found in the documentation that is accompanying the

software.

Page 28: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

Version 1.2 © N.A.T. GmbH 28

7 Known Bugs / Restrictions

0001 ARP Request using a windows PC may take longer than expected

0002 NAT-view support just in early beta state. It may cause errors

with the eMCH. Also not all functions are supported yet (FRU-

editor).

SW

1.4

Page 29: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

Version 1.2 © N.A.T. GmbH 29

Appendix A: Updating the Bootloader

In some cases, a bootloader update is necessary to work with a new firmware release.

The bootloader can be updated almost the same way the firmware update works. Please

follow the steps described below:

1. Boot the device into firmware (standard boot)

2. Set your network configuration per "ip" command

3. Take a brower of your choice (e.g. Mozilla Firefox) and browse to

"http://192.168.1.138" (you will have to replace the devices ip address here if

changed before)

4. Log in to the page with the password "nat" (default)

5. Click on "update bootloader"

6. Select the bootloader image "EMCH_BL_Vxxx.srec" and click upload. Watch the

console output for any errors. The bootloader update may take up to 20 seconds, so

please be patient and dont touch anything until the update has finished. Reboot the

device by a click on "Reset MCU". The device should now boot into

the new FW.

7. Because of safety issues the bootrom code is placed into FW region first and then CRC

checked. This will cause the CRC check of the FW on next boot to fail. You will have to

update the firmware again after flashing the bootrom

NOTE: If anything went wrong during the update (e.g. lost of connection or power) -

dont worry. You can simply start the update procedure again.

Appendix B: Updating the Backplane EEPROM

1. Boot the device into firmware (standard boot)

2. Set your network configuration per "ip” command

3. Take a brower of your choice (e.g. Mozilla Firefox) and browse to

"http://192.168.1.138" (you will have to replace the devices ip address here if

changed before)

4. Log in to the page with the password "nat" (default)

5. Click on "update bootloader"

6. Select the bootloader image "EMCH_CARRIER.srec" and click upload. Watch the

console output for any errors. The process update may take up to 20 seconds, so

please be patient and dont touch anything until the update has finished.

7. There might be a CRC error at the end of flashing. Just ignore it.

8. Reboot the device by a click on "Reset MCU"

NOTE: When flashing a wrong FRU file, the eMCH will load the standard FRU file located

in FLASH memory. This file only contains information for the CM-FRU (253).

Page 30: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

Version 1.2 © N.A.T. GmbH 30

Appendix C: Cooling concept of Shelf-Manger The cooling unit scheme controls the fans as shown in the picture below to find the best

fan speed for the current system configuration.

Glossary:

Fan Speed (FS): Actual Fan Speed

Maximum Fan Speed (FSmax): Fans at 100% RPMs.

Default_Fan_Level (DFL): The Fan Speed after a MCH reboot (configurable)

Dynamic_Fan_Level (DyFL): The new Fan Speed after a Temp. Sensor alarm.

Fan_Step_Up (FSU)

Fan_Time_Up (FTU)

Fan_Step_Down (FSD)

Fan_Time_Down (FTD)

Fan_Time_Down_Dy (FTDy)

Possible MCH Status:

NORMAL: No Temp. Alarm. Non_Critical: At least one Temp. Sensor has reported that the upper noncritical threshold has been crossed.

Critical: At least one Temp. Sensor has reported that the upper critical threshold has been crossed. Non_Recoverable: At least one Temp. Sensor has reported that the non-recoverable threshold has been crossed.

Fan control description:

After an MCH reboot:

MCH Status= Normal

Fan Speed (FS) = DFL

DyFL = DFL

Non_Critical Event:

DyFL= DyFL+1

[FS=FS + FSU] each FTU seconds until FS=FSmax

Normal:

Page 31: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

Version 1.2 © N.A.T. GmbH 31

[FS=FS - FSD] each FTD seconds until FS= DyFL

When [FS= DyFL] then

Critical Event:

FS= Fsmax until normal status

DyFL= DyFL+1

Page 32: N.A.T.-EMCH Technical Reference Manual · NAT will not be responsible for any direct or indirect damages (including lost profits, lost savings, delays or interruptions in the flow

N.A.T.-EMCH – Technical Reference Manual

Version 1.2 © N.A.T. GmbH 32

Appendix D: Document’s History

Revision Date Description Author

1.0 15.09.2015 initial revision mm

1.1 12.11.2015 Functionality of SW ver 1.2 mm

1.2 17.02.2016 Added description of management architecture,

backplane description, carrier chassis, and changed

CLI command line description

mm

Appendix E: Reference Documentation

[1] Atmel Microcontroller SAM4E Datasheet