INTRODUCTION

As a leading manufacturer of smart function modules, NAI offers over 100 different modules that cover a wide range of I/O, measurements and simulation, communications, Ethernet switch, and SBC functions. Our serial communications smart function modules provide high-speed, programmable RS-232/RS-422/RS-485, isolated or non-isolated, communication channels. Each channel has one transmit and one receive signal pair (±) as applicable. This user manual is designed to help you get the most out of our serial communications smart function module.

For a brief description of the module and complete list of specifications, click here for the SC6 data sheet.

SC6 Overview

NAI’s SC6 module offers a range of features designed to suit a variety of system requirements, including:

Four Communication Channels: The SC6 module offers up to four high-speed, programmable, individually non-isolated communication channels supporting RS232 (single-ended, SC) and RS-422/485 (differential, DF) protocols. These channels can be configured as four asynchronous (async) channels or four synchronous (sync) channels.

Data Rates: Asynchronous (ASYNC) to 1.5 Mbps, Synchronous (SYNC) to 10 Mbps (high resolution baud rates)

SYNC Clock or General-Purpose Output In SYNC Mode, the module automatically configures the clock (CLK) signals on the associated channel. in ASYNC Mode, the CLK signals can be configured as general-purpose outputs (GPOs) for user-defined purposes.

Data Transfer Efficiency: For asynchronous communications, data transfers occur within just two baud clocks, ensuring rapid data exchange. Synchronous communications achieve efficient data transfers in as little as 15 baud clocks.

Digital Noise Filtering: The SC6 module features digital noise filtering on receivers, enhancing signal quality and reliability.

Receiver Control: Users can selectively enable or disable specific receivers, providing fine-grained control over the communication channels.

Common API/Register memory map with NAI SC3 module: The SC6 module shares a common API and register memory map with the SC3 module, simplifying integration and development for users familiar with the SC3.

Buffer Capacity: The module boasts 1MB receive and transmit buffers, ensuring ample storage for data transfer.

Built-in Test: The SC6 module comes with a built-in test feature, simplifying diagnostics and maintenance.

PRINCIPLE OF OPERATION

Each channel of the module can be individually software configured for RS-232C, RS-422 or RS-485 Asynchronous/Synchronous Serial Communications. See table below for more specific pinouts between modes. The architecture avoids latency problems because all data transfer is done in hardware and not in software. Any incoming data, no matter how many channels are active, in whatever mode, can be immediately extracted. FPGA design simplifies programming and usage.

-RS232RS232 AsyncRS422/485 Diff-SyncRS422/485 Diff-Async
RxDLo - 1RXD - 1RXD - 1RXDLO - 1RXDLO - 1
RxDHi - 1n/a-RXDHI - 1RXDHI - 1
TxDLo -1TXD - 1TXD - 1TXDLO - 1TXDLO - 1
TxDHi - 1n/a-TXDHI - 1TXDHI - 1
...----
RxDLo - 3RXD - 3RXD - 3RXDLO - 1RXDLO - 1
RxDHi - 3n/a-RXDHI - 1RXDHI - 1
TxDLo - 3TXD - 3TXD - 3TXDLO - 1TXDLO - 1
TxDHi - 3n/a-TXDHI - 1TXDHI - 1
...----

Configuration

Before the user can write to any configuration register, certain steps must be followed to ensure the module accepts the user specified configuration. The steps are as follows:

  1. Write a 0 to the Enable Channel bit of the Tx-Rx Configuration register to tell the hardware that we are about to change the configuration.

  2. Wait for the Channel Configured status of the Realtime Channel Status registers to read a 0.

  3. Write all desired configuration registers.

  4. Set the Enable Channel bit of the Tx-Rx Configuration register to 1 to notify the hardware that it can read all the configuration registers.

  5. Wait for the Channel Configured status in the Realtime Channel Status register to read a 1 before proceeding to send/receive data.

Async/Sync Modes

All four channels can be configured in asynchronous mode or synchronous modes. Mixing asynchronous and synchronous modes is also possible.

Gap Timeout Status

The Gap Timeout Occurred status gets set when there’s data in a channel’s receive buffer but there’s no activity on a channel’s receiver for approximately three byte-times. To use the Gap Timeout feature, set the Enable Gap Timeout bit in the Tx-Rx Configuration register to a 1. When receiving asynchronous data, monitor the Gap Timeout status bit of the Channel Status register to know if a timeout occurred. The status is cleared after all the data in the receive buffer is read or cleared.

Serial Built-In Test/Diagnostic Capability

The SC6 module supports two types of built-in tests: Power-On and Initiated. The results of these tests are logically ORed together and stored in the BIT Dynamic Status and BIT Latched Status registers.

Power-on Self-Test (POST)/Power-on BIT (PBIT)/Start-up BIT (SBIT)

The power-on self-test is performed on each channel automatically when power is applied and report the results in the BIT Status register when complete. After power-on, the Power-on BIT Complete register should be checked to ensure that POST/PBIT/SBIT test is complete before reading the BIT Dynamic Status and BIT Latched Status registers.

Initiated Built-In Test

The Initiated Built-In Test (IBIT) is an internal loopback available for each channel of the SC6 module. The test is initiated by setting the bit for the associated channel in the Test Enabled register or (for legacy applications) setting the Initiate BIT bit of the Tx-Rx-Configuration register to a 1. Prior to initiating the test, the user must disable the channel, and its respective pair, by writing a 0 to the Enable Channel bit of the channel’s TxRx Configuration register. BIT will not run if the channel is enabled. After the user disables the channel and initiates BIT, they must wait a minimum of 5 msec then check to see if the bit for the associated channel in the Test Enabled register or (for legacy application) Initiate BIT bit of the Tx-Rx-Configuration register reads a 0. When the SC6 clears the bit, it means that the test has completed, and its results can be checked. If the bit has not cleared after 10ms, the test has timed out and not run. In the event this should occur, the user should verify that the channel, and its pair, has been disabled. The results of the IBIT is stored in the BIT Dynamic Status and BIT Latched Status registers, a 0 indicates that the channel has passed and a 1 indicates that it failed.

Receiver Enable/Disable

A Receiver Enable/Disable function allows the user to turn selected receivers ON/OFF. When a receiver is disabled, no data will be placed in the buffer.

Serial Data Transmit Enhancement

An additional asynchronous mode to support “Immediate Transmit” operation has been incorporated. This mode immediately transmits serial data anytime the transmit buffer is not empty. There is no requirement to set the Tx Initiate bit before each transmission, which simplifies system traffic and overhead, since only the actual data byte being transmitted needs be sent to the transmit buffer. Each channel has its own configurable Transmit and Receive buffer. The upper byte of each received word provides status information for that word.

The transmitter and receivers of up to 32 channels can be tied together in either Half or Full-Duplex mode. While in Multi-Drop Link Mode, the transmit line for each channel will automatically tri-state. When data in the transmit buffer is initiated, the transmitter will be taken out of tri-state and send the data. Once transmission is completed, the transmit line is automatically changed back to tri-state mode.

To program the serial channel for Multi-Drop mode, the interface level must be set to RS485, and the Tristate Transmit Line bit in the Channel Control register must be set to a 1.

Communication Module Factory Defaults: Registers and Delays

Address Recognition:Off
Baud Rate:9600
CTS/RTS:Disabled
Protocol:0, Asynchronous
Interface Levels:5 (Tri-state mode)
Termination Character:0x0003h
Interrupt Level:0
Interrupt Vector:0x00
Mode:Asynchronous
Number of Data Bits:8
Parity:Disabled
Receivers:Disabled
Transmit Buffer Word Count:0
Receive Buffer Word Count:0
Receive Buffer, Almost Full:0xFFF9B
Stop Bits:1
Transmit Buffer, Almost Empty:0x0064
Tx-Rx Configuration:0
Channel Control:0
Data Configuration:0x0108
Preamble:0
Receive Buffer High Watermark:0xFFF9B
Receive Buffer Low Watermark:0x0800h
XON:0x0011h
XOFF:0x0013h
XON/XOFF:Disabled
Time Out Value:0x9C40

A write to the following registers takes place immediately:

  • Transmit Data

  • Channel Control

  • Channel Interrupt Enable

  • Channel Interrupt Edge/Level

  • Summary Interrupt Enable

  • Summary Edge/Level

  • Interrupt Vector

  • Interrupt Steering

For all other registers, channel configuration protocol must be followed.

Status and Interrupts

The SC6 Serial Communications Function Module provide registers that indicate faults or events. Refer to “Status and Interrupts Module Manual” for the Principle of Operation description.

Module Common Registers

The SC6 Serial Communications Function Module provide module common registers that provide access to module-level bare metal/FPGA revisions & compile times, unique serial number information, and temperature/voltage/current monitoring. Refer to “Module Common Registers Module Manual” for the detailed information.

REGISTER DESCRIPTIONS

The register descriptions provide the register name, Type, Data Range, Read or Write information, Initialized Value, a description of the function and, in most cases, a data table.

Receive Registers

Serial data received are placed in the Receive FIFO Buffer register. The Receive FIFO Buffer Word Count provide the count of the number of elements in the Receive FIFO Buffer. The Receive FIFO Buffer Almost Full, Receive FIFO Buffer High Watermark and Receive FIFO Buffer Low Watermark registers provide the ability to specify the thresholds for the associated status in the Channel FIFO Status register.

