Heartbeat¶

Authors: Jonathan P. Newman
IO: Frame Source, Register Access
ONIX ID: 12
ONIX Hubs: PCIe Host

Description¶

The Heartbeat device produces periodic samples containing the hub clock count. It is useful for generating keep-alive signal for various communication channels.

Register Programming¶

Address	Name	Access	Time of Effect	POR Value	Reset Action	Description
0x00	ENABLE	R/W	On Reset	Implementation dependent, see hub documentation	None	The LSB is used to enable or disable the device data stream: 0x0: data output disabled 0x1: data output enabled
0x01	CLK_DIV	R/W	On Reset	CLK_HZ / HB_HZ where HB_HZ is a implementation dependent default rate	None	Heartbeat clock divider ratio. Minimum value is CLK_HZ / 10e6
0x02	CLK_HZ	R	N/A	N/A	None	The frequency parameter, CLK_HZ, used in the calculation of CLK_DIV.

Address

Name

Access

Time of Effect

POR Value

Reset Action

Description

0x00

ENABLE

R/W

On Reset

Implementation dependent, see hub documentation

None

The LSB is used to enable or disable the device data stream:

0x0: data output disabled
0x1: data output enabled

0x01

CLK_DIV

R/W

On Reset

CLK_HZ / HB_HZ where HB_HZ is a implementation dependent default rate

None

Heartbeat clock divider ratio. Minimum value is CLK_HZ / 10e6

0x02

CLK_HZ

N/A

None

The frequency parameter, CLK_HZ, used in the calculation of CLK_DIV.

Device To Host Data Frames¶

Each frame transmitted to the host is structured as follows:

Host To Device Data Frames¶

This device does not accept input frames. All write attempts will fail with an error.

ONI Datasheets

Load Test Device