Skip to content

Specify heartbeat as required on all hubs #108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aacuevas merged 2 commits into from
Oct 6, 2025
Merged

Specify heartbeat as required on all hubs #108

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a4827f3
Specify heartbeat as required on all hubs
aacuevas Oct 6, 2025
daa29e3
Remove address restriction for heartbeat
aacuevas Oct 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions source/hw-spec/devices/required.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,13 +115,14 @@ their :ref:`datasheet<hub-datasheet>`.

Heartbeat Device
------------------
Local hub 0 MUST contain a “heartbeat device”. It MUST expose the register
All hubs MUST contain a “heartbeat device”. It MUST expose the register
interface and read stream, and it MUST NOT expose a write stream. This is a
simple device that periodically produces :ref:`samples <dev-sample>` containing
only the ``hubclk_cnt`` and an empty payload, at a fixed rate of 100 Hz. Its
``ENABLE`` register must be read-only and always active. This device ensures
that API calls accessing the read stream are guaranteed to be unblocked in the
case that no other devices in the system are producing data.
case that no other devices in the system are producing data as well as providing
a constant reference for hub clock synchronization if required.

Other, identical heartbeat devices but with configurable ``ENABLE`` and data
rate MAY exist as part of any hub.
Expand Down