Receive FIFO Buffer
Function:Received data is placed in this buffer.
Type:unsigned binary word (32-bit).
Data Range:0x 0000 0000 to 0x 0000 FFFF
Read/Write:R
Initialized Value:N/A
Operational Settings:Data is received is based on Protocol.
Asynchronous
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
0000000000000000
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
PEPE000EOFPDDDDDDDDD
Bi-Synchronous/Mono-Synchronous
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
0000000000000000
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
00000EOF0DDDDDDDDD
HDLC
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
0000000000000000
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
0BOF0ER1ER1ER0EOF0DDDDDDDD
Asynchronous
PE= Parity ErrorA 1 indicates the calculated parity does not match the received parity bit.
FE= Framing ErrorA 1 indicates a framing error was detected.
EOF= End of FrameA 1 indicates an ETx character was received. Termination Character Detection must be turned on.
P= Parity BitThis bit carries the parity bit of the last received character.
Bi-Synchronous/Mono-Synchronous
EOF= End of FrameA 1 indicates the End of Frame. Useful to identify multiple frames in large buffer.
HDLC
BOF= Beginning of FrameA 1 indicates first character of frame. Useful to identify multiple frames in large buffer.
EOF= End of FrameA 1 indicates End of Frame. Useful to identify multiple frames in large buffer.
ER2:ER0= Last Frame Status000 = Good Frame + 111 = CRC Error
Receive FIFO Buffer Word Count
Function:Contains the number of words in the Receive FIFO Buffer waiting to be read back.
Type:unsigned binary word (32-bits)
Data Range:0 to 0x0010 0000 (Buffer Size)
Read/Write:R
Initialized Value:0
Operational Settings:Reads Integers.
Receive FIFO Buffer Almost Full
Function:Specifies the maximum size, in bytes, of the receive buffer before the Receive FIFO Almost Full Status bit D0 in the FIFO Status register is flagged (High True).
Type:unsigned binary word (32-bits)
Data Range:0 to 0x0010 0000 (Buffer Size)
Read/Write:R/W
Initialized Value:1048475 (0x000F FF9B)
Operational Settings:If the interrupt is enabled (see Interrupt Enable register), a System interrupt will be generated.
Receive FIFO Buffer High Watermark
Function:Defines the Receive Buffer High Watermark value.
Type:unsigned binary word (32-bits)
Data Range:Low Watermark < High Watermark < 0xFFF9B
Read/Write:R/W
Initialized Value:1048475 (0xFFF9B)
Operational Settings:When Receive Buffer size equals the High Watermark value, the High Watermark bit in both the FIFO Status and Channel Status registers is set to a 1 and: * If XON/XOFF is enabled, XOFF is sent. The Watermark registers are used for XON/XOFF flow control. The Receive Buffer High Watermark register value controls when the XOFF character is sent when using software flow control and controls when the RTS signal would be negated when using hardware flow control. For software flow control operation, the XOFF character would be sent once when the number of bytes in the Receive FIFO Buffer equals the value in the Receive Buffer High Watermark register. Once the XOFF has been sent, it cannot be sent again until the XON character has been sent. The valid state transitions to sending the XOFF character can be either no previous XON/XOFF character sent or a previous XON character sent. There is also a High Watermark Reached interrupt enable/disable bit in the Channel Interrupt Enable register and a High Watermark Reached bit in the Channel Interrupt Status Register. When the High Watermark is reached, an interrupt request will be generated, when the interrupt enable/disable bit is enabled.
Receive FIFO Buffer Low Watermark
Function:Defines the Receive Buffer Low Watermark value.
Type:unsigned binary word (32-bits)
Data Range:0 < Low Watermark < High Watermark < 0xFFF9B
Read/Write:R/W
Initialized Value:2048 (0x0800) When the Receive FIFO Buffer size is less than the Low Watermark value, the Low Watermark bit in both the FIFO Status and Channel Status registers is set to a 1 and: * If XON/XOFF is enabled, XON is sent. The Watermark registers are used for XON/XOFF flow control. The Receive Buffer Low Watermark register value controls when the XON character is sent when using software flow control and controls when the RTS signal would be asserted when using hardware flow control. For software flow control operation, the XON character would be sent once when the number of bytes in the Receive FIFO Buffer equals the value in the Receive Buffer Low Watermark register AND an XOFF character has been sent prior to this XON character. The valid state transition to sending the XON character can only be from the state of a previous XOFF character that has been sent. There is a Low Watermark Reached interrupt enable/disable bit in the Channel Interrupt Enable register and a Low Watermark Reached bit in the Channel Interrupt Status register. When the Low Watermark is reached, an interrupt request will be generated, when the interrupt enable/disable bit is enabled.

Transmit Registers

Serial data to be transmitted are placed in the Transmit FIFO Buffer register. The Transmit FIFO Buffer Word Count provides the count of the number of elements in the Transmit FIFO Buffer. The Receive FIFO Buffer Almost Empty register provide the ability to specify the threshold for the associated status in the Channel FIFO Status register.

Transmit FIFO Buffer
Function:Data to be transmitted is placed in this buffer prior to transmission.
Type:unsigned binary word (32-bits)
Data Range:0x 0000 0000 to 0x 0000 01FF
Read/Write:W
Initialized Value:Not Applicable (NA)
Operational Settings:Data words are 8-bit and occupy the register's lowest significant bits (LSBs), or low byte.
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
0000000000000000
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
0000000D1DDDDDDDD

Note1: Data only in Asynchronous mode when data bits are set to 9.

Transmit FIFO Buffer Word Count
Function:Contains the number of words in the Transmit FIFO Buffer waiting to be transmitted.
Type:unsigned binary word (32-bits)
Data Range:0 to 0x0010 0000 (Buffer Size)
Read/Write:R
Initialized Value:0
Transmit FIFO Buffer Almost Empty
Function:Specifies the minimum size, in bytes, of the transmit buffer before the Transmit Buffer Almost Empty Status bit D1 in the FIFO Status register is flagged (High True).
Type:unsigned binary word (32-bits)
Data Range:0 to 0x0010 0000 (Buffer Size)
Read/Write:R/W
Initialized Value:100 (0x64)
Operational Settings:If the interrupt is enabled (see Interrupt Enable register), a System interrupt will be generated.

Configuration Registers

SC6 configurations includes setting the Interface Levels, Baud Rate, Protocol, Tx-Rx Configuration and if applicable, the Termination Character registers. Additional registers need to be configured specifically for Async or Sync modes.

