Skip to content
This repository has been archived by the owner on Sep 6, 2024. It is now read-only.

Write MAC stack RX examples #116

Open
rowanG077 opened this issue May 16, 2024 · 0 comments · May be fixed by #149
Open

Write MAC stack RX examples #116

rowanG077 opened this issue May 16, 2024 · 0 comments · May be fixed by #149
Assignees
Labels
User interface We want the core to be easy to use

Comments

@rowanG077
Copy link
Contributor

Feature description
We would like to have a few example stacks for users of our core. This one is for a simply MAC only Receive stack. 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.

@JLaumen JLaumen self-assigned this May 29, 2024
@rowanG077 rowanG077 added the User interface We want the core to be easy to use label May 29, 2024
@JLaumen JLaumen linked a pull request Jun 6, 2024 that will close this issue
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
User interface We want the core to be easy to use
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants