3U OpenVPX Ethernet Switch Board
Edit this on GitLab
INTRODUCTION
This manual provides information about the North Atlantic Industries, Inc. (NAI) 68G5E 3U OpenVPX Ethernet Switch and Multifunction I/O Board. The 68G5E is a 3U OpenVPX multifunction I/O and communications board that is configured with an Ethernet Switch module and provides additional support for one NAI smart I/O and communications function module.
SOFTWARE SUPPORT
Edit this on GitLab
The ENAIBL Software Support Kit (SSK) is supplied with all system platform based board level products. This platform’s SSK contents include html format help documentation which defines board specific library functions and their respective parameter requirements. A board specific library and its source code is provided (module level ‘C’ and header files) to facilitate function implementation independent of user operating system (O/S). Portability files are provided to identify Board Support Package (BSP) dependent functions and help port code to other common system BSPs. With the use of the provided help documentation, these libraries are easily ported to any 32-bit O/S such as RTOS or Linux.
The latest version of a board specific SSK can be downloaded from our website www.naii.com in the software downloads section. A Quick-Start Software Manual is also available for download where the SSK contents are detailed, Quick-Start Instructions provided and GUI applications are described therein. For other operating system support, contact factory.
SPECIFICATIONS
General for the Motherboard
Signal Logic Level: |
Supports LVDS PCIe ver. 2.0 bus (x1) |
Power (Motherboard): |
+5 VDC @ 1 A (typical) ±12 V @ 0 mA (certain modules may require +/-12 V for operation) +3.3V_AUX @ <100 mA (typical) Then add power for each individual module |
Temperature, Operating: |
"C" =0° C to +70° C, "H" =-40° C to +85° C (see part number) |
Storage Temperature: |
-55° C to +105° C |
Temperature Cycling: |
Each board is cycled from -40° C to +85° C for options "C" or “H” |
General size |
|
Height: |
3.94" / 100 mm (3U) |
Width: |
0.8” / 20.3 mm (4HP) or 1.0" / 25.4 mm (5 HP) air cooled front panel options |
Depth: |
6.3“ / 160 mm deep |
Weight: |
12.5 oz. (354 g) unpopulated (approx.) (convection or conduction cooled) >> then add weight for each module (typically 1.5 oz. (42 g) each) |
Specifications are subject to change without notice.
Environmental
Unless otherwise specified, the following table outlines the general Environmental Specifications design guidelines for board level products of North Atlantic Industries. All our cPCI, VME and OpenVPX boards are designed for either air or conduction cooling. All boards also incorporate appropriate stiffening to ensure performance during shock and vibration but also to assure reliable operation (lower fatigue stresses) over the service life of the product.
Parameters |
Level |
||
1 / Commercial-AC (Air Cooled) |
2 / Rugged-AC (Air Cooled) |
3 / Rugged-CC (Conduction Cooled) |
|
Temperature - Operating |
0° C to 70° C, AmbientH |
-40° C to 85° C, AmbientI |
-40° C to 85° C, at wedge lock thermal interface |
Temperature - Storage |
-40° C to 85° C |
-55° C to 105° C |
-55° C to 105° C |
Humidity - Operating |
0 to 95%, non-condensing |
0 to 95%, non-condensing |
0 to 95%, non-condensing |
Humidity - Storage |
0 to 95%, non-condensing |
0 to 95%, non-condensing |
0 to 95%, non-condensing |
Vibration - SineA |
2 g peak, 15 Hz - 2 kHzB |
6 g peak, 15 Hz - 2 kHzB |
10 g peak, 15 Hz - 2 kHzC |
Vibration - RandomD |
.002 g2 /Hz, 15 Hz - 2 kHz |
0.04 g2 /Hz, 15 Hz - 2 kHz |
0.1 g2 /Hz, 15 Hz - 2 kHzE |
ShockF |
20 g peak, half-sine, 11 ms |
30 g peak, half-sine 11 ms |
40 g peak, half-sine, 11 ms |
Low PressureG |
Up to 15,000 ft. |
Up to 50,000 ft. |
Up to 50,000 ft. |
Notes:
-
Based on sweep duration of ten minutes per axis on each of the three mutually perpendicular axes.
-
Displacement limited to 0.10 D.A. from 15 to 44 Hz.
-
Displacement limited to 0.436 D.A. from 15 to 21 Hz.
-
60 minutes per axis on each of the three mutually perpendicular axes.
-
Per MIL-STD-810G, Method 5.14.6 Procedure I, Fig.514.6C-6 Category 7 tailored (11.65 Grms): 15 Hz - 2 kHz; ASD (PSD) at 0.04 g2/Hz between 15 Hz - 150 Hz, increasing @ 4 dB/octave from 0.04 g2/Hz to 0.1 g /Hz between 150 Hz - 300 Hz, 0.1 g2/Hz between 300 Hz - 1000 Hz, decreasing @ 6 dB/octave from 0.1 g2/Hz to 0.025 g2/Hz between 1000 Hz - 2000 Hz. Three hits per direction per axis (total of 18 hits).
-
Three hits per direction per axis (total of 18 hits).
-
For altitudes higher than 50,000 ft., contact NAI.
-
High temperature operation requires 350 lfm minimum air flow across cover/heatsink (module dependent).
-
High temperature operation requires 600 lfm minimum air flow across cover/heatsink (module dependent).
Specifications subject to change without notice
REGISTER MEMORY MAP ADDRESSING
The register map address consists of the following:
-
cPCI/PCIe BAR or Base Address for the Board
-
Module Slot Base Address
-
Function Offset Address
Board Base Address
The table below lists the BAR used for access to the motherboard and module registers. The second BAR is used internally for motherboard and module firmware updates. The other cPCI/PCIe BARs not listed are not used.
NAI Boards |
Device ID |
Bus |
Motherboard and Module Register Access |
Motherboard and Module Firmware Updates |
Slave Boards |
||||
68G5E |
0x6881 |
PCIe |
BAR 1 Size: Module Dependent (minimum 64K Bytes) |
BAR 2 Size: 1M Bytes |
Module Slot and Function Addresses
The memory map for the modules are dependent on the types of modules on the board and the order in which the modules are installed on the board as well as the firmware installed on the motherboard. The function modules are enumerated allowing for dynamic memory space allocation and therefore the “start” address of the module function register area is factory pre-defined (and read from) the Module Address register. Refer to Figure 1 for an example.
Figure 1. Register Memory Map Addressing for Motherboards with ESx and 1 Module
Address Calculation
Motherboard Registers
Read/Write access to the motherboard registers starts with the base address for the board and then the motherboard base offset address.
For example, to address Module Slot 1 Start Address register (i.e. register address = 0x0400):
-
Start with the base address for the board.
-
Add the motherboard register address offset.
Motherboard Address = |
Base Address + Motherboard Address Offset |
= 0x0000 0400 |
0x0000 0000 + 0x0400 |
Module Registers:
Read/Write access to the Function module’s registers start with the base address of the board. Add the “content” for the Module Start Address and then, add the specific module function register offset.
For example, to address an appropriate/specific function module with a register offset:
-
Start with the base address for the board.
-
Add the value (contents) from the module base address offset register (contents/value of Motherboard Memory register for Module 1 (i.e., @ 0x0400) = 0x4000.
-
Then add the specific module function Register Offset of interest (i.e., A/D Reading Ch 1 @ 0x1000)
(Function Specific) Address = |
Base Address |
Module Base Address Offset |
Function Register Offset |
= 0x0000 5000 |
0x0000 0000 |
0x4000 |
0x1000 |
REGISTER DESCRIPTIONS
Module Information Registers
The Module Slot Addressing Ready, Module Slot Address, Module Slot Size and Module Slot ID provide information about the modules detected on the board.
Module Slot Addressing Ready
Edit this on GitLab
Function: Indicates that the module slots are ready to be addressed.
Type: unsigned binary word (32-bit)
Data Range: 0x0000 0000 to 0xFFFF FFFF
Read/Write: R
Initialized Value: 0xA5A5A5A5
Operational Settings: This register will contain the value of 0xA5A5A5A5 when the module addresses have been determined.
Module Slot Address
Edit this on GitLab
Function: Specifies the Base Address for the module in the specific slot position.
Type: unsigned binary word (32-bit)
Data Range: 0x0000 0000 to 0xFFFF FFFF
Read/Write: R
Initialized Value: Based on board’s module configuration.
Operational Settings: 0x0000 0000 indicates no Module found.
Module Slot Size
Edit this on GitLab
Function: Specifies the Memory Size (in bytes) allocated for the module in the specific slot position.
Type: unsigned binary word (32-bit)
Range: 0x0000 0000 to 0xFFFF FFFF
Read/Write: R
Initialized Value: Assigned by factory for the module.
Operational Settings: 0x0000 0000 indicates no Module found.
Module Slot ID
Edit this on GitLab
Function: Specifies the Model ID for the module in the specified slot position.
Type: 4-character ASCII string
Data Range: 0x0000 0000 to 0xFFFF FFFF
Read/Write: R
Initialized Value: Assigned by factory for the module.
Operational Settings: The Module ID is formatted as four ASCII bytes: three characters followed by a space. Module IDs are in little-endian order with a single space following the first three characters. For example, 'TL1' is '1LT', 'SC1' is '1CS' and so forth. Example below is for “TL1” (MSB justified). All value of 0000 0000 indicates no Module found.
D31 |
D30 |
D29 |
D28 |
D27 |
D26 |
D25 |
D24 |
D23 |
D22 |
D21 |
D20 |
D19 |
D18 |
D17 |
D16 |
ASCII Character (ex: 'T' - 0x54) |
ASCII Character (ex: 'L' - 0x4C) |
||||||||||||||
D15 |
D14 |
D13 |
D12 |
D11 |
D10 |
D9 |
D8 |
D7 |
D6 |
D5 |
D4 |
D3 |
D2 |
D1 |
D0 |
ASCII Character (ex: '1' - 0x31) |
ASCII Space (' ' - 0x20) |
Hardware Information Registers
The registers identified in this section provide information about the board’s hardware.
Product Serial Number
Edit this on GitLab
Function: Specifies the Board Serial Number.
Type: unsigned binary word (32-bit)
Data Range: 0x0000 0000 to 0xFFFF FFFF
Read/Write: R
Initialized Value: Serial number assigned by factory for the board.
Operational Settings: N/A
Platform
Function: Specifies the Board Platform Identifier. Values are for the ASCII characters for the NAI valid platforms (Identifiers).
Type: unsigned binary word (32-bit)
Data Range: See table below.
Read/Write: R
Initialized Value: ASCII code is for the Platform Identifier of the board
Operational Settings: Valid NAI platform and the associated value for the platform is shown below:
NAI Platform |
Platform Identifier |
ASCII Binary Values (Note: little-endian order of ascii values) |
3U VPX |
68 |
0x0000 3836 |
Model
Function: Specifies the Board Model Identifier. Value is for the ASCII characters for the NAI valid model.
Type: unsigned binary word (32-bit)
Data Range: See table below.
Read/Write: R
Initialized Value: ASCII code is for the Model Identifier of the board
Operational Settings: Example of NAI model and the associated value for the model is shown below:
NAI Model |
ASCII Binary Values (Note: little-endian order of ascii values) |
G |
0x0000 0047 |
Generation
Function: Specifies the Board Generation. Identifier values are for the ASCII characters for the NAI valid generation identifiers.
Type: unsigned binary word (32-bit)
Data Range: See table below.
Read/Write: R
Initialized Value: ASCII code is for the Generation Identifier of the board
Operational Settings: Example of NAI generation and the associated value for the generation is shown below:
NAI Generation |
ASCII Binary Values (Note: little-endian order of ascii values) |
5 |
0x0000 0035 |
Processor Count/Ethernet Count
Function: Specifies the Processor Count and Ethernet Count
Type: unsigned binary word (32-bit)
Data Range: See table below.
Read/Write: R
Operational Settings:
Processor Count - Integer: indicates the number of unique processor types on the motherboard.
NAI Board |
Processor Count |
Description |
|
3U-VPX |
68G5E |
1 |
Xilinx Zynq 7015 with Dual Core Cortex A9 |
Ethernet Interface Count - Indicates the number of Ethernet interfaces on the product motherboard. For example, Single Ethernet = 1; Dual Ethernet = 2.
D31 |
D30 |
D29 |
D28 |
D27 |
D26 |
D25 |
D24 |
D23 |
D22 |
D21 |
D20 |
D19 |
D18 |
D17 |
D16 |
Processor Count (See Table) |
|||||||||||||||
D15 |
D14 |
D13 |
D12 |
D11 |
D10 |
D9 |
D8 |
D7 |
D6 |
D5 |
D4 |
D3 |
D2 |
D1 |
D0 |
Ethernet Count (Based on Part Number Ethernet Options) |
Maximum Module Slot Count/ARM Platform Type
Function: Specifies the Maximum Module Slot Count and ARM Platform Type.
Type: unsigned binary word (32-bit)
Data Range: See table below.
Read/Write: R
Operational Settings:
Maximum Module Slot Count - Indicates the number of modules that can be installed on the product.
ARM Platform - Altera = 1; Xilinx X1 = 2; Xilinx X2 = 3; UltraScale = 4
NAI Board |
Maximum Module Slot Count |
ARM Platform Type |
|
3U-VPX |
68G5E |
3 |
Xilinx X2 = 3 |
D31 |
D30 |
D29 |
D28 |
D27 |
D26 |
D25 |
D24 |
D23 |
D22 |
D21 |
D20 |
D19 |
D18 |
D17 |
D16 |
Maximum Module Slot Count (See Table) |
|||||||||||||||
D15 |
D14 |
D13 |
D12 |
D11 |
D10 |
D9 |
D8 |
D7 |
D6 |
D5 |
D4 |
D3 |
D2 |
D1 |
D0 |
ARM Platform Type (See Table) |
Motherboard Firmware Information Registers
The registers in this section provide information on the revision of the firmware installed on the motherboard.
Motherboard Core (MBCore) Firmware Version
Edit this on GitLab
Function: Specifies the Version of the NAI factory provided Motherboard Core Application installed on the board.
Type: Two (2) unsigned binary word (32-bit)
Data Range: 0x0000 0000 to 0xFFFF FFFF
Read/Write: R
Operational Settings: The motherboard firmware version consists of four components: Major, Minor, Minor 2 and Minor 3.
Word 1 (Ex. 0007 0004 = 4.7 (Major.Minor) |
|||||||||||||||
D31 |
D30 |
D29 |
D28 |
D27 |
D26 |
D25 |
D24 |
D23 |
D22 |
D21 |
D20 |
D19 |
D18 |
D17 |
D16 |
Minor (ex: 0x0007 = 7) |
|||||||||||||||
D15 |
D14 |
D13 |
D12 |
D11 |
D10 |
D9 |
D8 |
D7 |
D6 |
D5 |
D4 |
D3 |
D2 |
D1 |
D0 |
Major (ex: 0x0004 = 4) |
|||||||||||||||
Word 2 (Ex. 0x0000 0000 = 0000 = 0.0 (Minor2.Minor3)) |
|||||||||||||||
D31 |
D30 |
D29 |
D28 |
D27 |
D26 |
D25 |
D24 |
D23 |
D22 |
D21 |
D20 |
D19 |
D18 |
D17 |
D16 |
Minor 3 (ex: 0x000 = 0) |
|||||||||||||||
D15 |
D14 |
D13 |
D12 |
D11 |
D10 |
D9 |
D8 |
D7 |
D6 |
D5 |
D4 |
D3 |
D2 |
D1 |
D0 |
Minor 2 (ex: 0x000 = 0) |
Motherboard Firmware Build Time/Date
Edit this on GitLab
Function: Specifies the Build Date/Time of the NAI factory provided Motherboard Core Application installed on the board.
Type: Two (2) unsigned binary word (32-bit)
Data Range: N/A
Read/Write: R
Operational Settings: The motherboard firmware time consists of the Build Date and Build Time.
Note
|
On some builds the the Date/Time fields are fixed to 0000 0000 to maintain binary consistency across builds. |
Word 1 - Build Date (ex. 0x030C 07E2 = 2018-12-03) |
|||||||||||||||
D31 |
D30 |
D29 |
D28 |
D27 |
D26 |
D25 |
D24 |
D23 |
D22 |
D21 |
D20 |
D19 |
D18 |
D17 |
D16 |
Day (ex: 0x03 = 3) |
Month (ex: 0x0C = 12) |
||||||||||||||
D15 |
D14 |
D13 |
D12 |
D11 |
D10 |
D9 |
D8 |
D7 |
D6 |
D5 |
D4 |
D3 |
D2 |
D1 |
D0 |
Year (ex: 0x07E2 = 2018) |
|||||||||||||||
Word 2 - Build Time (ex. 0x001B 3B0A = 10:59:27) |
|||||||||||||||
D31 |
D30 |
D29 |
D28 |
D27 |
D26 |
D25 |
D24 |
D23 |
D22 |
D21 |
D20 |
D19 |
D18 |
D17 |
D16 |
null (0x00) |
Seconds (ex: 0x1B = 27) |
||||||||||||||
D15 |
D14 |
D13 |
D12 |
D11 |
D10 |
D9 |
D8 |
D7 |
D6 |
D5 |
D4 |
D3 |
D2 |
D1 |
D0 |
Minutes (ex: 0x3B = 59) |
Hours (ex: 0x0A = 10) |
Motherboard Monitoring Registers
The registers in this provide motherboard temperature measurement information.
Temperature Readings Register
Edit this on GitLab
The temperature registers provide the current, maximum (from power-up) and minimum (from power-up) for the processor and PCB for Zynq processor.
These registers are only available on Xilinx Generation 5 platforms, and are periodically populated by the motherboard core application, which only runs in Petalinux and BareMetal. For other operating systems, refer to the naibrd Software Support Kit (SSK) naibsp_system_Monitor_Temperature_Get() routine to manually retrieve the temperature (NOTE: this feature is typically utilized for development/factory use only; contact the factory for additional details on potential use, if required).
Function: Specifies the Measured Temperatures on Motherboard.
Type: signed byte (8-bits) for each temperature reading - Six (6) 32-bit words
Data Range: 0x0000 0000 to 0xFFFF 0000
Read/Write: R
Initialized Value: Value corresponding to the measured temperatures based on the table below.
Operational Settings: The 8-bit temperature readings are signed bytes. For example, if the following register contains the value 0x6955 0000:
Example:
D31 |
D30 |
D29 |
D28 |
D27 |
D26 |
D25 |
D24 |
D23 |
D22 |
D21 |
D20 |
D19 |
D18 |
D17 |
D16 |
Max Zynq Core Temperature |
Max Zynq PCB Temperature |
||||||||||||||
D15 |
D14 |
D13 |
D12 |
D11 |
D10 |
D9 |
D8 |
D7 |
D6 |
D5 |
D4 |
D3 |
D2 |
D1 |
D0 |
0x00 |
0x00 |
The values would represent the following temperatures:
Temperature Measurements |
Data Bits |
Value |
Temperature (Celsius) |
Max Zynq Core Temperature |
D31:D24 |
0x69 |
+105° |
Max Zynq PCB Temperature |
D23:D16 |
0x55 |
+85° |
Temperature Readings
D31 |
D30 |
D29 |
D28 |
D27 |
D26 |
D25 |
D24 |
D23 |
D22 |
D21 |
D20 |
D19 |
D18 |
D17 |
D16 |
Zynq Core Temperature |
Zynq PCB Temperature |
||||||||||||||
D15 |
D14 |
D13 |
D12 |
D11 |
D10 |
D9 |
D8 |
D7 |
D6 |
D5 |
D4 |
D3 |
D2 |
D1 |
D0 |
0x00 |
0x00 |
D31 |
D30 |
D29 |
D28 |
D27 |
D26 |
D25 |
D24 |
D23 |
D22 |
D21 |
D20 |
D19 |
D18 |
D17 |
D16 |
0x00 |
0x00 |
||||||||||||||
D15 |
D14 |
D13 |
D12 |
D11 |
D10 |
D9 |
D8 |
D7 |
D6 |
D5 |
D4 |
D3 |
D2 |
D1 |
D0 |
0x00 |
0x00 |
D31 |
D30 |
D29 |
D28 |
D27 |
D26 |
D25 |
D24 |
D23 |
D22 |
D21 |
D20 |
D19 |
D18 |
D17 |
D16 |
Max Zynq Core Temp |
Max Zynq PCB Temp |
||||||||||||||
D15 |
D14 |
D13 |
D12 |
D11 |
D10 |
D9 |
D8 |
D7 |
D6 |
D5 |
D4 |
D3 |
D2 |
D1 |
D0 |
0x00 |
0x00 |
D31 |
D30 |
D29 |
D28 |
D27 |
D26 |
D25 |
D24 |
D23 |
D22 |
D21 |
D20 |
D19 |
D18 |
D17 |
D16 |
0x00 |
0x00 |
||||||||||||||
D15 |
D14 |
D13 |
D12 |
D11 |
D10 |
D9 |
D8 |
D7 |
D6 |
D5 |
D4 |
D3 |
D2 |
D1 |
D0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
D31 |
D30 |
D29 |
D28 |
D27 |
D26 |
D25 |
D24 |
D23 |
D22 |
D21 |
D20 |
D19 |
D18 |
D17 |
D16 |
Min Zynq Core Temperature |
Min Zynq PCB Temperature |
||||||||||||||
D15 |
D14 |
D13 |
D12 |
D11 |
D10 |
D9 |
D8 |
D7 |
D6 |
D5 |
D4 |
D3 |
D2 |
D1 |
D0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
D31 |
D30 |
D29 |
D28 |
D27 |
D26 |
D25 |
D24 |
D23 |
D22 |
D21 |
D20 |
D19 |
D18 |
D17 |
D16 |
0x00 |
0x00 |
||||||||||||||
D15 |
D14 |
D13 |
D12 |
D11 |
D10 |
D9 |
D8 |
D7 |
D6 |
D5 |
D4 |
D3 |
D2 |
D1 |
D0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
Higher Precision Temperature Readings Register
These registers provide higher precision readings of the current Zynq and PCB temperatures.
Higher Precision Zynq Core Temperature
Edit this on GitLab
Function: Specifies the Higher Precision Measured Zynq Core temperature on Interface Board.
Type: signed word (16-bits) for integer part and unsigned word (16-bits) for fractional part
Data Range: 0x0000 0000 to 0xFFFF FFFF
Read/Write: R
Initialized Value: Measured Zynq Core temperature on Interface Board
Operational Settings: The upper 16-bits represent the signed integer part of the temperature and the lower 16-bits represent the fractional part of the temperature with the resolution of 1/1000 of degree Celsius. For example, if the register contains the value 0x002B 0271, this represents Zynq Core Temperature = 43.625° Celsius, and value 0xFFF6 0177 represents -10.375° Celsius.
D31 |
D30 |
D29 |
D28 |
D27 |
D26 |
D25 |
D24 |
D23 |
D22 |
D21 |
D20 |
D19 |
D18 |
D17 |
D16 |
Signed Integer Part of Temperature |
|||||||||||||||
D15 |
D14 |
D13 |
D12 |
D11 |
D10 |
D9 |
D8 |
D7 |
D6 |
D5 |
D4 |
D3 |
D2 |
D1 |
D0 |
Fractional Part of Temperature |
Higher Precision Motherboard PCB Temperature
Edit this on GitLab
Function: Specifies the Higher Precision Measured Motherboard PCB temperature.
Type: signed word (16-bits) for integer part and unsigned word (16-bits) for fractional part
Data Range: 0x0000 0000 to 0xFFFF FFFF
Read/Write: R
Initialized Value: Measured Motherboard PCB temperature
Operational Settings: The upper 16-bits represent the signed integer part of the temperature and the lower 16-bits represent the fractional part of the temperature with the resolution of 1/1000 of degree Celsius. For example, if the register contains the value 0x0020 007D, this represents Interface PCB Temperature = 32.125° Celsius, and value 0xFFE8 036B represents -24.875° Celsius.
D31 |
D30 |
D29 |
D28 |
D27 |
D26 |
D25 |
D24 |
D23 |
D22 |
D21 |
D20 |
D19 |
D18 |
D17 |
D16 |
Signed Integer Part of Temperature |
|||||||||||||||
D15 |
D14 |
D13 |
D12 |
D11 |
D10 |
D9 |
D8 |
D7 |
D6 |
D5 |
D4 |
D3 |
D2 |
D1 |
D0 |
Fractional Part of Temperature |
Motherboard Health Monitoring Registers
The registers in this section provide a summary of motherboard temperature sensors and their corresponding bits. Additionally, this section provides an overview of the registers allocated to those sensors, which are used to monitor current/minimum/maximum temperature readings, upper & lower critical/warning temperature thresholds, and whether or not a programmed temperature threshold has been exceeded.
These registers are only available on Xilinx Generation 5 platforms, and are periodically populated by the motherboard core application, which only runs in Petalinux and BareMetal. For other operating systems, refer to the naibrd Software Support Kit (SSK) naibsp_system_Monitor_Temperature_Get() routine to manually retrieve the temperature (NOTE: this feature is typically utilized for development/factory use only; contact the factory for additional details on potential use, if required).
Motherboard Sensor Summary Status
Edit this on GitLab
Function: The corresponding sensor bit is set if the sensor has crossed any of its thresholds.
Type: unsigned binary word (32-bits)
Data Range: See table below
Read/Write: R
Initialized Value: 0
Operational Settings: This register provides a summary for motherboard sensors. When the corresponding sensor bit is set, the Sensor Threshold Status register for that sensor will indicate the threshold condition that triggered the event.
Bit(s) |
Sensor |
D31:D5 |
Reserved |
D4 |
Motherboard PCB Temperature |
D3 |
Zynq Core Temperature |
D2:D0 |
Reserved |
Motherboard Sensor Registers
Edit this on GitLab
The registers listed in this section apply to each module sensor listed for the Motherboard Sensor Summary Status register. Each individual sensor register provides a group of registers for monitoring motherboard temperatures readings. From these registers, a user can read the current temperature of the sensor in addition to the minimum and maximum temperature readings since power-up. Upper and lower critical/warning temperature thresholds can be set and monitored from these registers. When a programmed temperature threshold is crossed, the Sensor Threshold Status register will set the corresponding bit for that threshold. The figure below shows the functionality of this group of registers when accessing the Zynq Core Temperature sensor as an example.
Sensor Threshold Status_
Edit this on GitLab
Function: Reflects which threshold has been crossed
Type: unsigned binary word (32-bits)
Data Range: See table below
Read/Write: R
Initialized Value: 0
Operational Settings: The associated bit is set when the sensor reading exceed the corresponding threshold settings.
Bit(s) |
Description |
D31:4 |
Reserved |
D3 |
Exceeded Upper Critical Threshold |
D2 |
Exceeded Upper Warning Threshold |
D1 |
Exceeded Lower Critical Threshold |
D0 |
Exceeded Lower Warning Threshold |
Sensor Current Reading
Edit this on GitLab
Function: Reflects current reading of temperature sensor
Type: Single Precision Floating Point Value (IEEE-754)
Data Range: Single Precision Floating Point Value (IEEE-754)
Read/Write: R
Initialized Value: N/A
Operational Settings: The register represents current sensor reading as a single precision floating point value. For example, for a temperature sensor, register value 0x41C6 0000 represents temperature = 24.75° Celsius.
Sensor Minimum Reading
Edit this on GitLab
Function: Reflects minimum value of temperature sensor since power up
Type: Single Precision Floating Point Value (IEEE-754)
Data Range: Single Precision Floating Point Value (IEEE-754)
Read/Write: R
Initialized Value: N/A
Operational Settings: The register represents minimum sensor value as a single precision floating point value. For example, for a temperature sensor, register value 0x41C6 0000 represents temperature = 24.75° Celsius.
Sensor Maximum Reading
Edit this on GitLab
Function: Reflects maximum value of temperature sensor since power up
Type: Single Precision Floating Point Value (IEEE-754)
Data Range: Single Precision Floating Point Value (IEEE-754)
Read/Write: R
Initialized Value: N/A
Operational Settings: The register represents maximum sensor value as a single precision floating point value. For example, for a temperature sensor, register value 0x41C6 0000 represents temperature = 24.75° Celsius.
Sensor Lower Warning Threshold
Edit this on GitLab
Function: Reflects lower warning threshold of temperature sensor
Type: Single Precision Floating Point Value (IEEE-754)
Data Range: Single Precision Floating Point Value (IEEE-754)
Read/Write: R/W
Initialized Value: Default lower warning threshold (value dependent on specific sensor)
Operational Settings: The register represents sensor lower warning threshold as a single precision floating point value. For example, for a temperature sensor, register value 0xC220 0000 represents temperature = -40.0° Celsius.
Sensor Lower Critical Threshold
Edit this on GitLab
Function: Reflects lower critical threshold of temperature sensor
Type: Single Precision Floating Point Value (IEEE-754)
Data Range: Single Precision Floating Point Value (IEEE-754)
Read/Write: R/W
Initialized Value: Default lower critical threshold (value dependent on specific sensor)
Operational Settings: The register represents sensor lower critical threshold as a single precision floating point value. For example, for a temperature sensor, register value 0xC25C 0000 represents temperature = -55.0° Celsius.
Sensor Upper Warning Threshold
Edit this on GitLab
Function: Reflects upper warning threshold of temperature sensor
Type: Single Precision Floating Point Value (IEEE-754)
Data Range: Single Precision Floating Point Value (IEEE-754)
Read/Write: R/W
Initialized Value: Default upper warning threshold (value dependent on specific sensor)
Operational Settings: The register represents sensor upper warning threshold as a single precision floating point value. For example, for a temperature sensor, register value 0x42AA 0000 represents temperature = 85.0° Celsius.
Sensor Upper Critical Threshold
Edit this on GitLab
Function: Reflects upper critical threshold of temperature sensor
Type: Single Precision Floating Point Value (IEEE-754)
Data Range: Single Precision Floating Point Value (IEEE-754)
Read/Write: R/W
Initialized Value: Default upper critical threshold (value dependent on specific sensor)
Operational Settings: The register represents sensor upper critical threshold as a single precision floating point value. For example, for a temperature sensor, register value 0x42FA 0000 represents temperature = 125.0° Celsius.
Ethernet Configuration Registers
Edit this on GitLab
The registers in this section provide information about the Ethernet Configuration for the two ports on the board.
Important: Regardless if the board is configured for one or two Ethernet ports, the second IP address cannot be on the same Subnet as the First IP Address. The table below provides examples of valid and invalid IP Addresses and Subnet Mask Addresses.
First Port (A) IP Address |
First Port (A) Subnet Mask |
Second Port (B) IP Address |
Second Port (B) Subnet Mask |
Result |
192.168.1.5 |
255.255.255.0 |
192.168.2.5 |
255.255.255.0 |
Good |
192.168.1.5 |
255.255.0.0 |
192.168.2.5 |
255.255.0.0 |
Conflict |
192.168.1.5 |
255.255.0.0 |
192.168.2.5 |
255.255.255.0 |
Conflict |
10.0.0.15 |
255.0.0.0 |
192.168.1.5 |
255.255.255.0 |
Good |
Ethernet MAC Address and Ethernet Settings
Edit this on GitLab
Function: Specifies the Ethernet MAC Address and Ethernet Settings for the Ethernet port.
Type: Two (2) unsigned binary word (32-bit)
Data Range: See table.
Read/Write: R
Operational Settings: The Ethernet MAC Address consists of six octets. The Ethernet Settings are defined in table.
Bits |
Description |
Values |
D31:D23 |
Reserved |
0 |
D22:D21 |
Duplex |
00 = Not Specified, 01 = Half Duplex, 10 = Full Duplex, 11 = Reserved |
D20:D18 |
Speed |
000 = Not Specified, 001 = 10 Mbps, 010 = 100 Mbps, 011 = 1000 Mbps, 100 = 2500 Mbps, 101 = 10000 Mbps, 110 = Reserved, 111 = Reserved |
D17 |
Auto Negotiate |
0 = Enabled, 1 = Disabled |
D16 |
Static IP Address |
0 = Enabled, 1 = Disabled |
Word 1 (Ethernet MAC Address (Octets 1-4)) (ex: aa:bb:cc:dd:ee:ff) |
|||||||||||||||
D31 |
D30 |
D29 |
D28 |
D27 |
D26 |
D25 |
D24 |
D23 |
D22 |
D21 |
D20 |
D19 |
D18 |
D17 |
D16 |
MAC Address Octet 4 (ex: 0xDD) |
MAC Address Octet 3 (ex: 0xCC) |
||||||||||||||
D15 |
D14 |
D13 |
D12 |
D11 |
D10 |
D9 |
D8 |
D7 |
D6 |
D5 |
D4 |
D3 |
D2 |
D1 |
D0 |
MAC Address Octet 2 (ex: 0xBB) |
MAC Address Octet 1 (ex: 0xAA) |
||||||||||||||
Word 2 (Ethernet MAC Address (Octets 5-6) and Ethernet Settings) |
|||||||||||||||
D31 |
D30 |
D29 |
D28 |
D27 |
D26 |
D25 |
D24 |
D23 |
D22 |
D21 |
D20 |
D19 |
D18 |
D17 |
D16 |
Ethernet Settings (See table) |
|||||||||||||||
D15 |
D14 |
D13 |
D12 |
D11 |
D10 |
D9 |
D8 |
D7 |
D6 |
D5 |
D4 |
D3 |
D2 |
D1 |
D0 |
MAC Address Octet 6 (ex: 0xFF) |
MAC Address Octet 5 (ex: 0xEE) |
Ethernet Interface Name
Edit this on GitLab
Function: Specifies the Ethernet Interface Name for the Ethernet port.
Type: 8-character ASCII string
Data Range: See table.
Read/Write: R
Operational Settings: The Ethernet Interface Name (eth0, eth1, etc) for the Ethernet port.
Word 1 (Bit 0-31) (ex: 0x3068 7465 = “0hte”) |
|||||||||||||||
D31 |
D30 |
D29 |
D28 |
D27 |
D26 |
D25 |
D24 |
D23 |
D22 |
D21 |
D20 |
D19 |
D18 |
D17 |
D16 |
ASCII Character (ex: '0' - 0x30) |
ASCII Character (ex: 'h' - 0x68) |
||||||||||||||
D15 |
D14 |
D13 |
D12 |
D11 |
D10 |
D9 |
D8 |
D7 |
D6 |
D5 |
D4 |
D3 |
D2 |
D1 |
D0 |
ASCII Character (ex: 't' - 0x74) |
ASCII Character (ex: 'e' - 0x65) |
||||||||||||||
Word 2 (Bit 32-63) (ex: 0x0000 0000) |
|||||||||||||||
D31 |
D30 |
D29 |
D28 |
D27 |
D26 |
D25 |
D24 |
D23 |
D22 |
D21 |
D20 |
D19 |
D18 |
D17 |
D16 |
ASCII Character (ex: null - 0x00) |
ASCII Character (ex: null - 0x00) |
||||||||||||||
D15 |
D14 |
D13 |
D12 |
D11 |
D10 |
D9 |
D8 |
D7 |
D6 |
D5 |
D4 |
D3 |
D2 |
D1 |
D0 |
ASCII Character (ex: null - 0x00) |
ASCII Character (ex: null - 0x00) |
Ethernet IPv4 Address
Edit this on GitLab
Function: Specifies the Ethernet IPv4 Address for the Ethernet port.
Type: Three (3) unsigned binary word (32-bit)
Data Range: See table.
Read/Write: R
Operational Settings: The Ethernet IPv4 Address consists of three parts: IPv4 Address, IPv4 Subnet Mask and IPv4 Gateway.
Word 1 (Ethernet IPv4 Address) (ex: 0x1001 A8C0 = 192.168.1.16) |
|||||||||||||||
D31 |
D30 |
D29 |
D28 |
D27 |
D26 |
D25 |
D24 |
D23 |
D22 |
D21 |
D20 |
D19 |
D18 |
D17 |
D16 |
IPv4 Address Octet 4 (ex: 0x10 = 16) |
IPv4 Address Octet 3 (ex: 0x01 = 1) |
||||||||||||||
D15 |
D14 |
D13 |
D12 |
D11 |
D10 |
D9 |
D8 |
D7 |
D6 |
D5 |
D4 |
D3 |
D2 |
D1 |
D0 |
IPv4 Address Octet 2 (ex: 0xA8 = 168) |
IPv4 Address Octet 1 (ex: 0xC0 = 192) |
||||||||||||||
Word 2 (Ethernet IPv4 Subnet) (ex: 0x00FF FFFF = 255.255.255.0) |
|||||||||||||||
D31 |
D30 |
D29 |
D28 |
D27 |
D26 |
D25 |
D24 |
D23 |
D22 |
D21 |
D20 |
D19 |
D18 |
D17 |
D16 |
IPv4 Subnet Octet 4 (ex: 0x00 = 0) |
IPv4 Subnet Octet 3 (ex: 0xFF = 255) |
||||||||||||||
D15 |
D14 |
D13 |
D12 |
D11 |
D10 |
D9 |
D8 |
D7 |
D6 |
D5 |
D4 |
D3 |
D2 |
D1 |
D0 |
IPv4 Subnet Octet 2 (ex: 0xFF = 255) |
IPv4 Subnet Octet 1 (ex: 0xFF = 255) |
||||||||||||||
Word 3 (Ethernet IPv4 Gateway) (ex: 0x0101 A8C0 = 192.168.1.1) |
|||||||||||||||
D31 |
D30 |
D29 |
D28 |
D27 |
D26 |
D25 |
D24 |
D23 |
D22 |
D21 |
D20 |
D19 |
D18 |
D17 |
D16 |
IPv4 Gateway Octet 4 (ex: 0x01 = 1) |
IPv4 Gateway Octet 3 (ex: 0x01 = 1) |
||||||||||||||
D15 |
D14 |
D13 |
D12 |
D11 |
D10 |
D9 |
D8 |
D7 |
D6 |
D5 |
D4 |
D3 |
D2 |
D1 |
D0 |
IPv4 Gateway Octet 2 (ex: 0xA8 = 168) |
IPv4 Gateway Octet 1 (ex: 0xC0 = 192) |
Ethernet IPv6 Address
Edit this on GitLab
Function: Specifies the Ethernet IPv6 Address for the Ethernet port.
Type: Five (5) unsigned binary word (32-bit)
Data Range: See table.
Read/Write: R
Operational Settings: The IPv6 Prefix length indicates the network portion of an IPv6 address using the following format:
-
IPv6 address/prefix length
-
Prefix length can range from 0 to 128
-
Typical prefix length is 64
The following is an illustration of IPv6 addressing with IPv6 Prefix length of 64.
64 bits |
64 bits |
||||||
Prefix |
Interface ID |
||||||
Prefix 1 |
Prefix 2 |
Prefix 3 |
Subnet ID |
Interface ID 1 |
Interface ID 2 |
Interface ID 3 |
Interface ID 4 |
Example: 2002:c0a8:101:0:7c99:d118:9058:1235/64 |
|||||||
2002 |
C0A8 |
0101 |
0000 |
7C99 |
D118 |
9058 |
1235 |
Word 1 (Ethernet IPv6 Address (Prefix 1-2)) (ex:0xA8C0 0220 = 2002 C0A8) |
|||||||||||||||
D31 |
D30 |
D29 |
D28 |
D27 |
D26 |
D25 |
D24 |
D23 |
D22 |
D21 |
D20 |
D19 |
D18 |
D17 |
D16 |
Prefix 2 (ex: 0xA8C0 = C0A8) |
|||||||||||||||
D15 |
D14 |
D13 |
D12 |
D11 |
D10 |
D9 |
D8 |
D7 |
D6 |
D5 |
D4 |
D3 |
D2 |
D1 |
D0 |
Prefix 1 (ex: 0x0220 = 2002) |
|||||||||||||||
Word 2 (Ethernet IPv6 Address (Prefix 3/Subnet ID)) (ex:0x000 0101 = 0101 0000) |
|||||||||||||||
D31 |
D30 |
D29 |
D28 |
D27 |
D26 |
D25 |
D24 |
D23 |
D22 |
D21 |
D20 |
D19 |
D18 |
D17 |
D16 |
Subnet ID (ex: 0x0000 = 0000) |
|||||||||||||||
D15 |
D14 |
D13 |
D12 |
D11 |
D10 |
D9 |
D8 |
D7 |
D6 |
D5 |
D4 |
D3 |
D2 |
D1 |
D0 |
Prefix 3 (ex: 0x0101 = 0101) |
|||||||||||||||
Word 3 (Ethernet IPv6 Address (Interface ID 1-2)) (ex: 0x18D1 997C = 7C99 D118) |
|||||||||||||||
D31 |
D30 |
D29 |
D28 |
D27 |
D26 |
D25 |
D24 |
D23 |
D22 |
D21 |
D20 |
D19 |
D18 |
D17 |
D16 |
Interface ID 2 (ex: 0x18D1 = D118) |
|||||||||||||||
D15 |
D14 |
D13 |
D12 |
D11 |
D10 |
D9 |
D8 |
D7 |
D6 |
D5 |
D4 |
D3 |
D2 |
D1 |
D0 |
Interface ID 1 (ex: 0x997C = 7C99) |
|||||||||||||||
Word 4 (Ethernet IPv6 Address (Interface ID 3-4)) (ex: 0x3512 5890 = 9058 1235) |
|||||||||||||||
D31 |
D30 |
D29 |
D28 |
D27 |
D26 |
D25 |
D24 |
D23 |
D22 |
D21 |
D20 |
D19 |
D18 |
D17 |
D16 |
Interface ID 4 (ex: 0x3512 = 1235) |
|||||||||||||||
D15 |
D14 |
D13 |
D12 |
D11 |
D10 |
D9 |
D8 |
D7 |
D6 |
D5 |
D4 |
D3 |
D2 |
D1 |
D0 |
Interface ID 3 (ex: 0x5890 = 9058) |
|||||||||||||||
Word 5 (Ethernet IPv6 Prefix Length) (ex:0x0000 0040) |
|||||||||||||||
D31 |
D30 |
D29 |
D28 |
D27 |
D26 |
D25 |
D24 |
D23 |
D22 |
D21 |
D20 |
D19 |
D18 |
D17 |
D16 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
D15 |
D14 |
D13 |
D12 |
D11 |
D10 |
D9 |
D8 |
D7 |
D6 |
D5 |
D4 |
D3 |
D2 |
D1 |
D0 |
Prefix Length (ex: 0x0040 = 64) |
Interrupt Vector and Steering
Edit this on GitLab
When interrupts are enabled, the interrupt vector associated with the specific interrupt can be programmed (typically with a unique number/identifier) such that it can be utilized in the Interrupt Service Routine (ISR) to identify the type of interrupt. When an interrupt occurs, the contents of the Interrupt Vector registers is reported as part of the interrupt mechanism. In addition to specifying the interrupt vector, the interrupt can be directed (“steered”) to the native bus or to the application running on the onboard ARM processor.
Note
|
The Interrupt Vector and Interrupt Steering registers are mapped to the Motherboard Common Memory and these registers are associated with the Module Slot position (refer to Function Register Map). |
Interrupt Vector
Function: Set an identifier for the interrupt.
Type: unsigned binary word (32-bit)
Data Range: 0x0000 0000 to 0xFFFF FFFF
Read/Write: R/W
Initialized Value: 0
Operational Settings: When an interrupt occurs, this value is reported as part of the interrupt mechanism.
Interrupt Steering
Function: Sets where to direct the interrupt.
Type: unsigned binary word (32-bit)
Data Range: See table Read/Write: R/W
Initialized Value: 0
Operational Settings: When an interrupt occurs, the interrupt is sent as specified:
Direct Interrupt to VME |
1 |
Direct Interrupt to ARM Processor (via SerDes) (Custom App on ARM or NAI Ethernet Listener App) |
2 |
Direct Interrupt to PCIe Bus |
5 |
Direct Interrupt to cPCI Bus |
6 |
Module Control Command Registers
Edit this on GitLab
Function: Provides the ability to command individual Modules to Reset, Power-down, or Power-up.
Type: unsigned binary word (32-bit)
Data Range: 0x0000 0000 to 0xFFFF FFFF
Read/Write: R/W
Operational Settings: The Module Control Commands registers provide the ability to request individual Modules to perform one of the following functions – Reset, Power-down, Power-up. Only one command can be requested at a time per Module. For example, one can’t request a Reset and a Power-down at the same time for the same Module. Once the command is recognized and handled, the bit will be cleared.
Note
|
Clearing of the command request bit only indicates the command has been recognized and initiated, it does not indicate that the command action has been completed. |
There is one Control Command Request register per Module. Each register is Bit-mapped as shown in the table below:
Bit(s) |
Description |
D31:D3 |
Reserved |
D2 |
Module Power-up |
D1 |
Module Power-down |
D0 |
Module Reset |
Modules Health Monitoring Registers
Module Communications Status
Edit this on GitLab
Function: Provides the ability to monitor factors may effect communication status of a Module.
Type: unsigned binary word (32-bit)
Data Range: 0x0000 0000 to 0xFFFF FFFF
Read/Write: R
Operational Settings: The Module Communications registers provide the ability to monitor factors that may effect the Communications Status of individual Modules. There is one register per Module. Each communication factor is bit mapped to the register as shown in the table below:
Bit(s) |
Description |
D31:D5 |
Reserved |
D4 |
Module Communications Error Detected |
D3 |
Module Firmware Not Ready |
D2 |
Module LinkInit Not Done |
D1 |
Module Not Detected |
D0 |
Module Powered-down |
Module Powered-down: The user can request an individual Module be powered-down (see Module Control Command Requests). Once the request is detected and acted upon, this bit will be set. Once powered-down, you will not be able to communicate with the Module.
Module Not Detected: If a Module in this slot has not been detected, you will not be able to communicate with the Module.
Module LinkInit Not Done: Module communications is accomplished via SERDES. LinkInit is required to establish a connection to the Module. If the LinkInit has not been successfully completed, you will not be able to communicate with the Module.
Module Firmware Not Ready: Each Module has Firmware that is ready from Module QSPI and loaded for execution. If this Firmware was not loaded and started successfully, you may not be able to communicate with the Module.
Module Communications Error Detected: If at some point during run-time, communications with the Module has failed, this bit will be set.
Module BIT Status
Edit this on GitLab
Function: Provides the ability to monitor the individual Module BIT Status.
Type: unsigned binary word (32-bit)
Data Range: 0x0000 0000 to 0xFFFF FFFF
Read/Write: R
Operational Settings: The Module BIT Status registers provide the ability to monitor individual Module BIT results as Latched and current value. A 1 in any bit field indicates BIT failure for the Module in that slot.
Bit(s) |
Description |
D31:D19 |
Reserved |
D18 |
Module Slot 2 BIT Failure (current value) |
D17 |
Module Slot 1 BIT Failure (current value) |
D16 |
Reserved |
D15:D3 |
Reserved |
D2 |
Module Slot 2 BIT Failure - Latched |
D1 |
Module Slot 1 BIT Failure - Latched |
D0 |
Reserved |
Scratchpad Area
Edit this on GitLab
Function: Registers reserved as scratch pad for customer use.
Type: unsigned binary word (32-bit)
Data Range: 0x0000 0000 to 0xFFFF FFFF
Read/Write: R/W
Operational Settings: This area in memory is reserved for customer use.
MOTHERBOARD FUNCTION REGISTER MAP
Key:
Bold Underline = Measurement/Status/Board Information
Bold Italic = Configuration/Control
Module Information Registers
0x3FC |
Module Slot Addressing Ready |
R |
0x0400 |
Module Slot 1 Address |
R |
0x0404 |
Module Slot 2 Address |
R |
0x0430 |
Module Slot 1 Size |
R |
0x0434 |
Module Slot 2 Size |
R |
0x0460 |
Module Slot 1 ID |
R |
0x0464 |
Module Slot 2 ID |
R |
Hardware Information Registers
0x0020 |
Product Serial Number |
R |
0x0024 |
Platform |
R |
0x0028 |
Model |
R |
0x002C |
Generation |
R |
0x0030 |
Processor Count/Ethernet Count |
R |
0x0034 |
Maximum Module Slot Count/ARM Platform Type |
R |
Motherboard Firmware Information Registers
0x0100 |
MBCore Major/Minor Version |
R |
0x0104 |
MBCore Minor 2/3 Version |
R |
0x0108 |
MBCore Build Date |
R |
Motherboard Measurement Registers
Temperature Readings
0x0200 |
Current Zynq Temperatures |
R |
0x0204 |
Reserved |
R |
0x0208 |
Max Zynq Temperatures |
R |
0x020C |
Reserved |
R |
0x0210 |
Min Zynq Temperatures |
R |
0x0214 |
Reserved |
R |
Higher Precision Temperature Readings
0x0230 |
Current Zynq Core Temperature |
R |
0x0234 |
Current Motherboard PCB Temperature |
R |
Ethernet Configuration Registers
0x0070 |
Ethernet A MAC (Octets 1-4) |
R |
0x0074 |
Ethernet A MAC (Octets 5-6)/Misc Settings |
R |
0x0078 |
Ethernet A Interface Name (Bit 0-31) |
R |
0x007C |
Ethernet A Interface Name (Bit 32-63) |
R |
0x0080 |
Ethernet A IPv4 Address |
R |
0x0084 |
Ethernet A IPv4 Subnet Mask |
R |
0x0088 |
Ethernet A IPv4 Gateway |
R |
0x008C |
Ethernet A IPv6 Address (Prefix 1-2) |
R |
0x0090 |
Ethernet A IPv6 Address (Prefix 3/Subnet ID) |
R |
0x0094 |
Ethernet A IPv6 Address (Interface ID 1-2) |
R |
0x0098 |
Ethernet A IPv6 Address (Interface ID 3-4) |
R |
0x009C |
Ethernet A IPv6 Prefix Length |
R |
0x00A0 |
Ethernet B MAC (Octets 1-4) |
R |
0x00A4 |
Ethernet B MAC (Octets 5-6)/Misc Settings |
R |
0x00A8 |
Ethernet B Interface Name (Bit 0-31) |
R |
0x00AC |
Ethernet B Interface Name (Bit 32-63) |
R |
0x00B0 |
Ethernet B IPv4 Address |
R |
0x00B4 |
Ethernet B IPv4 Subnet Mask |
R |
0x00B8 |
Ethernet B IPv4 Gateway |
R |
0x00BC |
Ethernet B IPv6 Address (Prefix 1-2) |
R |
0x00C0 |
Ethernet B IPv6 Address (Prefix 3/Subnet ID) |
R |
0x00C4 |
Ethernet B IPv6 Address (Interface ID 1-2) |
R |
0x00C8 |
Ethernet B IPv6 Address (Interface ID 3-4) |
R |
0x00CC |
Ethernet B IPv6 Prefix Length |
R |
Interrupt Vector and Steering
0x0500 - 0x057C |
Module 1 Interrupt Vector 1 - 32 |
R/W |
0x0600 - 0x067C |
Module 1 Interrupt Steering 1 - 32 |
R/W |
0x0700 - 0x077C |
Module 2 Interrupt Vector 1 - 32 |
R/W |
0x0800 - 0x087C |
Module 2 Interrupt Steering 1 - 32 |
R/W |
Module Control Command Requests
0x01D8 |
Module Slot 1 Command Request |
R/W |
0x01DC |
Module Slot 2 Command Request |
R/W |
ETHERNET
Edit this on GitLab
(For detailed supplement, please visit the NAI web-site specific product page and refer to: Ethernet Interface for Generation 5 SBC and Embedded IO Boards Specification)
The Ethernet Interface Option allows communications and control access to all function modules either via the system BUS or Ethernet ports 1 or 2.
Ethernet 1 |
Ethernet 2 |
|
The default IP address: |
192.168.1.16 |
192.168.2.16 |
The default subnet: |
255.255.255.0 |
255.255.255.0 |
The default gateway: |
192.168.1.1 |
192.168.2.1 |
Note
|
Actual "as shipped" card Ethernet default IP addresses may vary based upon final ATP configuration(s).) Ethernet Port IP addresses may be field re-flashed to new default programmed addressed via use of the “IP Configuring for Ethernet Supported Boards” FLASH software support kit, available/documented from the specific product web page. |
The NAI interface supports IPv4 and IPv6 and both the TCP and UDP protocols. The Ethernet Operation Mode Command Listener application running on the motherboard host processor implements the operation interface. The listener is operational on startup through the nai_MBStartup process and listen on specific ports for commands to process. The default ports are listed below:
-
TCP1 - Port 52801
-
TCP2 - Port 52802
-
UDP1 - Port 52801
-
UDP2 - Port 52802
While the listener is active, note that interrupts from the motherboard do not trigger. The listener can be disabled by turning off the nai_MBStartup process through the Motherboard EEPROM. To turn off nai_MBStartup use the command mbeeprom_util set MBStartupInitOnlyFlag 1 in the console, either by serial port or telnet to the motherboard, and then reboot the system. To turn on the nai_MBStartup use the command mbeeprom_util set MBStartupInitOnlyFlag 0 in the console, either by serial port or telnet to the motherboard, and then reboot the system.
Ethernet Message Framework
The interface uses a specific message framework for all commands and responses. All messages begin with a Preamble code and end with a Postamble code. The message framework is shown below.
Preamble 2 bytes Always 0xD30F |
SequenceNo 2 bytes |
Type Code 2 byte |
Message Length (2 bytes) |
Payload (0..1414 bytes) |
Postamble 2 bytes Always 0xF03D |
Message Elements
Preamble |
The Preamble is used to delineate the beginning of a message frame. The Preamble is always 0xD30F. |
SequenceNo |
The SequenceNo is used to associate Commands with Responses. |
Type Code |
Type Codes are used to define the type of Command or Response the message contains. |
Message Length |
The Message Length is the number of bytes in the complete message frame starting with and including the Preamble and ending with and including the Postamble. |
Payload |
The Payload contains the unique data that makes up the command or response. Payloads vary based on command type. |
Postamble |
The Postamble is use to delineate the end of a message frame. The Postamble is always 0xF03D. |
Notes
-
The messaging protocol applies only to card products.
-
Messaging is managed by the connected (client) computer. The client computer will send a single message and wait for a reply from the card. Multiple cards may be managed from a single computer, subject to channel and computer capacity.
Board Addressing
The interface provides two main addressing areas: Onboard and Off-board.
Onboard addressing refers to accessing resources located on the board that is implementing the operation interface (including its modules).
Off-board addressing refers to accessing resources located on another board reachable via VME, PCI, or other bus. Off-board addressing requires a Master/Slave configuration.
The user must always specify if a particular address is Onboard or Off-board. See the command descriptions for the onboard and off-board flags.
Within a particular board (Onboard or Off-board), the address space is broken up into two areas: Motherboard Common Address Space and Module Address Space. All addresses are 32-bit.
Motherboard Common Address Space starts at 0x00000000 and ends at 0x00004000. This is a 4Kx32-bit address space (16 kbytes).
Module Address Space starts at 0x00004000. Module addressing is dynamically configured at startup. NAI boards support between 1 and 6 modules. The minimum module address space size is 4Kx32 (16 kbytes) and module sizes are always a multiple of 4Kx32.
Module addressing is dynamic and cumulative. The first detected module (starting with Slot 1) is given an address of 0x00004000. The 2nd detected Module is given an address of:
First_Detected_Module_Address + First_Detected_Module_Size
Note
|
Slots do not define addresses. |
If no module is detected in a module slot, that slot is not given an address. Therefore, if the first detected Module is in Slot 2, then that module address will be 0x00004000. If the next detected module is in Slot 4, then the address of that Module will be:
Second_Detected_Module_Address = First_Detected_Module_Address + First_Detected_Module_Size
If a 3rd Module is detected in Slot 6, then the address of that Module will be:
Third_Detected_Module_Address = Second_Detected_Module_Address + Second_Detected_Module_Size
Note
|
Module addresses are calculated at each board startup when the modules are detected. Therefore, if a module should fail to be detected due to malfunction or because it was removed from the motherboard, the addresses of the modules that follow it in the slot sequence will be altered. This is important to note when programming to this interface. |
Users can always retrieve the Module Addresses, Module Sizes and Module IDs from the fixed Motherboard Common address area. This data is set upon each board startup. While the Module Addressing is dynamic, the address where these addresses are stored is fixed. For example, to find the startup address of the module location in Slot 3, refer to the MB Common Address 0x00000408 from the Motherboard Common Addresses table that follows.
Ethernet Wiring Convention
RJ-45 Pin |
T568A Color |
T568B Color |
10/100Base-T |
1000BASE-T |
NAI wiring convention |
1 |
white/green stripe |
white/orange stripe |
TX+ |
DA+ |
ETH-TP0+ |
2 |
green |
orange |
TX- |
DA- |
ETH-TP0- |
3 |
white/orange stripe |
white/green stripe |
RX+ |
DB+ |
ETH-TP1+ |
4 |
blue |
blue |
DC+ |
ETH-TP2+ |
|
5 |
white/blue stripe |
white/blue stripe |
DC- |
ETH-TP2- |
|
6 |
orange |
green |
RX- |
DB- |
ETH-TP1- |
7 |
white/brown stripe |
white/brown stripe |
DD+ |
ETH-TP3+ |
|
8 |
brown |
brown |
DD- |
ETH-TP3- |
68G5E CONNECTOR/PIN-OUT INFORMATION
Front and Rear Panel Connectors
The 68G5E 3U OpenVPX Multifunction I/O board is available in two configurations: convection-cooled and conduction-cooled. The 68G5E follows the OpenVPX “Payload Slot Profile” configured as:
Slot profile: SLT3-SWH-16T-14.4.6 (GbE Switch Only Configuration)
SLT3-PER-1U-14.3.3 (GbE Switch w/1-MFIO Function)
Module profile: MOD3-PER-1U-16.3.3-2
User I/O is available through the OpenVPX user defined rear I/O connectors P1, P2 (see part number and pin-out information).
Panel LEDs
Front Panel LEDs indications (only available on air-cooled units).
LED |
ILLUMINATED |
EXTINGUISHED |
GRN: |
Blinking: Initializing Steady On: Power-On/Ready |
Power off |
RED: |
Module BIT error |
No BIT fault |
YEL: (flash) |
Card access (bus or Gig-E activity) |
No card activity |
Front I/O Utility Connector J5 (Convection and Conduction-Cooled)
The 68G5E utilizes a Mini-HDMI type card edge connector J5, available on either convection or conduction-cooled configurations that provides the following signals:
-
Serial (port 1)
-
USB-2.0
-
Ethernet port 1 (factory configuration option - Ethernet port1 may be redirected to rear I/O P1)
NAI also provides an optional “breakout” adapter board (NAI P/N 75SBC4-BB) with a mini-HDMI to mini-HDMI type cable. The “breakout” adapter board and a Micro-HDMI cable (NAI P/N 75SBC4-BB) allow for standard I/O connections to Ethernet and asynchronous serial (DB9). Consult the factory for availability.
Signal Descriptions J5
Signal Name |
Description |
ETH1-TPx |
Ethernet port 1 signals (4 pair) 10/100/1000 twisted pair signals (Optional - available only if NOT re-directed to rear I/O (see part number configuration options) |
USB-DP |
Front Panel USB Data Positive |
USB-DM |
Front Panel USB Data Minus |
SER1-TXD |
Asynchronous transmit serial data port 1 (out) / RS232 debug/console port only |
SER1-RXD |
Asynchronous received serial data port 1 (in) / RS232 debug/console port only |
GND |
System Ground (return) |
Rear I/O VPX Connectors P0-P2 (Conduction-Cooled)
The 68G5E 3U OpenVPX Ethernet Switch and Multifunction I/O board provides interface via the rear VPX connectors.
Rear I/O Summary
Signals defined as N/C currently have no functionality associated and are not required for general operation.
P0 - Utility plane. Contains the following signal definitions: |
|
Power: |
Primary +5V, +3.3V_AUX, +/- 12V and System GND |
Geographical Address Pins: |
GA0# - GA4#, GAP# |
Card reset: |
SYSRST# signal |
VPX AUX/REF CLK |
(Not used) |
P1 - Defined as primarily Data/Control Planes (User defined I/O secondary) |
|
High Speed Switched Fabric Interface: |
One ultra-thin pipe option (PCIe ver. 2.0 (x1) or SRIO (1x)). (MFIO Function only) |
Ethernet: |
Dual Gig-E port option(s) are available and defined (See Part Number Designation section) |
P2 - User defined I/O (primary) |
Rear I/O Utility Plane (P0)
The P0 (Utility) Plane contains the primary power, bus and utility signals for the OpenVPX board. Additionally, several of the user defined pins can be utilized for Geographical Addressing and a parallel SYSRST# signal. Signals defined as N/C currently have no functionality associated and is not required for general operation.
Rear I/O Data/Control Planes (P1)
The 68G5E has the configuration option for specifying a high-speed serial interface fabric bus connections - PCIe ver. 2.0 (x1). As defined in the OpenVPX bridge or payload slot specifications, the 68G5E requires only one 'ultra-thin pipe' (one Tx and one Rx differential pair), which provides additional user I/O definition opportunity. Additionally, the 68G5E can be commanded/controlled via dual port Gig-E (options for either 10/100/1000Base-T and/or 1000Base-KX (SerDes) Interfaces). Additional module I/O is also defined on the P1 user defined plane. Signals defined as N/C currently have no functionality associated or are considered optional and are not required for general operation.
USER I/O - Defined Area (User Defined I/O) (P2)
The following pages contain the 'user defined' I/O data area front and rear panel pin-outs with their respective signal designations for all module types currently offered/configured for the 68G5E platform. The card is designed to route the function module I/O signals to the front and rear I/O connector. The following I/O connector pin-out is based upon the function module designated in the module slot. Signals defined as N/C currently have no functionality associated or are considered optional and are not required for general operation.
Rear User I/O Mapping
Pin-out details (for reference) are shown below, with respect to DATAIO. Additional information on pin-outs can be found in the Module Operational Manuals.
Slot 1 |
||
Module Signal (Ref Only) |
Rear I/O P2 |
Global (MB) |
DATIO1 |
A09 |
|
DATIO2 |
B09 |
|
DATIO3 |
D09 |
|
DATIO4 |
E09 |
|
DATIO5 |
B10 |
|
DATIO6 |
C10 |
|
DATIO7 |
E10 |
|
DATIO8 |
F10 |
|
DATIO9 |
A11 |
|
DATIO10 |
B11 |
|
DATIO11 |
D11 |
|
DATIO12 |
E11 |
|
DATIO13 |
B12 |
|
DATIO14 |
C12 |
|
DATIO15 |
E12 |
|
DATIO16 |
F12 |
|
DATIO17 |
A13 |
|
DATIO18 |
B13 |
|
DATIO19 |
D13 |
|
DATIO20 |
E13 |
|
DATIO21 |
B14 |
|
DATIO22 |
C14 |
|
DATIO23 |
E14 |
|
DATIO24 |
F14 |
|
DATIO25 |
A15 |
|
DATIO26 |
B15 |
|
DATIO27 |
D15 |
|
DATIO28 |
E15 |
|
DATIO29 |
B16 |
|
DATIO30 |
C16 |
|
DATIO31 |
E16 |
|
DATIO32 |
F16 |
|
DATIO33 |
G09* |
|
DATIO34 |
G11* |
|
DATIO35 |
G13* |
|
DATIO36 |
G15* |
|
DATIO37 |
||
DATIO38 |
||
DATIO39 |
||
DATIO40 |
||
N/A |
SYS GND |
|
CHASSIS |
||
N/C |
*See Part Number Designator for availability
SYNCHRO/RESOLVER AND LVDT/RVDT SIMULATION MODULE CODE TABLES
Edit this on GitLab
Select the Digital-to-Synchro (DSx), Digital-to-Resolver (DRx) or Digital-to-LVDT/RVDT (DLx) module ID corresponding to the application operating parameters required from the following code table (where x = the specific module ID designator). Customer should indicate the actual frequency applicable the design to assure that the correct default band width is set at the factory. All Input and Reference voltages are auto ranging. Frequency/voltage band tolerances +/- 10%. For availability and ranges other than those listed contact the factory. Specifications may be subject to change.
-
Single Channel module pending availability (contact factory)
Module ID |
Format |
Channel(s) |
Output Voltage VL-L (Vrms) |
Reference Voltage (Vrms) |
Frequency Range (Hz) |
Power / CH maximum (VA) |
Notes |
DS1 |
SYN |
1* |
2 - 28 |
2 - 115 |
47 - 1 K |
3 |
|
DR1 |
RSL |
||||||
DL1 |
LVDT/RVDT |
||||||
DS2 |
SYN |
1* |
2 - 28 |
2 - 115 |
1 K - 5 K |
3 |
|
DR2 |
RSL |
||||||
DL2 |
LVDT/RVDT |
||||||
DS3 |
SYN |
1* |
2 - 28 |
2 - 115 |
5 K - 10 K |
3 |
|
DR3 |
RSL |
||||||
DL3 |
LVDT/RVDT |
||||||
DS4 |
SYN |
1* |
2 - 28 |
2 - 115 |
10 K - 20 K |
3 |
|
DR4 |
RSL |
||||||
DL4 |
LVDT/RVDT |
||||||
DS5 |
SYN |
1* |
28 - 90 |
2 - 115 |
47 - 1 K |
3 |
|
DR5 |
RSL |
||||||
DL5 |
LVDT/RVDT |
||||||
DSX |
SYN |
1* |
X |
X |
X |
X |
X = TBD; special configuration, requires special part number code designation, contact factory |
DRX |
RSL |
||||||
DLX |
LVDT/RVDT |
||||||
DSA |
SYN |
2 |
2 - 28 |
2 - 115 |
47 - 1 K |
1.5 |
|
DRA |
RSL |
||||||
DLA |
LVDT/RVDT |
||||||
DSB |
SYN |
2 |
2 - 28 |
2 - 115 |
1 K - 5 K |
1.5 |
|
DRB |
RSL |
||||||
DLB |
LVDT/RVDT |
||||||
DSC |
SYN |
2 |
2 - 28 |
2 - 115 |
5 K - 10 K |
1.5 |
|
DRC |
RSL |
||||||
DLC |
LVDT/RVDT |
||||||
DSD |
SYN |
2 |
2 - 28 |
2 - 115 |
10 K - 20 K |
1.5 |
|
DRD |
RSL |
||||||
DLD |
LVDT/RVDT |
||||||
DSE |
SYN |
2 |
28 - 90 |
2 - 115 |
47 - 1 K |
2.2 |
|
DRE |
RSL |
||||||
DLE |
LVDT/RVDT |
||||||
DSY |
SYN |
2 |
Y |
Y |
Y |
Y |
Y = TBD; special configuration, requires special part number code designation, contact factory |
DRY |
RSL |
||||||
DLY |
LVDT/RVDT |
||||||
DSJ |
SYN |
3 |
2 - 28 |
2 - 115 |
47 - 1 K |
0.5 |
|
DRJ |
RSL |
||||||
DLJ |
LVDT/RVDT |
||||||
DSK |
SYN |
3 |
2 - 28 |
2 - 115 |
1 K - 5 K |
0.5 |
|
DRK |
RSL |
||||||
DLK |
LVDT/RVDT |
||||||
DSL |
SYN |
3 |
2 - 28 |
2 - 115 |
5 K - 10 K |
0.5 |
|
DRL |
RSL |
||||||
DLL |
LVDT/RVDT |
||||||
DSM |
SYN |
3 |
2 - 28 |
2 - 115 |
10 K - 20 K |
0.5 |
|
DRM |
RSL |
||||||
DLM |
LVDT/RVDT |
||||||
DSN |
SYN |
3 |
28 - 90 |
2 - 115 |
47 - 1 K |
0.5 |
|
DRN |
RSL |
||||||
DLN |
LVDT/RVDT |
||||||
DSZ |
SYN |
3 |
Z |
Z |
Z |
Z |
Z = TBD; special configuration, requires special part number code designation, contact factory |
DRZ |
RSL |
||||||
DLZ |
LVDT/RVDT |
SYNCHRO/RESOLVER AND LVDT/RVDT MEASUREMENT MODULE CODE TABLES
SYN/RSL Four-Channel Measurement (Field Programmable SYN/RSL)
Select the Synchro/Resolver-to-Digital (SDx) module ID corresponding to the application operating parameters required from the following code table (where x = the specific module ID designator). Customer should indicate the actual frequency applicable to the design to assure that the correct default band width is set at the factory. All Input and Reference voltages are auto ranging. For availability and ranges other than those listed contact the factory. Specifications may be subject to change.
Frequency/voltage band tolerances +/- 10%.
Module ID |
Input Voltage V (Vrms) |
Reference Voltage (Vrms) |
Frequency Range (Hz) |
Notes |
SD1 |
2 - 28 |
2 - 115 |
47 - 1 K |
|
SD2 |
2 - 28 |
2 - 115 |
1K - 5 K |
|
SD3 |
2 - 28 |
2 - 115 |
5K - 10 K |
|
SD4* |
2 - 28 |
2 - 115 |
10K - 20 K |
|
SD5 |
28 - 90 |
2 - 115 |
47 - 1 K |
|
SDX* |
X |
X |
X |
X = TBD; special configuration, requires special part number code designation, contact factory |
*Consult factory for availability
LVDT/RVDT Four-Channel Measurement (Field Programmable 2, 3 or 4-Wire)
Select the LVDT/RVDT-to-Digital (LDx) module ID corresponding to the application operating parameters required from the following code table (where x = the specific module ID designator). Customer should indicate the actual frequency applicable to the design to assure that the correct default band width is set at the factory. All Input and Excitation voltages are auto ranging. For availability and ranges other than those listed contact the factory. Specifications may be subject to change.
Frequency/voltage band tolerances +/- 10%.
Module ID |
Input Signal Voltage V (Vrms) |
Excitation Voltage (Vrms) |
Frequency Range (Hz) |
Notes |
LD1 |
2 - 28 |
2 - 115 |
47 - 1 K |
|
LD2 |
2 - 28 |
2 - 115 |
1K - 5 K |
|
LD3 |
2 - 28 |
2 - 115 |
5K - 10 K |
|
LD4* |
2 - 28 |
2 - 115 |
10K - 20 K |
|
LD5 |
28 - 90 |
2 - 115 |
47 - 1 K |
|
LDX* |
X |
X |
X |
X = TBD; special configuration, requires special part number code designation, contact factory |
*Consult factory for availability
ES2 SWITCH CONFIGURATIONS & UTILITIES
Unless otherwise documented,
Default Configuration as shipped:
-
ES2 Port-1 is the only port which will be enabled. This allows GbE access for additional customer configuration or initialization after delivery. The RS-232 serial port is also available for console command configuration or initialization.
-
Switch IP Address: 12.0.0.1 / Subnet Mask: 255.0.0.0
The ES2 system supports different methods of accessing the switch, namely:
-
CLI (Command Line Interface using the serial port on the ES2)
-
Telnet, SSH (similar to CLI, but physical connection is an in-band Ethernet port)
-
HTTP (HyperText Transfer Protocol)
-
SNMP (Simple Network Management Protocol, which is an industry standard method of managing Ethernet networks)
Throughout this chapter, the management tool used is referenced as a standard Microsoft Windows-based “PC” running application software (e.g. terminal emulation or internet browser software).
Configuring the Management PC’s Ethernet Port
To allow each of the above-mentioned Ethernet configuration utilities to access the ES2, the PC’s Ethernet port must be configured properly. For example, if the ES2 default IP address was set to 12.0.0.1 with a subnet mask of 255.0.0.0, the management PC must be configured to operate within the same IP subnet.
Continuing with this example, the PC must now be configured to operate within this same IP subnet.
Set the IP address of the Network Interface Card on the PC to be within the same subnet. For example, set the PC’s IP address to be 12.0.0.20.
The various configuration utilities supported by ES2 allow the user to configure, manage, and monitor the ES2 switch. Overviews of the CLI, Telnet, SSH, HTTP, and SNMP methods of connecting to the Management Port are provided in this section of the manual.
Command Line Interface (CLI) Overview
Telnet/SSH Overview
Once the PC is configured to operate on the Management network, it is now possible to connect through the Ethernet port of the ES2 switch. To open a Telnet or SSH session, you can use applications such as Tera Term or simply a DOS Command window. Once the connection is established through this window, the Telnet or SSH session provides access to the CLI interface.
Note
|
The default ES2 login is root with password admin123. |
SNMP Overview
The Simple Network Management Protocol (SNMP) has proven to be a useful protocol for network management. Network administrators are well served by learning about SNMP and using this protocol to monitor and manage their networks. Although the SNMP standard is somewhat complex, entailing specific knowledge of MIB objects as well as requiring a large amount of configuration related to both SNMP agents and management software, the use of SNMP has been proven to be a cost-effective method of achieving a managed system.
There are many different software packages that can browse and manage MIB objects through the SNMP interface, and it is outside the scope of this manual to review them all.
Saving Configurations on Flash
Once the ES2 has been configured, it is possible to save the final configuration, and upon each subsequent reboot or power cycle the ES2 will initialize to this configuration.
These configuration settings may be saved though the Management Port interface and may be saved as many times as you choose.
Saving Configurations with CLI
Using the CLI interface, whether it is via the serial port or Telnet, the user must be logged on as administrator. As shown in “Telnet/SSH Overview", log in as username root and password admin123.
Assuming that the ES2 is completely configured and you would now like to save this configuration, from the command line type the following:
ES2# write startup-config
or
ES2# copy running-config startup-config
This utility saves the configuration onto the on-board Flash. Now every time the ES2 system is restarted, this base configuration will be re-invoked on the ES2.
To reset to factory defaults:
ES2# erase startup-config
Then power cycle the ES2 or reset the ES2 by typing the following:
ES2# reload
Command Line Interface
The CLI (Command Line Interface) is used to configure the ISS from a console attached to the serial port of the switch or from a remote terminal using TELNET or SSH.
The following table lists the generic CLI command modes.
Command Line Interface
Command Mode |
Access Method |
Prompt |
Exit method |
User EXEC |
This is the initial mode to start a session. |
es2> |
The logout method is used. |
Privileged EXEC |
The User EXEC mode command enable is used to enter the Privileged EXEC mode. |
es2# |
To return from the Privileged EXEC mode to User EXEC mode, the disable command is used. |
Global Configuration |
The Privileged EXEC mode command configure terminal is used to enter the Global Configuration mode |
es2(config)# |
To exit to the Privileged EXEC mode, the end command is used. |
Interface Configuration |
The Global Configuration mode command interface <interfacetype> <interfaceid> is used to enter the Interface configuration mode. |
es2(config-if)# |
To exit to the Global Configuration mode, the exit command is used and to exit to the Privileged EXEC mode, the end command is used. |
Config-VLAN |
The Global Configuration mode command vlan vlanid is used to enter the Config-VLAN mode |
es2(configvlan)# |
To exit to the Global Configuration mode, the exit command is used and to exit to the Privileged EXEC mode, the end command is used. |
Starting ISS
At the ISS login prompt that is displayed, use the user name root and password admin123 to access the CLI shell.
ISS login: root Password: ******** es2#
Configuring the Switch
The basic configuration of the switch involves configuring IP address, VLAN, and so on. All commands and parameters can be abbreviated to their shortest unambiguous length. On the command line, the TAB key may be used to display available command options and autocomplete commands. The 'help' command displays a list of commands.
The ES2 comes up with a VLAN configured, by default. This VLAN is called the default VLAN (VLAN ID = 1). All ports in the switch are members of the default VLAN. Port 1 (g 0/3) is enabled by default.
The ports are configured and referenced as <interface-type>[space]<slot number>/<port number>
<interface-type> is either “gigabitethernet” or “extreme-ethernet” and can be abbreviated as “g” or “e”.
<slot number> is 0.
<port number> is 3 to 18 for 1 Gb ports and 1 to 4 for 10Gb ports.
External port # | Internal nomenclature |
---|---|
1 |
(g)igabitethernet 0/3 |
2 |
g 0/4 |
3 |
g 0/5 |
4 |
g 0/6 |
5 |
g 0/7 |
6 |
g 0/8 |
7 |
g 0/9 |
8 |
g 0/10 |
9 |
g 0/11 |
10 |
g 0/12 |
11 |
g 0/13 |
12 |
g 0/14 |
13 |
g 0/15 |
14 |
g 0/16 |
15 |
g 0/17 |
16 |
g 0/18 |
10 Gb fiber optic |
|
1 |
(e)xtreme-ethernet 0/1 |
2 |
e 0/2 |
3 |
e 0/3 |
4 |
e 0/4 |
Examples
The interfaces in the switch except for port 1 are disabled by default. Hence, enable all the interfaces that are to be used. This is done using the no shutdown command.
To enable all 16 gigabit ethernet ports
es2# c t es2(config)# interface range g 0/3-18 es2(config-if-range)# no shutdown es2(config-if-range)# exit es2(config)# exit es2#
To disable port 2
es2# c t es2(config)# interf g 0/4 es2(config-if)# shutdown es2(config-if)# end es2#
To enable port 2
es2# c t es2(config)# interf g 0/4 es2(config-if)# no shut es2(config-if)# end es2#
To enable all 4 10 Gb fiber ports
es2# c t es2(config)# interf range e 0/1-4 es2(config-if-range)# no shut es2(config-if-range)# end es2#
To disable 10 Gb port 3:
es2# c t es2(config)# interf e 0/3 es2(config-if-range)# shut es2(config-if-range)# end es2#
To enable 10 Gb port 3:
es2# c t es2(config)# interf e 0/3 es2(config-if-range)# no shut es2(config-if-range)# end es2#
The show interfaces command displays the complete information of all available interfaces.
es2# show interfaces
A new VLAN can be configured using the following command. This command configures a new VLAN with VLAN ID 2.
es2# c t es2(config)# vlan 2
Configure Port1, Port2, and Port3 as member ports. Port 1 is specified as an untagged port and Port 2 and Port 3 are set as tagged ports for VLAN 2.
es2(config-vlan)# ports gig 0/3-5 untagged gig 0/3 es2(config-vlan)# exit
However, any untagged packets (packets sent from a PC/host) on any of the ports will be classified only to VLAN1. To ensure that untagged packets get classified onto a specific VLAN, it is required to change the port VLAN ID.
This is done using the following commands:
es2(config)# interface gig 0/3 es2(config-if)# switchport pvid 2 es2(config-if)# exit es2(config)# exit
Now untagged packets received on Port 1 will get classified to VLAN2. The ip address command can be used to configure the IP address of a VLAN interface.
es2# configure terminal es2(config)# interface vlan 2 es2(config-if)# ip address 30.0.0.1 255.0.0.0
The interface status must be up for the IP interface to be reachable from an external host/PC.
es2(config-if)# no shutdown es2(config-if)# exit es2#
The show ip interface vlan <vlan-identifier> configuration can be used to check whether the configuration is successful or not.
es2# show ip interface vlan 2
Saving and Restoring Configuration
The configuration made by the user can be saved in the Flash and can be restored when the switch is started.
es2# write startup-config
The configurations saved using write startup config command will not update the configurations in issnvram.txt (that is, it will not change the factory default settings). If the factory default settings need to be changed, administrator should explicitly modify it through default ip address command.
Configuring the Default IP Address
Configuring the Default IP Address is a three-step procedure that will result in the IP address to be written to the NVRAM and configuration and this will be used as the IP address of the default interface when the switch is restarted.
-
Execute the default ip address command.
-
Configure the ip address for vlan 1.
-
Save the configuration.
Detailed Steps:
1) Execute the following commands to configure the Default IP Address. Enter the Global Configuration mode.
es2# configure terminal
Configure the default IP address and subnet mask as 12.0.0.100 and 255.255.0.0, respectively.
es2(config)# default ip address 12.0.0.100 subnet-mask 255.255.0.0
Exit from the Global Configuration mode.
es2(config)# end
2) View the default IP address and subnet mask by executing the following command
es2# show nvram
Default IP Address : 12.0.0.1 Default Subnet Mask : 255.0.0.0 Default IP Address Config Mode : Manual Default IP Address Allocation Protocol : DHCP Switch Base MAC Address : 00:16:c6:ff:00:01 Default Interface Name : Gi0/3 Default RM Interface Name : NONE Config Restore Option : Restore Config Save Option : Startup save Auto Save : Disable Incremental Save : Disable Roll Back : Enable Config Save IP Address : 0.0.0.0 Config Save Filename : iss.conf Config Restore Filename : iss.conf PIM Mode : Sparse Mode IGS Forwarding Mode : MAC based Cli Serial Console : Yes SNMP EngineID : 80.00.08.1c.04.46.53
Proceed to section “Configuring IP address for an Interface” and set the same IP address and subnet mask for VLAN 1 (default VLAN). The switch will have this IP address and subnet mask after the switch restart only if the allocation method is manual.
Setting the Default IP Allocation Mode for the Switch
Setting the default IP allocation mode for the Switch configures the mode by which the default interface acquires its IP address. The default IP allocation mode for a switch can be manual or dynamic. The default value is manual.
1) Execute the following commands to change the default IP allocation mode of the default VLAN.
Enter the Global Configuration mode.
es2# configure terminal
Configure the default mode to dynamic.
es2(config)# default mode dynamic
Exit from the Global Configuration mode.
es2(config)# end
2) View the default mode by executing the following command.
es2# show nvram
Default IP Address : 12.0.0.1 Default Subnet Mask : 255.0.0.0 Default IP Address Config Mode : Dynamic Default IP Address Allocation Protocol : DHCP Switch Base MAC Address : 00:01:02:03:04:01 Default Interface Name : Gi0/1 Config Restore Option : No restore Config Save Option : No save Auto Save : Enable Incremental Save : Disable Roll Back : Enable Config Save IP Address : 0.0.0.0 Config Save Filename : iss.conf Config Restore Filename : iss.conf PIM Mode : Sparse Mode IGS Forwarding Mode : MAC based Cli Serial Console : Yes SNMP EngineID : 80.00.08.1c.04.46.53
ISS uses the dynamic address allocation protocols - BOOTP or DHCP or RARP - to acquire the IP for management VLAN during switch restart.
Configuring Default IP Address Allocation Protocol
Configuring the default IP address allocation protocol configures the protocol by which the default interface dynamically acquires its IP address.
1) Execute the following commands to configure the default dynamic address allocation protocol.
Enter the Global Configuration mode.
es2# configure terminal
Configure the default allocation protocol.
es2(config)# default ip address allocation protocol dhcp
Exit from the Global Configuration mode.
es2(config)# end
2) View the default IP Address Allocation Protocol by executing the following command
es2# show nvram
Default IP Address : 12.0.0.100 Default Subnet Mask : 255.255.0.0 Default IP Address Config Mode : Dynamic Default IP Address Allocation Protocol : DHCP Switch Base MAC Address : 00:01:02:03:04:01 Default Interface Name : Gi0/1 Config Restore Option : No restore Config Save Option : No save Auto Save : Enable Incremental Save : Disable Roll Back : Enable Config Save IP Address : 0.0.0.0 Config Save Filename : iss.conf Config Restore Filename : iss.conf PIM Mode : Sparse Mode IGS Forwarding Mode : MAC based Cli Serial Console : Yes SNMP EngineID : 80.00.08.1c.04.46.53
Configuring IP Address for an Interface
Configuring IP address for an Interface configures the IP address which will be used for sending and receiving the packets.
1) Execute the following commands to configure an IP address for a VLAN interface. Enter the Global Configuration mode.
es2# configure terminal
Enter the Interface Configuration mode.
es2(config)# interface vlan 1
Shut down the VLAN interface.
es2(config-if)# shutdown
Configure the IP address and subnet mask.
es2(config-if)# ip address 12.0.0.100 255.0.0.0
Bring up the VLAN interface.
es2(config-if)# no shutdown
Exit from the Interface Configuration mode.
es2(config)# end
Configuring the IP address for an Interface requires the interface to be shutdown prior to the configuration.
2) View the configured interface IP address by executing the following show command.
es2# show ip interface
Vlan1 is up, line protocol is up Internet Address is 12.0.0.100/8 Broadcast Address 10.255.255.255
3) Save the configuration
es2# wr st
Configuring an Interface to Acquire Dynamic IP
An interface can be configured to acquire the dynamic IP address either from DHCP or from RARP. The default value is DHCP.
1) Execute the following commands to acquire dynamic IP for VLAN 1 through DHCP.
Enter the Global Configuration mode.
es2# configure terminal
Enter the Interface Configuration mode.
es2(config)# interface vlan 1
Configure the VLAN interface to dynamically acquire an IP address through the Dynamic Host Configuration Protocol
es2(config-if)# ip address dhcp
Exit from configuration mode.
es2(config)# end
2) View the configured IP address by executing the following show command.
es2# show ip interface
Vlan1 is up, line protocol is up Internet Address is 12.0.0.1/8 Broadcast Address 10.255.255.255 IP address allocation method is dynamic IP address allocation protocol is dhcp
A DHCP server must exist in the network to allocate dynamic IP through DHCP mechanism.
Industry Standard CLI (Command Line Interface)
CLI commands are focused on performing specific operations. In order to provide a consistent, composable user experience, the CLI commands of the ES2 protocols and IP implementation solutions adhere to the Industry Standard CLI syntax.
The following table provide a listing and identification of which CLI commands are supported.
NAI Reference ONLY |
Package Details (NAI Reference ONLY) |
NAI |
|||||
CLI Volume No: |
Chapter No: |
Chapter Title |
Work Group |
Enterprise |
Metro |
Metro_E |
ES2 Support |
1 |
1 |
Introduction |
NA |
NA |
NA |
NA |
|
2 |
Command Line Interface |
NA |
NA |
NA |
NA |
||
3 |
System Commands |
Y |
Y |
Y |
Y |
YES |
|
4 |
System Features |
Y |
Y |
Y |
Y |
YES |
|
5 |
VCM |
N |
Y |
Y |
N |
YES |
|
6 |
RADIUS |
Y |
Y |
Y |
Y |
YES |
|
7 |
TACACS |
Y |
Y |
Y |
Y |
YES |
|
8 |
SSH |
Y |
Y |
Y |
Y |
YES |
|
9 |
SSL |
Y |
Y |
Y |
Y |
YES |
|
10 |
SNTP |
Y |
Y |
Y |
Y |
YES |
|
11 |
SNMPv3 |
Y |
Y |
Y |
Y |
YES |
|
12 |
Syslog |
Y |
Y |
Y |
Y |
YES |
|
13 |
TCP |
Y |
Y |
Y |
Y |
YES |
|
14 |
UDP |
Y |
Y |
Y |
N |
YES |
|
15 |
PoE |
Y |
Y |
Y |
N |
NO |
|
16 |
L2 DHCP Snooping |
Y |
Y |
Y |
Y |
NO |
|
17 |
IPDB |
Y |
Y |
Y |
Y |
YES |
|
2 |
18 |
STP |
Y |
Y |
Y |
Y |
YES |
19 |
LA |
Y |
Y |
Y |
Y |
YES |
|
20 |
LLDP |
Y |
Y |
Y |
Y |
YES |
|
21 |
PNAC |
Y |
Y |
Y |
Y |
YES |
|
22 |
MRP |
Y |
Y |
Y |
Y |
NO |
|
23 |
ELMI |
N |
N |
Y |
Y |
NO |
|
24 |
ELPS |
N |
N |
Y |
Y |
NO |
|
25 |
ERPS |
N |
N |
Y |
Y |
NO |
|
26 |
PBB |
N |
N |
Y |
Y |
NO |
|
27 |
PBB-TE |
N |
N |
Y |
Y |
NO |
|
3 |
28 |
VLAN |
Y |
Y |
Y |
Y |
YES |
29 |
ECFM |
N |
N |
Y |
Y |
NO |
|
30 |
IPSecv6 |
Y |
Y |
Y |
Y |
NO |
|
31 |
VRRP |
N |
Y |
N |
Y |
NO |
|
4 |
32 |
IP |
Y |
Y |
Y |
Y |
YES |
33 |
IPV6 |
Y |
Y |
Y |
Y |
YES |
|
34 |
OSPF |
N |
Y |
N |
Y |
YES |
|
35 |
OSPFv3 |
N |
Y |
N |
Y |
YES |
|
36 |
RRD |
N |
Y |
N |
Y |
YES |
|
37 |
RRD6 |
N |
Y |
N |
Y |
YES |
|
38 |
MPLS - General Commands |
N |
Y |
Y |
Y |
NO |
|
MPLS - LDP Signaling |
N |
Y |
Y |
Y |
NO |
||
MPLS - RSVP Signaling |
N |
Y |
Y |
Y |
NO |
||
MPLS - OAM |
N |
N |
Y |
Y |
NO |
||
MPLS - LSPping |
N |
N |
Y |
Y |
NO |
||
MPLS - L3VPN |
N |
N |
Y |
Y |
NO |
||
39 |
BFD |
N |
N |
Y |
Y |
NO |
|
40 |
Route Map |
N |
Y |
N |
Y |
YES |
|
41 |
NAT |
N |
Y |
N |
Y |
YES |
|
5 |
42 |
DHCP |
Y |
Y |
Y |
Y |
YES |
43 |
DHCPv6 |
Y |
Y |
Y |
Y |
YES |
|
44 |
RIP |
N |
Y |
N |
Y |
YES |
|
45 |
RIPv6 |
N |
Y |
N |
Y |
YES |
|
46 |
BGP |
N |
Y |
N |
Y |
NO |
|
47 |
ISIS |
N |
Y |
N |
Y |
NO |
|
6 |
48 |
IGMP Snooping |
Y |
Y |
Y |
Y |
YES |
49 |
MLD Snooping |
Y |
Y |
Y |
Y |
YES |
|
50 |
IGMP |
N |
Y |
Y |
N |
YES |
|
51 |
IGMP Proxy |
Y |
Y |
Y |
Y |
YES |
|
52 |
PIM |
N |
Y |
N |
Y |
YES |
|
53 |
PIMV6 |
N |
Y |
N |
Y |
YES |
|
54 |
DVMRP |
N |
Y |
N |
Y |
NO |
|
55 |
IPv4 Multicasting |
N |
Y |
N |
Y |
YES |
|
56 |
TAC |
Y |
N |
N |
Y |
YES |
|
57 |
RMON |
Y |
Y |
Y |
Y |
YES |
|
58 |
RMON2 |
Y |
Y |
Y |
Y |
NO |
|
59 |
DSMON |
Y |
Y |
Y |
Y |
NO |
|
60 |
EOAM |
Y |
Y |
Y |
Y |
YES |
|
61 |
FM |
Y |
Y |
Y |
Y |
YES |
|
62 |
RM |
N |
Y |
Y |
Y |
NO |
|
63 |
PTP |
Y |
Y |
Y |
Y |
NO |
|
64 |
Layer 4 Switching |
Y |
Y |
Y |
Y |
YES |
|
7 |
65 |
DCB |
Y |
Y |
N |
Y |
NO |
66 |
MLDv2 |
N |
Y |
N |
Y |
YES |
|
67 |
MSDP |
N |
Y |
N |
Y |
NO |
|
68 |
MSDP6 |
N |
Y |
N |
Y |
NO |
|
69 |
FIREWALL |
N |
Y |
N |
Y |
YES |
|
70 |
VPN |
N |
Y |
Y |
Y |
YES |
|
71 |
DNS |
Y |
Y |
Y |
Y |
YES |
|
72 |
Security |
N |
Y |
N |
Y |
YES |
|
73 |
Security - FIPS |
Y |
Y |
Y |
N |
YES |
|
74 |
TLM |
N |
Y |
Y |
Y |
NO |
|
75 |
OSPF-TE |
N |
Y |
Y |
Y |
NO |
|
76 |
TRILL |
N |
Y |
N |
Y |
NO |
|
77 |
SyncE |
Y |
Y |
Y |
Y |
NO |
|
78 |
MEF |
N |
N |
Y |
Y |
NO |
|
79 |
OFCL |
N |
N |
N |
Y |
NO |
|
80 |
Clock IWF |
Y |
Y |
Y |
Y |
YES |
|
81 |
PPP_Draft |
N |
Y |
N |
Y |
NO |
|
82 |
VXLAN |
N |
N |
N |
Y |
NO |
|
83 |
HEART BEAT |
N |
N |
N |
Y |
NO |
|
84 |
ICCH |
Y |
Y |
Y |
Y |
YES |
|
8 |
85 |
BCM |
Y |
Y |
Y |
Y |
YES |
86 |
Marvell XCAT |
Y |
Y |
Y |
Y |
NO |
|
87 |
Fulcrum_Draft |
NA |
NA |
NA |
NA |
(Reference ONLY) |
|
88 |
Marvell 6095_Draft |
NA |
NA |
NA |
NA |
(Reference ONLY) |
|
89 |
Wintegra_Draft |
NA |
NA |
NA |
NA |
(Reference ONLY) |
|
90 |
Dx-167 |
NA |
NA |
NA |
NA |
(Reference ONLY) |
|
91 |
Other Targets_Draft |
NA |
NA |
NA |
NA |
(Reference ONLY) |
|
92 |
QoSX_Draft |
NA |
NA |
NA |
NA |
(Reference ONLY) |
|
93 |
Vitesse |
NA |
NA |
NA |
NA |
(Reference ONLY) |
Revision History
Module Manual - ES2 Revision History |
||
Revision |
Revision Date |
Description |
C |
2021-11-03 |
C08845, Initial Release |
C1 |
2022-09-30 |
ECO C09691, Pg.12, added 'es2# c t'. Pg.12, changed 'gigbabitethernet 0/1' to 'es2(config-vlan)# ports gig 0/3-5 untagged gig 0/3'. Pg.12, changed 'interface gigabitethernet 0/1' to 'gig 0/3'. |
NAI Cares
Edit this on GitLab
North Atlantic Industries (NAI) is a leading independent supplier of Embedded I/O Boards, Single Board Computers, Rugged Power Supplies, Embedded Systems and Motion Simulation and Measurement Instruments for the Military, Aerospace and Industrial Industries. We accelerate our clients’ time-to-mission with a unique approach based on a Configurable Open Systems Architecture™ (COSA®) that delivers the best of both worlds: custom solutions from standard COTS components.
We have built a reputation by listening to our customers, understanding their needs, and designing, testing and delivering board and system-level products for their most demanding air, land and sea requirements. If you have any applications or questions regarding the use of our products, please contact us for an expedient solution.
Please visit us at: www.naii.com or select one of the following for immediate assistance:
Revision History
Motherboard Manual - 68G5E Revision History |
Revision |
Revision Date |
Description |
C |
2022-08-01 |
ECO C09496, initial release of 68G5E motherboard manual. |
C1 |
2022-11-23 |
ECO C09858, pg.6, reformatted Features bullets. Pg.6, corrected low-end commercial temp. Pg.8, changed number of selectable functions from 2 to 1. |
NAI Cares
Edit this on GitLab
North Atlantic Industries (NAI) is a leading independent supplier of Embedded I/O Boards, Single Board Computers, Rugged Power Supplies, Embedded Systems and Motion Simulation and Measurement Instruments for the Military, Aerospace and Industrial Industries. We accelerate our clients’ time-to-mission with a unique approach based on a Configurable Open Systems Architecture™ (COSA®) that delivers the best of both worlds: custom solutions from standard COTS components.
We have built a reputation by listening to our customers, understanding their needs, and designing, testing and delivering board and system-level products for their most demanding air, land and sea requirements. If you have any applications or questions regarding the use of our products, please contact us for an expedient solution.
Please visit us at: www.naii.com or select one of the following for immediate assistance: