search

GiPHouse / qbaylogic-clash-based-macipudp-stack-spring24

A fully configurable Ethernet core written in Clash.
Other
5 stars 2 forks source link

Write full MAC Tx+RX stack example #118

Closed rowanG077 closed 5 months ago

rowanG077 commented 6 months ago

Feature description We would like to have a few example stacks for users of our core. This one is for a full MAC transmit + receive stack. This includes a CDC and uses the downconverter/upconverters. The module should live in Clash.Cores.Ethernet.Examples. For the PHY use a dummy with clear documentation that a user should use one for their specific protocol (RGMII. MII, etc)

Expected behaviour A clearly documented example. This should be in the form of a (large )haddock comment including a doctest.

Expected steps Implement example.

Additional Context See https://github.com/clash-lang/clash-compiler/blob/948ad7d486350ef99c41ee4b7c8cec2857fde49e/clash-cores/src/Clash/Cores/Crc.hs for an example how to write haddock examples including doctest.

rowanG077 commented 5 months ago

Not planned as MAC Tx/Rx example give more then enough information.