janestreet / janestreet/hardcaml_event_driven_sim

"state" name is not valid in parsing

Open
#2 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

forwarded-to-js-devs
Dominant language
OCaml
Stars
2
Forks
1
PR merge metrics
No merged PRs in 30d

Description

I named one of my signals "state" in an effort to debug a state machine.

The circuit synthesizes (correctly is still to be determined - the strobe behaviour is sus) with the state correctly assigned -> Hardcaml appears fine.

Event_driven_sim appears to be unable to render this signal name in the signals tab on the left.

Line 158ish:
https://github.com/LeEmperor/EthMac_of_Hardcaml/blob/bpurtell/RGMII_Sink_Test/rgmii/src/rtl/eth_mac/lib/rx_frame_parser.ml

Line 200ish:
https://github.com/LeEmperor/EthMac_of_Hardcaml/blob/bpurtell/RGMII_Sink_Test/rgmii/src/rtl/eth_mac/bin/main.ml

Figure 1: Lack of "state" signal.
Image

Figure 2: My O module
Image

Figure 3: The End of my Create Function
Image

Figure 4: The Calling of my Sim
Image

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the missing "state" signal in the linked Hardcaml example, then inspect the referenced lines in rx_frame_parser.ml and bin/main.ml. Trace how signal names are passed to the event-driven simulator and rendered in the signals tab. Done means a signal named "state" appears correctly without regressing other signal names.

Written by the indexing model from the issue text.

Assessment

Tech stack
ocaml
Domain
tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.