lowRISC / lowRISC/ethernet

software/programming descriptio

Open
#5 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
SystemVerilog
Stars
23
Forks
12
PR merge metrics
No merged PRs in 30d

Description

Could we have some software documentation, such as registers provided and how to send and receive packets on how to interact with the core, for those of us not good at reading verilog.

Contributor guide

No contributing guide indexed for this repository

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

No files, tests, or entry points are named. Start by locating the core's register definitions and packet interface documentation, then identify how users interact with the memory-mapped Ethernet MAC without reading Verilog. Done means documenting the registers and the send/receive packet flow clearly for newcomers.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, embedded-iot, networking
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.