Interface Levels
Function:Configures the interface level (RS-232, RS-422, RS-485, Loopback, Tri-State, FPGA Loop-Back) for the associated channel.
Type:unsigned binary word (32-bits)
Data Range:See table
Read/Write:R/W
Initialized Value:5 (Tri-State)
Operational Settings:Loopback selection connects the channel's transmit and receive line internally. To implement, user must send data and look at Receive FIFO to verify that the sent data was received. Loopback is usually used for testing. Notes: Channels are programmed for loopback in pairs. For example, if channel 1 is programmed for loopback, then channel 2 will be also. This includes channels 3 and 4.
Bit(s)InterfaceDescription
D31:D8ReservedSet Reserved bits to 0.
D7Disable termination resistorDisables termination resistor in-between the differential pairs of the transmitter and the receiver. Useful for RS485 Multi-Drop.
D6:D3ReservedSet Reserved bits to 0.
D2:D0Interface LevelThese bits set the interface level: (0:0:0) RS232 ` (0:1:0) RS422 ` (0:1:1) RS485 ` (1:0:0) Loopback ` (1:0:1) Tri-State
Baud Rate
Function:Sets the baud rate for communications.
Type:unsigned binary word (32-bits)
Data Range:300 bps to 10 Mbps Sync (1.5 Mbps Async)
Read/Write:R/W
Initialized Value:9600 bps
Protocol
Function:Configures the associated channel for either asynchronous, mono-synchronous, bi-synchronous or HDLC mode.
Type:unsigned binary word (32-bits)
Data Range:See table
Read/Write:R/W
Initialized Value:0 (Asynchronous)
Operational Settings:See table below.
Bit(s)ProtocolDescription
D31:D6ReservedSet Reserved bits to 0.
D5:D00x00 - Async ` 0x01 - Mono-Synchronous ` 0x02 - Bi-Synchronous + 0x03 - HDLCSets the desired protocol mode for the associated channel.
Tx-Rx Configuration
Function:Sets the transmit/receive configuration for the associated channel.
Type:unsigned binary word (32-bits)
Data Range:See table
Read/Write:R/W
Initialized Value:0
Operational Settings:BIT - Set Enable Channel bit, D24 low (0) to clear the selected channel. Set Initiate BIT bit D27 high (1) to initiate BIT. After 5 msec, a 0 should be read, which indicates that the BIT test is complete. The BIT Status register reports the channel status.
Bit(s)NameDescription
D31:D28ReservedSet Reserved bits to 0.
D27Initiate BITWrite a 1 to start built-in-test. The channel running BIT needs to be disabled, as well as it's channel pair. For common module functionality see the Test Enabled register.
D26Invert RTS/GPOSet Reserved bits to 0.
D25Reserved0 = Normal + 1 = Invert.
D24Enable Channel0 = Disable + 1 = Enable.
D23Rx Suppression0 = Receiver Always On + 1 = Receiver Off During Transmission (RS485 only)
D22ReservedSet Reserved bits to 0.
D21Idle FlagIdle Flag (0x7E) Transmission
D20Enable Gap Timeout0 = Ignore gap timeout + 1 = Set Gap Timeout Occurred status when there is no activity on the receiver's bus for more than 3-byte times.
D19Append CRC0 = No CRC + 1 = Append CRC to Tx Data, Expect CRC with Rx data
D18:D17CRC(0:0) 16-Bit CRC (Mono/Bi-Sync only) ` (0:1) 32-Bit CRC (HDLC only) ` (1:0) 16-Bit CCITT
D16CRC Reset Value0 = Ones + 1 = Zeros
D15Timeout DetectionTurns on timeout detection
D14XON/XOFF Char as Data0 = Stripped + 1 = Keep in data
D13XON/XOFF Flow ControlTurns on Software Flow Control
D12Termination Character Detection0 = Ignore termination character + 1 = Set Rx Complete/ETx Received status bit when termination character is received.
D11Sync char as data0 = Stripped + 1 = Keep in data
D10:D8ReservedSet Reserved bits to 0.
D7Address Length0 = 8 bits + 1 = 16 bits
D6:D4Address Transmission/Recognition (HLDC only): 0x0 - Addressing Off ` 0x1 - Rx Address Recognition only ` 0x2 - Tx Address Transmission only + 0x4 - Addressing OnAddressing Off: Don't send address, receive data from any address. ` Rx Address Recognition: Expect address on Rx, but don't send address. ` Tx Address Transmission: Send address, but don't expect it. + Addressing On: Send and expect address.
D3-D0ReservedSet Reserved bits to 0.
Termination Character
Function:Contains the termination character used for termination detection.
Type:unsigned character (usually a member of the ASCII data set)
Data Range:0x00 to 0xFF
Read/Write:R/W
Initialized Value:0x03
Operational Settings:When using the Asynchronous or Mono/Bi-Synchronous modes, the receive data stream is monitored for the occurrence of the termination character. When this character is detected, the Rx COMPLETE / ETx RECEIVED bit is set in the Channel Status register, an interrupt is generated, if enabled.

Async Only Configuration

In Async mode, additional configurations include setting the Data Configuration, Time Out Value, XOFF Character and XON Character registers.

Data Configuration
Function:Channel data configuration.
Type:unsigned binary word (32-bits)
Data Range:See table
Read/Write:R/W
Initialized Value:0x108
Operational Settings:Sets up the Serial channel configuration.
Bit(s)NameDescription
D31:D15ReservedSet Reserved bits to 0.
D14:D12EncodingThe following sets the Data Encoding: (0:0:0) No Encoding (NRZ) ` (1:1:0) Manchester (GE Thomas) ` (1:1:1) Manchester (IEEE 802.3)
D11:D10ReservedSet Reserved bits to 0.
D9:D8Stop BitsThe following sets the number of stop bits: (0:1) 1 Stop bit + (1:0) 2 Stop bits
D7ReservedSet Reserved bits to 0.
D6:D4ParityThe following sets the Parity: (0:0:0) No Parity ` (0:0:1) Space Parity ` (0:1:0) Reserved ` (0:1:1) Odd Parity ` (1:0:0) Reserved ` (1:0:1) Even Parity ` (1:1:1) Mark Parity
D3:D0Number of Data BitsActual number of data bits between 5 and 9. For Asynchronous Protocol only.
Time Out Value
Function:Determines the timeout period.
Type:unsigned binary word (32-bits)
Data Range:0 to 0xFFFF
Read/Write:R/W
Initialized Value:0x9C40 (1 second)
Operational Settings:If there is no receive line activity for the configured period of time, a timeout is indicated in the Interrupt Status register, bit D10. LSB is 25µs. Modes Affected: Async.
XON Character
Function:Specifies the XON character for asynchronous flow control mode.
Type:unsigned binary word 32-bits (usually a member of the ASCII data set)
Data Range:0x00 to 0xFF
Read/Write:R/W
Initialized Value:0x11
Modes Affected:Async
Operational Settings:When software flow control is enabled, this value is sent as the XON character.
XOFF Character
Function:Specifies the XOFF character for asynchronous software flow control mode.
Type:unsigned binary word 32-bits (usually a member of the ASCII data set)
Data Range:0x00 to 0xFF
Read/Write:R/W
Initialized Value:0x13
Modes Affected:Async
Operational Settings:When software flow control is enabled, this value is sent as the XOFF character.

Sync Only Configuration

In Sync mode, additional configurations include setting the Clock Mode, HDLC Rx Address/Sync Character and HDLC Tx Address/Sync Character registers.

Clock Mode
Function:Configures clock for internal (driven) or external (received) transmit/receive clocks
Type:unsigned binary word (32-bits)
Data Range:See table
Read/Write:R/W
Initialized Value:0
Operational Settings:Applicable only for Mono/bi-synchronous or HDLC as set by Protocol register.
Default:0
Bit(s)NameDescription
D31:D8ReservedSet Reserved bits to 0.
D7Invert Rx ClockSwap receive clock edge.
D6Invert Tx ClockSwap transmit clock edge.
D5Tristate Clock after Tx
D4:D3ReservedSet Reserved bits to 0.
D2:D00x0: Internal ` 0x1: External ` 0x2: Reserved + 0x3: ReservedInternal: Module always drives clock. + External: Module always receives clock.
HDLC Rx Address/Sync Character
Function:Mode dependent for HDLC and Synchronous modes. See Operational Settings.
Type:unsigned binary word (32-bits)
Data Range:0x0000 to 0xFFFF
Read/Write:R/W
Initialized Value:0xA5
Operational Settings:HDLC Mode: This value is compared to the address of the received message and if it's equal, the message is stored in the receive buffer. Mono/Bi-Synchronous Mode: this value is considered the “Sync Character” and is used for communication synchronization. The receiver searches incoming data for the Sync Character. Once found, communication is synchronized, and additional data is valid. When in Bi- Synchronous, low byte is sent before high byte.
HDLC
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
0000000000000000
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
000000008-bit address when Address Length bit in Tx-Rx Configuration register is 0.
16-bit address when Address Length bit in Tx-Rx Configuration register is 1.
Mono-Synchronous
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
0000000000000000
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
000000008-bit synchronization character
Bi-Synchronous
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
0000000000000000
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
Second 8-bit synchronization characterFirst 8-bit synchronization character
HDLC Tx Address/Sync Character
Function:Mode dependent for HDLC and Synchronous modes. See Operational Settings.
Type:unsigned binary word (32-bits)
Data Range:0x0000 to 0xFFFF
Read/Write:R/W
Initialized Value:0xA5
Operational Settings:If using HDLC Mode: this value is compared to the address of the received message and if it's equal, the message is stored in the receive buffer. Mono/Bi-Synchronous Mode: this value is considered the “Sync Character” and is used for communication synchronization. The receiver searches incoming data for the Sync Character. Once found, communication is synchronized, and additional data is valid. When in Bi- Synchronous, low byte is sent before high byte.
Preamble
Function:Determines the number of preambles and the preamble pattern sent during a preamble transmission.
Type:unsigned binary word (32-bits)
Data Range:0x0000 to 0xF0FF
Read/Write:R/W
Initialized Value:0
Operational Settings:In HDLC Mode: zero-bit insertion is disabled during preamble transmission.
Bit(s)NameDescription
D31:D16ReservedSet Reserved bits to 0.
D15:D12Number of PreamblesThe number of Preamble Patterns to be sent.
D11:D8ReservedSet Reserved bits to 0.
D7:D0Preamble PatternActual data byte to be sent.

Control Register

The Channel Control register provides control of the serial channel.

Channel Control
Function:Channel control configuration.
Type:unsigned binary word (32-bits)
Data Range:See table.
Read/Write:R/W
Initialized Value:0
Operational Settings:Real time control of the Serial channel.
Bit(s)NameDescription
D31:D19ReservedSet Reserved bits to 0.
D18Enable Receiver
D17Tx Always (Async Only)Transmit data as soon as data is buffered.
D16Tx InitiateTransmit data in Tx buffer. (The data bit is cleared when all data from the Tx Buffer is transmitted)
D15Clear Tx FIFOClear all data in the Tx FIFO. The data bit is self-clearing.
D14Clear Rx FIFOClear all data in the Rx FIFO. The data bit is self-clearing.
D13Reset Channel FIFOs & UARTClear both FIFOs and reset channel. Bit is not self-clearing.
D12:D11ReservedSet Reserved bits to 0.
D10Set/Release Break0 = Break not set + 1 = Pull transmitter low
D9ReservedSet Reserved bits to 0.
D8Tristate Transmit LineTristate the transmit line after transmitting, for use with RS485 Multi-Drop mode.
D7:D2ReservedSet Reserved bits to 0.
D1GPO 2General purpose output two control.
D0RTS/GPO 1*General purpose output one control.

Note

*RTS/CTS as GPO when RTS/CTS Flow Control disabled.

Serial Test Register

The serial module provides the ability to run an initiated test (IBIT). Writing a 1 to the bit associated with the channel in the Test Enabled register.

Note

this register has the same effect as writing a 1 to the Initiate BIT bit of the Tx-Rx Configuration register for legacy applications.

Test Enabled
Function:Set the bit corresponding to the channel you want to run Initiated Built-In-Test.
Type:unsigned binary word (32-bit)
Data Range:0 to 0x0000 000F
Read/Write:R/W
Initialized Value:0x0
Operational Settings:Set bit to 1 for channel to run an Initiated BIT test. Failures in the BIT test are reflected in the BIT Status registers for the corresponding channels that fail. In addition, an interrupt (if enabled in the BIT Interrupt Enable register) can be triggered when the BIT testing detects failures. Bit is self-clearing.
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
0000000000000000
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
000000000000Ch4Ch3Ch2Ch1

Module Common Registers

Refer to “Module Common Registers Module Manual” for the register descriptions.

Status and Interrupt Registers

The SC6 Module provides status registers for BIT, Channel, Summary and Channel FIFO.

BIT Status

There are four registers associated with the BIT Status: Dynamic Status, Latched Status, Interrupt Enable, and Set Edge/Level Interrupt.

BIT Status
Function:Sets the corresponding bit associated with the channel's BIT error.
Type:unsigned binary word (32-bits)
Data Range:0x0000 0000 to 0x0000 000F
Read/Write:R (Dynamic), R/W (Latched, Interrupt Enable, Edge/Level Interrupt)
Initialized Value:0
BIT Dynamic Status
BIT Latched Status
BIT Interrupt Enable
BIT Set Edge/Level Interrupt
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
0000000000000000
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
000000000000Ch4Ch3Ch2Ch1

Power-on BIT (PBIT) Complete

After power-on, the Power-on BIT Complete register should be checked to ensure that POST/PBIT/SBIT test is complete before reading the BIT Dynamic Status and BIT Latched Status registers.

Power-on BIT (PBIT) Complete
Function:Indication if Power-on BIT has completed.
Type:unsigned binary word (32-bits)
Data Range:0x0000 0000 to 0x0000 0001
Read/Write:R
Initialized Value:0
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
0000000000000000
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
000000000000000PBIT Complete
Channel Status
Function:Sets the corresponding bit associated with each event type. There are separate registers for each channel.
Type:unsigned binary word (32-bits)
Data Range:See table.
Read/Write:R (Dynamic), R/W (Latched, Interrupt Enable, Set Edge/Level Interrupt)
Initialized Value:0
Channel Dynamic Status
Channel Latched Status
Channel Interrupt Enable
Channel Set Edge/Level Interrupt
Bit(s)NameConfigurableDescription
D31Channel ConfiguredNoModule is configured and ready to operate.
D30Built-in-Self Test PassedNoIndicates the status of the last ran IBIT test.
D29:D18ReservedNoSet Reserved bits to 0.
D17Gap Timeout OccurredYesRx FIFO has data in it, but there hasn't been activity on the bus in 3-byte times.
D16:D12ReservedNoSet Reserved bits to 0.
D11Break/AbortNoBreak recognized.
D10Timeout OccurredYesNo receive line activity within timeout value.
D9Tx CompleteNoWhile transmitting, Tx FIFO count reaches zero.
D8Tx FIFO Almost EmptyYesTransmit FIFO Almost Empty Threshold reached.
D7Low Watermark ReachedYesRx Buffer Low Watermark Threshold reached.
D6High Watermark ReachedYesRx Buffer High Watermark Threshold reached.
D5Rx OverrunNoData was received while the Rx FIFO was full.
D4Rx Data AvailableNoReceive FIFO count is greater than zero.
D3Rx Complete/ET x ReceivedNoAsync: Termination character received (Only if termination detection is turned on.) ` HDLC: End of frame flag detected. ` Mono/Bi-Sync: Termination character received.
D2CRC Error (Sync & HDLC)NoCRC calculation did not match.
D1Rx FIFO Almost FullYesReceive FIFO Almost Full Threshold
D0Parity ErrorNoParity bit did not match.

Note

For the Latched Channel Status register, the interrupts are cleared when a 1 is written to the specific bit.

Channel FIFO Status
Function:Describes current FIFO Status.
Type:unsigned binary word (32-bits)
Data Range:See Table
Read/Write:R
Initialized Value:0
Operational Settings:See Rx Almost Full, Tx Almost Empty, Rx High Watermark and Rx Low Watermark specific registers for function description and programming.
Bit(s)NameConfigurable?Description
D5Tx FIFO FullNoTx FIFO has reached maximum buffer size.
D4Rx FIFO EmptyNoRx FIFO count is zero.
D3Low Watermark ReachedYesRx Buffer Low Watermark Threshold reached.
D2High Watermark ReachedYesRx Buffer High Watermark Threshold reached.
D1Tx FIFO Almost EmptyYesTx FIFO Almost Empty Threshold reached.
D0Rx FIFO Almost FullYesRx FIFO Almost Full Threshold reached.
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
0000000000000000
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
0000000000DDDDDD
Summary Status
Function:Sets the corresponding bit associated with the channel that has data available to receive in its Receive FIFO Buffer.
Type:unsigned binary word (32-bits)
Data Range:0x0000 0000 to 0x0000 000F
Read/Write:R (Dynamic), R/W (Latched, Interrupt Enable, Set Edge/Level Interrupt)
Initialized Value:0
Summary Dynamic Status
Summary Latched Status
Summary Interrupt Enable
Summary Set Edge/Level Interrupt
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
0000000000000000
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
000000000000Ch4Ch3Ch2Ch1

Interrupt Vector and Steering

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 VME1
Direct Interrupt to ARM Processor (via SerDes) +
(Custom App on ARM or NAI Ethernet Listener App)
2
Direct Interrupt to PCIe Bus5
Direct Interrupt to cPCI Bus6

FUNCTION REGISTER MAP

KEY

Incoming Data
Outgoing Data
Configuration/Control
Status
RECEIVE REGISTERS
NOTE: Base Address - 0x4000 0000
OFFSETREGISTER NAMEACCESSOFFSETREGISTER NAMEACCESS
0x1004Receive FIFO Buffer Ch 1R0x100CReceive FIFO Buffer Word Count Ch 1R
0x1084Receive FIFO Buffer Ch 2R0x108CReceive FIFO Buffer Word Count Ch 2R
0x1104Receive FIFO Buffer Ch 3R0x110CReceive FIFO Buffer Word Count Ch 3R
0x1184Receive FIFO Buffer Ch 4R0x118CReceive FIFO Buffer Word Count Ch 4R
0x1034Receive FIFO Buffer Almost Full Ch 1R/W0x1038Receive FIFO Buffer High Watermark Ch 1R/W
0x10B4Receive FIFO Buffer Almost Full Ch 2R/W0x10B8Receive FIFO Buffer High Watermark Ch 2R/W
0x1134Receive FIFO Buffer Almost Full Ch 3R/W0x1138Receive FIFO Buffer High Watermark Ch 3R/W
0x11B4Receive FIFO Buffer Almost Full Ch 4R/W0x11B8Receive FIFO Buffer High Watermark Ch 4R/W
0x103CReceive FIFO Buffer Low Watermark Ch 1R/W
0x10BCReceive FIFO Buffer Low Watermark Ch 2R/W
0x113CReceive FIFO Buffer Low Watermark Ch 3R/W
0x11BCReceive FIFO Buffer Low Watermark Ch 4R/W
TRANSMIT REGISTERS
NOTE: Base Address - 0x4000 0000
OFFSETREGISTER NAMEACCESSOFFSETREGISTER NAMEACCESS
0x1000Transmit FIFO Buffer Ch 1W0x1008Transmit FIFO Buffer Word Count Ch 1R
0x1080Transmit FIFO Buffer Ch 2W0x1088Transmit FIFO Buffer Word Count Ch 2R
0x1100Transmit FIFO Buffer Ch 3W0x1108Transmit FIFO Buffer Word Count Ch 3R
0x1180Transmit FIFO Buffer Ch 4W0x1188Transmit FIFO Buffer Word Count Ch 4R
0x1030Transmit FIFO Buffer Almost Empty Ch 1R/W
0x10B0Transmit FIFO Buffer Almost Empty Ch 2R/W
0x1130Transmit FIFO Buffer Almost Empty Ch 3R/W
0x11B0Transmit FIFO Buffer Almost Empty Ch 4R/W
CONFIGURATION REGISTERS
NOTE: Base Address - 0x4000 0000
OFFSETREGISTER NAMEACCESSOFFSETREGISTER NAMEACCESS
0x1018Interface Levels Ch 1R/W0x1028Baud Rate Ch 1R/W
0x1098Interface Levels Ch 2R/W0x10A8Baud Rate Ch 2R/W
0x1118Interface Levels Ch 3R/W0x1128Baud Rate Ch 3R/W
0x1198Interface Levels Ch 4R/W0x11A8Baud Rate Ch 4R/W
0x1010Protocol Ch 1R/W0x101CTx-Rx Configuration Ch 1R/W
0x1090Protocol Ch 2R/W0x109CTx-Rx Configuration Ch 2R/W
0x1110Protocol Ch 3R/W0x111CTx-Rx Configuration Ch 3R/W
0x1190Protocol Ch 4R/W0x119CTx-Rx Configuration Ch 4R/W
0x1050Termination Character Ch 1R/W
0x10D0Termination Character Ch 2R/W
0x1150Termination Character Ch 3R/W
0x11D0Termination Character Ch 4R/W
ASYNC ONLY CONFIGURATION REGISTERS
NOTE: Base Address - 0x4000 0000
0x1024Data Configuration Ch 1R/W0x1054Time Out Value Ch 1R/W
0x10A4Data Configuration Ch 2R/W0x10D4Time Out Value Ch 2R/W
0x1124Data Configuration Ch 3R/W0x1154Time Out Value Ch 3R/W
0x11A4Data Configuration Ch 4R/W0x11D4Time Out Value Ch 4R/W
0x1048XON Character Ch 1R/W0x104CXOFF Character Ch 1R/W
0x10C8XON Character Ch 2R/W0x10CCXOFF Character Ch 2R/W
0x1148XON Character Ch 3R/W0x114CXOFF Character Ch 3R/W
0x11C8XON Character Ch 4R/W0x11CCXOFF Character Ch 4R/W
SYNC ONLY CONFIGURATION REGISTERS
NOTE: Base Address - 0x4000 0000
0x1014Clock Mode Ch 1R/W0x1040HDLC Rx Address/Sync Character Ch 1R/W
0x1094Clock Mode Ch 2R/W0x10C0HDLC Rx Address/Sync Character Ch 2R/W
0x1114Clock Mode Ch 3R/W0x1140HDLC Rx Address/Sync Character Ch 3R/W
0x1194Clock Mode Ch 4R/W0x11C0HDLC Rx Address/Sync Character Ch 4R/W
0x1044HDLC Tx Address/Sync Character Ch 1R/W0x102CPreamble Ch 1R/W
0x10C4HDLC Tx Address/Sync Character Ch 2R/W0x10ACPreamble Ch 2R/W
0x1144HDLC Tx Address/Sync Character Ch 3R/W0x112CPreamble Ch 3R/W
0x11C4HDLC Tx Address/Sync Character Ch 4R/W0x11ACPreamble Ch 4R/W
CONTROL REGISTERS
NOTE: Base Address - 0x4000 0000
OFFSETREGISTER NAMEACCESSOFFSETREGISTER NAMEACCESS
0x1020Channel Control Ch 1R/W
0x10A0Channel Control Ch 2R/W
0x1120Channel Control Ch 3R/W
0x11A0Channel Control Ch 4R/W
MODULE COMMON REGISTERS
Refer to “Module Common Registers Module Manual” for the Module Common Registers Function Register Map.
++``+
STATUS REGISTERS*
*When an event is detected, the bit associated with the event is set in this register and will remain set until the user clears the event bit. Clearing the bit requires writing a 1 back to the specific bit that was set when read (i.e., write-1-to-clear, writing a “1” to a bit set to “1” will set the bit to “0).
NOTE: Base Address - 0x4000 0000
OFFSETREGISTER NAMEACCESSOFFSETREGISTER NAMEACCESS
0x0800BIT Dynamic StatusR
0x0804BIT Latched Status*R/W
0x0808BIT Interrupt EnableR/W
0x080CBIT Set Edge/Level InterruptR/W
0x02A8Test EnabledR/W0x02ACPower-on BIT Complete++R/W
NOTE: ++After power-on, Power-on BIT Complete should be checked before reading the BIT Latched Status.
Channel 1 StatusChannel 2 Status
0x0810Dynamic StatusR0x0820Dynamic StatusR
0x0814Latched Status*R/W0x0824Latched Status*R/W
0x0818Interrupt EnableR/W0x0828Interrupt EnableR/W
0x081CSet Edge/Level InterruptR/W0x082CSet Edge/Level InterruptR/W
Channel 3 StatusChannel 4 Status
0x0830Dynamic StatusR0x0840Dynamic StatusR
0x0834Latched Status*R/W0x0844Latched Status*R/W
0x0838Interrupt EnableR/W0x0848Interrupt EnableR/W
0x083CSet Edge/Level InterruptR/W0x084CSet Edge/Level InterruptR/W
FIFO StatusSummary Status
0x1058Channel 1 StatusR0x09A0Dynamic StatusR
0x10D8Channel 2 StatusR0x09A4Latched Status*R/W
0x1158Channel 3 StatusR0x09A8Interrupt EnableR/W
0x11D8Channel 4 StatusR0x09ACSet Edge/Level InterruptR/W
INTERRUPT REGISTERS
The Interrupt Vector and Interrupt Steering registers are located on the Motherboard Memory Space and do not require any Module Address Offsets. These registers are accessed using the absolute addresses listed in the table below.
OFFSETREGISTER NAMEACCESSOFFSETREGISTER NAMEACCESS
0x0500Module 1 Interrupt Vector 1 - BITR/W0x0600Module 1 Interrupt Steering 1 - BITR/W
0x0504Module 1 Interrupt Vector 2 - Channel Status Ch 1R/W0x0604Module 1 Interrupt Steering 2 - Channel Status Ch 1R/W
0x0508Module 1 Interrupt Vector 3 - Channel Status Ch 2R/W0x0608Module 1 Interrupt Steering 3 - Channel Status Ch 2R/W
0x050CModule 1 Interrupt Vector 4 - Channel Status Ch 3R/W0x060CModule 1 Interrupt Steering 4 - Channel Status Ch 3R/W
0x0510Module 1 Interrupt Vector 5 - Channel Status Ch 4R/W0x0610Module 1 Interrupt Steering 5 - Channel Status Ch 4R/W
0x0514 to 0x0564Module 1 Interrupt Vector 6 to 26 - ReservedR/W0x0614 to 0x0664Module 1 Interrupt Steering 6 to 26 - ReservedR/W
0x0568Module 1 Interrupt Vector 27 - Summary StatusR/W0x0668Module 1 Interrupt Steering 27 - Summary StatusR/W
0x056C to 0x057CModule 1 Interrupt Vector 28 to 32 - ReservedR/W0x066C to 0x067CModule 1 Interrupt Steering 28 to 32 - ReservedR/W
0x0700Module 2 Interrupt Vector 1 - BITR/W0x0800Module 2 Interrupt Steering 1 - BITR/W
0x0704Module 2 Interrupt Vector 2 - Channel Status Ch 1R/W0x0804Module 2 Interrupt Steering 2 - Channel Status Ch 1R/W
0x0708Module 2 Interrupt Vector 3 - Channel Status Ch 2R/W0x0808Module 2 Interrupt Steering 3 - Channel Status Ch 2R/W
0x070CModule 2 Interrupt Vector 4 - Channel Status Ch 3R/W0x080CModule 2 Interrupt Steering 4 - Channel Status Ch 3R/W
0x0710Module 2 Interrupt Vector 5 - Channel Status Ch 4R/W0x0810Module 2 Interrupt Steering 5 - Channel Status Ch 4R/W
0x0714 to 0x0764Module 2 Interrupt Vector 6 to 26 - ReservedR/W0x0814 to 0x0864Module 2 Interrupt Steering 6 to 26 - ReservedR/W
0x0768Module 2 Interrupt Vector 27 - Summary StatusR/W0x0868Module 2 Interrupt Steering 27 - Summary StatusR/W
0x076C to 0x077CModule 2 Interrupt Vector 28 to 32 - ReservedR/W0x086C to 0x087CModule 2 Interrupt Steering 28 to 32 - ReservedR/W
0x0900Module 3 Interrupt Vector 1 - BITR/W0x0A00Module 3 Interrupt Steering 1 - BITR/W
0x0904Module 3 Interrupt Vector 2 - Channel Status Ch 1R/W0x0A04Module 3 Interrupt Steering 2 - Channel Status Ch 1R/W
0x0908Module 3 Interrupt Vector 3 - Channel Status Ch 2R/W0x0A08Module 3 Interrupt Steering 3 - Channel Status Ch 2R/W
0x090CModule 3 Interrupt Vector 4 - Channel Status Ch 3R/W0x0A0CModule 3 Interrupt Steering 4 - Channel Status Ch 3R/W
0x0910Module 3 Interrupt Vector 5 - Channel Status Ch 4R/W0x0A10Module 3 Interrupt Steering 5 - Channel Status Ch 4R/W
0x0914 to 0x0964Module 3 Interrupt Vector 6 to 26 - ReservedR/W0x0A14 to 0x0A64Module 3 Interrupt Steering 6 to 26 - ReservedR/W
0x0968Module 3 Interrupt Vector 27 - Summary StatusR/W0x0A68Module 3 Interrupt Steering 27 - Summary StatusR/W
0x096C to 0x097CModule 3 Interrupt Vector 28 to 32 - ReservedR/W0x0A6C to 0x0A7CModule 3 Interrupt Steering 28 to 32 - ReservedR/W
0x0B00Module 4 Interrupt Vector 1 - BITR/W0x0C00Module 4 Interrupt Steering 1 - BITR/W
0x0B04Module 4 Interrupt Vector 2 - Channel Status Ch 1R/W0x0C04Module 4 Interrupt Steering 2 - Channel Status Ch 1R/W
0x0B08Module 4 Interrupt Vector 3 - Channel Status Ch 2R/W0x0C08Module 4 Interrupt Steering 3 - Channel Status Ch 2R/W
0x0B0CModule 4 Interrupt Vector 4 - Channel Status Ch 3R/W0x0C0CModule 4 Interrupt Steering 4 - Channel Status Ch 3R/W
0x0B10Module 4 Interrupt Vector 5 - Channel Status Ch 4R/W0x0C10Module 4 Interrupt Steering 5 - Channel Status Ch 4R/W
0x0B14 to 0x0B64Module 4 Interrupt Vector 6 to 26 - ReservedR/W0x0C14 to 0x0C64Module 4 Interrupt Steering 6 to 26 - ReservedR/W
0x0B68Module 4 Interrupt Vector 27 - Summary StatusR/W0x0C68Module 4 Interrupt Steering 27 - Summary StatusR/W
0x0B6C to 0x0B7CModule 4 Interrupt Vector 28 to 32 - ReservedR/W0x0C6C to 0x0C7CModule 4 Interrupt Steering 28 to 32 - ReservedR/W
0x0D00Module 5 Interrupt Vector 1 - BITR/W0x0E00Module 5 Interrupt Steering 1 - BITR/W
0x0D04Module 5 Interrupt Vector 2 - Channel Status Ch 1R/W0x0E04Module 5 Interrupt Steering 2 - Channel Status Ch 1R/W
0x0D08Module 5 Interrupt Vector 3 - Channel Status Ch 2R/W0x0E08Module 5 Interrupt Steering 3 - Channel Status Ch 2R/W
0x0D0CModule 5 Interrupt Vector 4 - Channel Status Ch 3R/W0x0E0CModule 5 Interrupt Steering 4 - Channel Status Ch 3R/W
0x0D10Module 5 Interrupt Vector 5 - Channel Status Ch 4R/W0x0E10Module 5 Interrupt Steering 5 - Channel Status Ch 4R/W
0x0D14 to 0x0D64Module 5 Interrupt Vector 6 to 26 - ReservedR/W0x0E14 to 0x0E64Module 5 Interrupt Steering 6 to 26 - ReservedR/W
0x0D68Module 5 Interrupt Vector 27 - Summary StatusR/W0x0E68Module 5 Interrupt Steering 27 - Summary StatusR/W
0x0D6C to 0x0D7CModule 5 Interrupt Vector 28 to 32 - ReservedR/W0x0E6C to 0x0E7CModule 5 Interrupt Steering 28 to 32 - ReservedR/W
0x0F00Module 6 Interrupt Vector 1 - BITR/W0x1000Module 6 Interrupt Steering 1 - BITR/W
0x0F04Module 6 Interrupt Vector 2 - Channel Status Ch 1R/W0x1004Module 6 Interrupt Steering 2 - Channel Status Ch 1R/W
0x0F08Module 6 Interrupt Vector 3 - Channel Status Ch 2R/W0x1008Module 6 Interrupt Steering 3 - Channel Status Ch 2R/W
0x0F0CModule 6 Interrupt Vector 4 - Channel Status Ch 3R/W0x100CModule 6 Interrupt Steering 4 - Channel Status Ch 3R/W
0x0F10Module 6 Interrupt Vector 5 - Channel Status Ch 4R/W0x1010Module 6 Interrupt Steering 5 - Channel Status Ch 4R/W
0x0F14 to 0x0F64Module 6 Interrupt Vector 6 to 26 - ReservedR/W0x1014 to 0x1064Module 6 Interrupt Steering 6 to 26 - ReservedR/W
0x0F68Module 6 Interrupt Vector 27 - Summary StatusR/W0x1068Module 6 Interrupt Steering 27 - Summary StatusR/W
0x0F6C to 0x0F7CModule 6 Interrupt Vector 28 to 32 - ReservedR/W0x106C to 0x107CModule 6 Interrupt Steering 28 to 32 - ReservedR/W

APPENDIX: PIN-OUT DETAILS

Pin-out details (for reference) are shown below, with respect to DATAIO. Additional information on pin-outs can be found in the Motherboard Operational Manuals

Module Signal (Ref Only)44-Pin I/O50-Pin I/O (Mod Slot 1-J3)50-Pin I/O (Mod Slot 2-J4)50-Pin I/O (Mod Slot 3-J3)50-Pin I/O (Mod Slot 3-J4)Serial Comms RS232 SYNC mode (SC6)Serial Comms RS232 ASYNC mode (SC6)Serial Comms RS422/485 (DIFF-SYNC) (SC6)Serial Comms RS422/485 (DIFF-ASYNC) (SC6)
DATIO121012CH1-RXDCH1-RXDRXDLO-CH1RXDLO-CH1
DATIO224352627RXDHI-CH1RXDHI-CH1
DATIO331123CH1-TXDCH1-TXDTXDLO-CH1TXDLO-CH1
DATIO425362728TXDHI-CH1TXDHI-CH1
DATIO551345CLK-CH1CH1-GPO2CLKLO-CH1GPO2_LO-CH1
DATIO627382930CLKHI-CH1GPO2_HI-CH1
DATIO771456CH2-RXDCH2-RXDRXDLO-CH2RXDLO-CH2
DATIO829393031RXDHI-CH2RXDHI-CH2
DATIO981567CH2-TXDCH2-TXDTXDLO-CH2TXDLO-CH2
DATIO1030403132TXDHI-CH2TXDHI-CH2
DATIO11101789CLK-CH2CH2-GPO2CLKLO-CH2GPO2_LO-CH2
DATIO1232423334CLKHI-CH2GPO2_HI CH2
DATIO131218917CH3-RXDCH3-RXDRXDLO-CH3RXDLO-CH3
DATIO1434433442RXDHI-CH3RXDHI-CH3
DATIO1513191018CH3-TXDCH3-TXDTXDLO-CH3TXDLO-CH3
DATIO1635443543TXDHI-CH3TXDHI-CH3
DATIO1715211220CLK-CH3CH3-GPO2CLKLO-CH3GPO2_LO-CH3
DATIO1837463745CLKHI-CH3GPO2_HI-CH3
DATIO1917221321CH4-RXDCH4-RXDRXDLO-CH4RXDLO-CH4
DATIO2039473846RXDHI-CH4RXDHI-CH4
DATIO2118231422CH4-TXDCH4-TXDTXDLO-CH4TXDLO-CH4
DATIO2240483947TXDHI-CH4TXDHI-CH4
DATIO2320251624CLK-CH4CH4-GPO2CLKLO-CH4GPO2_LO-CH4
DATIO2442504149CLKHI-CH4GPO2_HI-CH4
DATIO2541234CH1-RTNCH1-RTNCH1-RTNCH1-RTN
DATIO2626372829
DATIO2791678CH2-RTNCH2-RTNCH2-RTNCH2-RTN
DATIO2831413233
DATIO2914201119CH3-RTNCH3-RTNCH3-RTNCH3-RTN
DATIO3036453644
DATIO3119241523CH4-RTNCH4-RTNCH4-RTNCH4-RTN
DATIO3241494048
DATIO336CH1-GPIO-OCH1-GPIO-OGPIO-O_LO-CH1GPIO-O_LO-CH1
DATIO3428GPIO-O_HI-CH1GPIO-O_HI-CH1
DATIO3511CH2-GPIO-OCH2-GPIO-OGPIO-O_LO-CH2GPIO-O_LO-CH2
DATIO3633GPIO-O_HI-CH2GPIO-O_HI-CH2
DATIO3716CH3-GPIO-OCH3-GPIO-OGPIO-O_LO-CH3GPIO-O_LO-CH3
DATIO3838GPIO-O_HI-CH3GPIO-O_HI-CH3
DATIO3921CH4-GPIO-OCH4-GPIO-OGPIO-O_LO-CH4GPIO-O_LO-CH4
DATIO4043GPIO-O_HI-CH4GPIO-O_HI-CH4
N/A

Notes

(General)SC6 signals are referenced to system (SYS) GND (RTN).

REVISION HISTORY

Motherboard Manual - SC6 Revision History
RevisionRevision DateDescription
C2022-11-21ECO C09828, initial release of SC6 function module manual.
C12022-12-05ECO C09874, pg.17, changed Clock Mode bits D2:D0 0x2 to reserved; removed 0x2 description.
C22023-03-24ECO C12014, pg.13, changed D2:D0 description (1:0:0) to 'Loopback'.
C32023-11-13ECO C10953, pg.9/21/27, added Module Common Registers. Pg.23, removed Summary Events Table. Pg.30, updated pinouts for ASYNC Mode (DATIO5/11/17/23). Pg.30, updated pinout for DIFF-ASYNC Mode (DATIO5/6/11/12/17/18/23/24).

DOCS.NAII REVISIONS

Revision DateDescription
2025-03-12Updated module pinout table to add module I/O pinouts for 44- & 50-pin connectors.
2026-04-15Formatting updates throughout manual (non-technical changes).

STATUS AND INTERRUPTS

Status registers indicate the detection of faults or events. The status registers can be channel bit-mapped or event bit-mapped. An example of a channel bit-mapped register is the BIT status register, and an example of an event bit-mapped register is the FIFO status register.

For those status registers that allow interrupts to be generated upon the detection of the fault or the event, there are four registers associated with each status: Dynamic, Latched, Interrupt Enabled, and Set Edge/Level Interrupt.

Dynamic Status: The Dynamic Status register indicates the current condition of the fault or the event. If the fault or the event is momentary, the contents in this register will be clear when the fault or the event goes away. The Dynamic Status register can be polled, however, if the fault or the event is sporadic, it is possible for the indication of the fault or the event to be missed.

Latched Status: The Latched Status register indicates whether the fault or the event has occurred and keeps the state until it is cleared by the user. Reading the Latched Status register is a better alternative to polling the Dynamic Status register because the contents of this register will not clear until the user commands to clear the specific bit(s) associated with the fault or the event in the Latched Status register. Once the status register has been read, the act of writing a 1 back to the applicable status register to any specific bit (channel/event) location will “clear” the bit (set the bit to 0). When clearing the channel/event bits, it is strongly recommended to write back the same bit pattern as read from the Latched Status register. For example, if the channel bit-mapped Latched Status register contains the value 0x0000 0005, which indicates fault/event detection on channel 1 and 3, write the value 0x0000 0005 to the Latched Status register to clear the fault/event status for channel 1 and 3. Writing a “1” to other channels that are not set (example 0x0000 000F) may result in incorrectly “clearing” incoming faults/events for those channels (example, channel 2 and 4).

Interrupt Enable: If interrupts are preferred upon the detection of a fault or an event, enable the specific channel/event interrupt in the Interrupt Enable register. The bits in Interrupt Enable register map to the same bits in the Latched Status register. When a fault or event occurs, an interrupt will be fired. Subsequent interrupts will not trigger until the application acknowledges the fired interrupt by clearing the associated channel/event bit in the Latched Status register. If the interruptible condition is still persistent after clearing the bit, this may retrigger the interrupt depending on the Edge/Level setting.

Set Edge/Level Interrupt: When interrupts are enabled, the condition on retriggering the interrupt after the Latch Register is “cleared” can be specified as “edge” triggered or “level” triggered. Note, the Edge/Level Trigger also affects how the Latched Register value is adjusted after it is “cleared” (see below).

  • Edge triggered: An interrupt will be retriggered when the Latched Status register change from low (0) to high (1) state. Uses for edge-triggered interrupts would include transition detections (Low-to-High transitions, High-to-Low transitions) or fault detections. After “clearing” an interrupt, another interrupt will not occur until the next transition or the re-occurrence of the fault again.

  • Level triggered: An interrupt will be generated when the Latched Status register remains at the high (1) state. Level-triggered interrupts are used to indicate that something needs attention.

Interrupt Vector and Steering

When interrupts are enabled, the interrupt vector associated with the specific interrupt can be programmed with a unique number/identifier defined by the user 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.

Interrupt Trigger Types

In most applications, limiting the number of interrupts generated is preferred as interrupts are costly, thus choosing the correct Edge/Level interrupt trigger to use is important.

Example 1: Fault detection

This example illustrates interrupt considerations when detecting a fault like an “open” on a line. When an “open” is detected, the system will receive an interrupt. If the “open” on the line is persistent and the trigger is set to “edge”, upon “clearing” the interrupt, the system will not regenerate another interrupt. If, instead, the trigger is set to “level”, upon “clearing” the interrupt, the system will re-generate another interrupt. Thus, in this case, it will be better to set the trigger type to “edge”.

Example 2: Threshold detection

This example illustrates interrupt considerations when detecting an event like reaching or exceeding the “high watermark” threshold value. In a communication device, when the number of elements received in the FIFO reaches the high-watermark threshold, an interrupt will be generated. Normally, the application would read the count of the number of elements in the FIFO and read this number of elements from the FIFO. After reading the FIFO data, the application would “clear” the interrupt. If the trigger type is set to “edge”, another interrupt will be generated only if the number of elements in FIFO goes below the “high watermark” after the “clearing” the interrupt and then fills up to reach the “high watermark” threshold value. Since receiving communication data is inherently asynchronous, it is possible that data can continue to fill the FIFO as the application is pulling data off the FIFO. If, at the time the interrupt is “cleared”, the number of elements in the FIFO is at or above the “high watermark”, no interrupts will be generated. In this case, it will be better to set the trigger type to “level”, as the purpose here is to make sure that the FIFO is serviced when the number of elements exceeds the high watermark threshold value. Thus, upon “clearing” the interrupt, if the number of elements in the FIFO is at or above the “high watermark” threshold value, another interrupt will be generated indicating that the FIFO needs to be serviced.


Dynamic and Latched Status Registers Examples

The examples in this section illustrate the differences in behavior of the Dynamic Status and Latched Status registers as well as the differences in behavior of Edge/Level Trigger when the Latched Status register is cleared.

Figure 1. Example of Module’s Channel-Mapped Dynamic and Latched Status States

No Clearing of Latched StatusClearing of Latched Status (Edge-Triggered)Clearing of Latched Status(Level-Triggered)
TimeDynamic StatusLatched StatusActionLatched StatusActionLatched
T00x00x0Read Latched Register0x0Read Latched Register0x0
T10x10x1Read Latched Register0x10x1
T10x10x1Write 0x1 to Latched RegisterWrite 0x1 to Latched Register
T10x10x10x00x1
T20x00x1Read Latched Register0x0Read Latched Register0x1
T20x00x1Read Latched Register0x0Write 0x1 to Latched Register
T20x00x1Read Latched Register0x00x0
T30x20x3Read Latched Register0x2Read Latched Register0x2
T30x20x3Write 0x2 to Latched RegisterWrite 0x2 to Latched Register
T30x20x30x00x2
T40x20x3Read Latched Register0x1Read Latched Register0x3
T40x20x3Write 0x1 to Latched RegisterWrite 0x3 to Latched Register
T40x20x30x00x2
T50xC0xFRead Latched Register0xCRead Latched Register0xE
T50xC0xFWrite 0xC to Latched RegisterWrite 0xE to Latched Register
T50xC0xF0x00xC
T60xC0xFRead Latched Register0x0Read Latched0xC
T60xC0xFRead Latched Register0x0Write 0xC to Latched Register
T60xC0xFRead Latched Register0x00xC
T70x40xFRead Latched Register0x0Read Latched Register0xC
T70x40xFRead Latched Register0x0Write 0xC to Latched Register
T70x40xFRead Latched Register0x00x4
T80x40xFRead Latched Register0x0Read Latched Register0x4

Interrupt Examples

The examples in this section illustrate the interrupt behavior with Edge/Level Trigger.

Figure 2. Illustration of Latched Status State for Module with 4-Channels with Interrupt Enabled

TimeLatched Status (Edge-Triggered - Clear Multi-Channel)Latched Status (Edge-Triggered - Clear Single Channel) 2+Latched Status (Level-Triggered - Clear Multi-Channel)Action
LatchedActionLatchedActionLatchedT1 (Int 1)
Interrupt Generated++``+
Read Latched Registers
0x1Interrupt Generated++``+
Read Latched Registers
0x1Interrupt Generated++``+
Read Latched Registers
0x1T1 (Int 1)
Write 0x1 to Latched RegisterWrite 0x1 to Latched RegisterWrite 0x1 to Latched RegisterT1 (Int 1)
0x00x0Interrupt re-triggers++``+
Note, interrupt re-triggers after each clear until T2.
0x1T3 (Int 2)
Interrupt Generated++``+
Read Latched Registers
0x2Interrupt Generated++``+
Read Latched Registers
0x2Interrupt Generated++``+
Read Latched Registers
0x2T3 (Int 2)
Write 0x2 to Latched RegisterWrite 0x2 to Latched RegisterWrite 0x2 to Latched RegisterT3 (Int 2)
0x00x0Interrupt re-triggers++``+
Note, interrupt re-triggers after each clear until T7.
0x2T4 (Int 3)
Interrupt Generated++``+
Read Latched Registers
0x1Interrupt Generated++``+
Read Latched Registers
0x1Interrupt Generated++``+
Read Latched Registers
0x3T4 (Int 3)
Write 0x1 to Latched RegisterWrite 0x1 to Latched RegisterWrite 0x3 to Latched RegisterT4 (Int 3)
0x00x0Interrupt re-triggers++``+
Note, interrupt re-triggers after each clear and 0x3 is reported in Latched Register until T5.
0x3T4 (Int 3)
0x00x0Interrupt re-triggers++``+
Note, interrupt re-triggers after each clear until T7.
0x2T6 (Int 4)
Interrupt Generated++``+
Read Latched Registers
0xCInterrupt Generated++``+
Read Latched Registers
0xCInterrupt Generated++``+
Read Latched Registers
0xET6 (Int 4)
Write 0xC to Latched RegisterWrite 0x4 to Latched RegisterWrite 0xE to Latched RegisterT6 (Int 4)
0x0Interrupt re-triggers++``+
Write 0x8 to Latched Register
0x8Interrupt re-triggers++``+
Note, interrupt re-triggers after each clear and 0xE is reported in Latched Register until T7.
0xET6 (Int 4)
0x00x0Interrupt re-triggers++``+
Note, interrupt re-triggers after each clear and 0xC is reported in Latched Register until T8.
0xCT6 (Int 4)
0x00x0Interrupt re-triggers++``+
Note, interrupt re-triggers after each clear and 0x4 is reported in Latched Register always.
0x4

REVISION HISTORY

Motherboard Manual - Status and Interrupts Revision History
RevisionRevision DateDescription
C2021-11-30C08896; Transition manual to docbuilder format - no technical info change.

DOCS.NAII REVISIONS

Revision DateDescription
2026-03-02Formatting updates to document; no technical changes.
Link to original

MODULE COMMON REGISTERS

The registers described in this document are common to all NAI Generation 5 modules.

Module Information Registers

The registers in this section provide module information such as firmware revisions, capabilities and unique serial number information.

FPGA Version Registers

The FPGA firmware version registers include registers that contain the Revision, Compile Timestamp, SerDes Revision, Template Revision and Zynq Block Revision information.

FPGA Revision
Function:FPGA firmware revision
Type:unsigned binary word (32-bit)
Data Range:0x0000 0000 to 0xFFFF FFFF
Read/Write:R
Initialized Value:Value corresponding to the revision of the board's FPGA
Operational Settings:The upper 16-bits are the major revision and the lower 16-bits are the minor revision.
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
Major Revision Number
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
Minor Revision Number
FPGA Compile Timestamp
Function:Compile Timestamp for the FPGA firmware.
Type:unsigned binary word (32-bit)
Data Range:N/A
Read/Write:R
Initialized Value:Value corresponding to the compile timestamp of the board's FPGA
Operational Settings:The 32-bit value represents the Day, Month, Year, Hour, Minutes and Seconds as formatted in the table:
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
day (5-bits)month (4-bits)year (6-bits)hr
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
hour (5-bits)minutes (6-bits)seconds (6-bits)
FPGA SerDes Revision
Function:FPGA SerDes revision
Type:unsigned binary word (32-bit)
Data Range:0x0000 0000 to 0xFFFF FFFF
Read/Write:R
Initialized Value:Value corresponding to the SerDes revision of the board's FPGA
Operational Settings:The upper 16-bits are the major revision, and the lower 16-bits are the minor revision.
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
Major Revision Number
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
Minor Revision Number
FPGA Template Revision
Function:FPGA Template revision
Type:unsigned binary word (32-bit)
Data Range:0x0000 0000 to 0xFFFF FFFF
Read/Write:R
Initialized Value:Value corresponding to the template revision of the board's FPGA
Operational Settings:The upper 16-bits are the major revision, and the lower 16-bits are the minor revision.
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
Major Revision Number
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
Minor Revision Number
FPGA Zynq Block Revision
Function:FPGA Zynq Block revision
Type:unsigned binary word (32-bit)
Data Range:0x0000 0000 to 0xFFFF FFFF
Read/Write:R
Initialized Value:Value corresponding to the Zynq block revision of the board's FPGA
Operational Settings:The upper 16-bits are the major revision, and the lower 16-bits are the minor revision.
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
Major Revision Number
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
Minor Revision Number

Bare Metal Version Registers

The Bare Metal firmware version registers include registers that contain the Revision and Compile Time information.

Bare Metal Revision
Function:Bare Metal firmware revision
Type:unsigned binary word (32-bit)
Data Range:0x0000 0000 to 0xFFFF FFFF
Read/Write:R
Initialized Value:Value corresponding to the revision of the board's Bare Metal
Operational Settings:The upper 16-bits are the major revision and the lower 16-bits are the minor revision.
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
Major Revision Number
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
Minor Revision Number
Bare Metal Compile Time
Function:Provides an ASCII representation of the Date/Time for the Bare Metal compile time.
Type:24-character ASCII string - Six (6) unsigned binary word (32-bit)
Data Range:N/A
Read/Write:R
Initialized Value:Value corresponding to the ASCII representation of the compile time of the board's Bare Metal
Operational Settings:The six 32-bit words provide an ASCII representation of the Date/Time. The hexadecimal values in the field below represent: May 17 2019 at 15:38:32

Note

little-endian order of ASCII values

Word 1 (Ex. 0x2079614D)
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
Space (0x20)Month ('y' - 0x79)
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
Month ('a' - 0x61)Month ('M' - 0x4D)
Word 2 (Ex. 0x32203731)
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
Year ('2' - 0x32)Space (0x20)
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
Day ('7' - 0x37)Day ('1' - 0x31)
Word 3 (Ex. 0x20393130)
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
Space (0x20)Year ('9' - 0x39)
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
Year ('1' - 0x31)Year ('0' - 0x30)
Word 4 (Ex. 0x31207461)
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
Hour ('1' - 0x31)Space (0x20)
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
'a' (0x74)'t' (0x61)
Word 5 (Ex. 0x38333A35)
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
Minute ('8' - 0x38)Minute ('3' - 0x33)
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
':' (0x3A)Hour ('5' - 0x35)
Word 6 (Ex. 0x0032333A)
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
NULL (0x00)Seconds ('2' - 0x32)
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
Seconds ('3' - 0x33)':' (0x3A)

FSBL Version Registers

The FSBL version registers include registers that contain the Revision and Compile Time information for the First Stage Boot Loader (FSBL).

FSBL Revision
Function:FSBL firmware revision
Type:unsigned binary word (32-bit)
Data Range:0x0000 0000 to 0xFFFF FFFF
Read/Write:R
Initialized Value:Value corresponding to the revision of the board's FSBL
Operational Settings:The upper 16-bits are the major revision, and the lower 16-bits are the minor revision.
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
Major Revision Number
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
Minor Revision Number
FSBL Compile Time
Function:Provides an ASCII representation of the Date/Time for the FSBL compile time.
Type:24-character ASCII string - Six (6) unsigned binary word (32-bit)
Data Range:N/A
Read/Write:R
Initialized Value:Value corresponding to the ASCII representation of the Compile Time of the board's FSBL
Operational Settings:The six 32-bit words provide an ASCII representation of the Date/Time.

The hexadecimal values in the field below represent: May 17 2019 at 15:38:32

Note

little-endian order of ASCII values

Word 1 (Ex. 0x2079614D)
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
Space (0x20)Month ('y' - 0x79)
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
Month ('a' - 0x61)Month ('M' - 0x4D)
Word 2 (Ex. 0x32203731)
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
Year ('2' - 0x32)Space (0x20)
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
Day ('7' - 0x37)Day ('1' - 0x31)
Word 3 (Ex. 0x20393130)
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
Space (0x20)Year ('9' - 0x39)
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
Year ('1' - 0x31)Year ('0' - 0x30)
Word 4 (Ex. 0x31207461)
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
Hour ('1' - 0x31)Space (0x20)
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
'a' (0x74)'t' (0x61)
Word 5 (Ex. 0x38333A35)
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
Minute ('8' - 0x38)Minute ('3' - 0x33)
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
':' (0x3A)Hour ('5' - 0x35)
Word 6 (Ex. 0x0032333A)
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
NULL (0x00)Seconds ('2' - 0x32)
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
Seconds ('3' - 0x33)':' (0x3A)

Module Serial Number Registers

The Module Serial Number registers include registers that contain the Serial Numbers for the Interface Board and the Functional Board of the module.

Interface Board Serial Number
Function:Unique 128-bit identifier used to identify the interface board.
Type:16-character ASCII string - Four (4) unsigned binary words (32-bit)
Data Range:N/A
Read/Write:R
Initialized Value:Serial number of the interface board
Operational Settings:This register is for information purposes only.
Functional Board Serial Number
Function:Unique 128-bit identifier used to identify the functional board.
Type:16-character ASCII string - Four (4) unsigned binary words (32-bit)
Data Range:N/A
Read/Write:R
Initialized Value:Serial number of the functional board
Operational Settings:This register is for information purposes only.
Module Capability
Function:Provides indication for whether or not the module can support the following: SerDes block reads, SerDes FIFO block reads, SerDes packing (combining two 16-bit values into one 32-bit value) and floating point representation. The purpose for block access and packing is to improve the performance of accessing larger amounts of data over the SerDes interface.
Type:unsigned binary word (32-bit)
Data Range:0x0000 0000 to 0x0000 0107
Read/Write:R
Initialized Value:0x0000 0107
Operational Settings:A “1” in the bit associated with the capability indicates that it is supported.
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
0000000000000000
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
0000000Flt-Pt00000PackFIFO BlkBlk
Module Memory Map Revision
Function:Module Memory Map revision
Type:unsigned binary word (32-bit)
Data Range:0x0000 0000 to 0xFFFF FFFF
Read/Write:R
Initialized Value:Value corresponding to the Module Memory Map Revision
Operational Settings:The upper 16-bits are the major revision and the lower 16-bits are the minor revision.
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
Major Revision Number
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
Minor Revision Number

Module Measurement Registers

The registers in this section provide module temperature measurement information.

Temperature Readings Registers

The temperature registers provide the current, maximum (from power-up) and minimum (from power-up) Zynq and PCB temperatures.

Interface Board Current Temperature
Function:Measured PCB and Zynq Core temperatures on Interface Board.
Type:signed byte (8-bits) for PCB and signed byte (8-bits) for Zynq core temperatures
Data Range:0x0000 0000 to 0x0000 FFFF
Read/Write:R
Initialized Value:Value corresponding to the measured PCB and Zynq core temperatures based on the table below
Operational Settings:The upper 16-bits are not used, and the lower 16-bits are the PCB and Zynq Core Temperatures. For example, if the register contains the value 0x0000 202C, this represents PCB Temperature = 32° Celsius and Zynq Temperature = 44° Celsius.
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
0000000000000000
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
PCB TemperatureZynq Core Temperature
Functional Board Current Temperature
Function:Measured PCB temperature on Functional Board.
Type:signed byte (8-bits) for PCB
Data Range:0x0000 0000 to 0x0000 00FF
Read/Write:R
Initialized Value:Value corresponding to the measured PCB on the table below
Operational Settings:The upper 24-bits are not used, and the lower 8-bits are the PCB Temperature. For example, if the register contains the value 0x0000 0019, this represents PCB Temperature = 25° Celsius.
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
0000000000000000
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
00000000PCB Temperature
Interface Board Maximum Temperature
Function:Maximum PCB and Zynq Core temperatures on Interface Board since power-on.
Type:signed byte (8-bits) for PCB and signed byte (8-bits) for Zynq core temperatures
Data Range:0x0000 0000 to 0x0000 FFFF
Read/Write:R
Initialized Value:Value corresponding to the maximum measured PCB and Zynq core temperatures since power-on based on the table below
Operational Settings:The upper 16-bits are not used, and the lower 16-bits are the maximum PCB and Zynq Core Temperatures. For example, if the register contains the value 0x0000 5569, this represents maximum PCB Temperature = 85° Celsius and maximum Zynq Temperature = 105° Celsius.
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
0000000000000000
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
PCB TemperatureZynq Core Temperature
Interface Board Minimum Temperature
Function:Minimum PCB and Zynq Core temperatures on Interface Board since power-on.
Type:signed byte (8-bits) for PCB and signed byte (8-bits) for Zynq core temperatures
Data Range:0x0000 0000 to 0x0000 FFFF
Read/Write:R
Initialized Value:Value corresponding to the minimum measured PCB and Zynq core temperatures since power-on based on the table below
Operational Settings:The upper 16-bits are not used, and the lower 16-bits are the minimum PCB and Zynq Core Temperatures. For example, if the register contains the value 0x0000 D8E7, this represents minimum PCB Temperature = -40° Celsius and minimum Zynq Temperature = -25° Celsius.
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
0000000000000000
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
PCB TemperatureZynq Core Temperature
Functional Board Maximum Temperature
Function:Maximum PCB temperature on Functional Board since power-on.
Type:signed byte (8-bits) for PCB
Data Range:0x0000 0000 to 0x0000 00FF
Read/Write:R
Initialized Value:Value corresponding to the measured PCB on the table below
Operational Settings:The upper 24-bits are not used, and the lower 8-bits are the PCB Temperature. For example, if the register contains the value 0x0000 0055, this represents PCB Temperature = 85° Celsius.
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
0000000000000000
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
00000000PCB Temperature
Functional Board Minimum Temperature
Function:Minimum PCB temperature on Functional Board since power-on.
Type:signed byte (8-bits) for PCB
Data Range:0x0000 0000 to 0x0000 00FF
Read/Write:R
Initialized Value:Value corresponding to the measured PCB on the table below
Operational Settings:The upper 24-bits are not used, and the lower 8-bits are the PCB Temperature. For example, if the register contains the value 0x0000 00D8, this represents PCB Temperature = -40° Celsius.
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
0000000000000000
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
00000000PCB Temperature

Higher Precision Temperature Readings Registers

These registers provide higher precision readings of the current Zynq and PCB temperatures.

Higher Precision Zynq Core Temperature
Function: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.
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
Signed Integer Part of Temperature
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
Fractional Part of Temperature
Higher Precision Interface PCB Temperature
Function:Higher precision measured Interface 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 Interface 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.
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
Signed Integer Part of Temperature
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
Fractional Part of Temperature
Higher Precision Functional PCB Temperature
Function:Higher precision measured Functional 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 Functional 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/100 of degree Celsius. For example, if the register contains the value 0x0018 004B, this represents Functional PCB Temperature = 24.75° Celsius, and value 0xFFD9 0019 represents -39.25° Celsius.
D31D30D29D28D27D26D25D24D23D22D21D20D19D18D17D16
Signed Integer Part of Temperature
D15D14D13D12D11D10D9D8D7D6D5D4D3D2D1D0
Fractional Part of Temperature

Module Health Monitoring Registers

The registers in this section provide module temperature measurement information. If the temperature measurements reaches the Lower Critical or Upper Critical conditions, the module will automatically reset itself to prevent damage to the hardware.

Module Sensor Summary Status
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 module 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:D6Reserved
D5Functional Board PCB Temperature
D4Interface Board PCB Temperature
D3:D0Reserved

Module Sensor Registers

The registers listed in this section apply to each module sensor listed for the Module Sensor Summary Status register. Each individual sensor register provides a group of registers for monitoring module 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 Interface Board PCB Temperature sensor as an example.

Sensor Threshold Status
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:D4Reserved
D3Exceeded Upper Critical Threshold
D2Exceeded Upper Warning Threshold
D1Exceeded Lower Critical Threshold
D0Exceeded Lower Warning Threshold
Sensor Current Reading
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
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
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
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
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
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
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.

FUNCTION REGISTER MAP

KEY

Configuration/Control
Measurement/Status/Board Information
MODULE INFORMATION REGISTERS
OFFSETREGISTER NAMEACCESSOFFSETREGISTER NAMEACCESS
0x003CFPGA RevisionR0x0074Bare Metal RevisionR
0x0030FPGA Compile TimestampR0x0080Bare Metal Compile Time (Bit 0-31)R
0x0034FPGA SerDes RevisionR0x0084Bare Metal Compile Time (Bit 32-63)R
0x0038FPGA Template RevisionR0x0088Bare Metal Compile Time (Bit 64-95)R
0x0040FPGA Zynq Block RevisionR0x008CBare Metal Compile Time (Bit 96-127)R
0x0090Bare Metal Compile Time (Bit 128-159)R
0x0094Bare Metal Compile Time (Bit 160-191)R
0x007CFSBL RevisionR
0x00B0FSBL Compile Time (Bit 0-31)R
0x00B4FSBL Compile Time (Bit 32-63)R
0x00B8FSBL Compile Time (Bit 64-95)R
0x00BCFSBL Compile Time (Bit 96-127)R
0x00C0FSBL Compile Time (Bit 128-159)R
0x00C4FSBL Compile Time (Bit 160-191)R
0x0000Interface Board Serial Number (Bit 0-31)R0x0010Functional Board Serial Number (Bit 0-31)R
0x0034Interface Board Serial Number (Bit 32-63)R0x0014Functional Board Serial Number (Bit 32-63)R
0x0008Interface Board Serial Number (Bit 64-95)R0x0018Functional Board Serial Number (Bit 64-95)R
0x000CInterface Board Serial Number (Bit 96-127)R0x001CFunctional Board Serial Number (Bit 96-127)R
0x0070Module CapabilityR
0x01FCModule Memory Map RevisionR
MODULE MEASUREMENTS REGISTERS
OFFSETREGISTER NAMEACCESSOFFSETREGISTER NAMEACCESS
0x0200Interface Board PCB/Zynq Current TempR0x0208Functional Board PCB Current TempR
0x0218Interface Board PCB/Zynq Max TempR0x0228Functional Board PCB Max TempR
0x0220Interface Board PCB/Zynq Min TempR0x0230Functional Board PCB Min TempR
0x02C0Higher Precision Zynq Core TemperatureR
0x02C4Higher Precision Interface PCB TemperatureR
0x02E0Higher Precision Functional PCB TemperatureR
MODULE HEALTH MONITORING REGISTERS
OFFSETREGISTER NAMEACCESSOFFSETREGISTER NAMEACCESS
0x07F8Module Sensor Summary StatusR
![](/_shared/images/Module_Sensor_Registers_Memory_Map.png)

REVISION HISTORY

Motherboard Manual - Module Common Registers Revision History
RevisionRevision DateDescription
C2023-08-11ECO C10649, initial release of module common registers manual.
C12024-05-15ECO C11522, removed Zynq Core/Aux/DDR Voltage register descriptions from Module Measurement Registers. Pg.16, updated Module Sensor Summary Status register to add PS references; updated Bit Table to change voltage/current bits to 'reserved'. Pg.16, updated Module/Power Supply Sensor Registers description to better describe register functionality and to add figure. Pg.17, added 'Exceeded' to threshold bit descriptions. Pg.17-18, removed voltage/current references from sensor descriptions. Pg.20, removed Zynq Core/Aux/DDR Voltage register offsets from Module Measurement Registers. Pg.20, updated Module Health Monitoring Registers offset tables.
C22024-07-10ECO C11701, pg.16, updated Module Sensor Summary Status register to remove PS references;updated Bit Table to change PS temperature bits to 'reserved'. Pg.16, updated Module SensorRegisters description to remove PS references. Pg.20, updated Module Health MonitoringRegisters offset tables to remove PS temperature register offsets.

DOCS.NAII REVISIONS

Revision DateDescription
2025-11-05Corrected register offsets for Interface Board Min Temp and Function Board Min & Max Temps.
2026-03-02Formatting updates to document; no technical changes.
Link to original

NAI Cares

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:

Documentation

https://www.docs.naii.com

FAQ

http://www.naii.com/faqs

Application Notes

http://www.naii.com/applicationnotes

Calibration and Repairs

http://www.naii.com/calibrationrepairs

Call Us

(631) 567-1100

Link to original