litex icon indicating copy to clipboard operation
litex copied to clipboard

We need to document LiteX CSRs!

Open gsomlo opened this issue 5 years ago • 5 comments

I'd like to add a doc/CSR.md file to LiteX, documenting how CSRs work from both the hardware and software (programmer's API) perspective. I'm going to add a new comment below with a .md-ish formatted document, which we can collectively work on until it's more or less ready, after which I'll post a PR to add it to LiteX. If there's a better way to edit a doc before including it under ./doc, please let me know and I can start doing that (I'm a bit awkward with github, having been used to linux's mailing list based model of development and feedback solicitation, so apologies for any clunkiness :). Comments, feedback, and direct edits of the following comment (if github allows it) much appreciated!

gsomlo avatar Dec 10 '19 15:12 gsomlo

moved to https://github.com/enjoy-digital/litex/wiki/CSR-Bus -- please check there for the actual content of the documentation (gls -- 03/04/2020)

gsomlo avatar Dec 10 '19 15:12 gsomlo

@xobs this is probably of interest to you.

mithro avatar Dec 10 '19 19:12 mithro

Nice!

BracketMaster avatar Feb 19 '20 08:02 BracketMaster

@gsomlo: sorry for the delay and thanks for the documentation. I'll try in the next week to create a proper wiki for the project and just prepared things with topics i'd like to document. I just put your initial description here: https://github.com/enjoy-digital/litex/wiki/CSR-Bus. Feel free to edit it and update, i'll also try to work on the FIXME. We can keep this issue for discussing things until we are happy with the CSR documentation.

enjoy-digital avatar Mar 04 '20 11:03 enjoy-digital

@gsomlo I also have a simple working CSR example for ECP5 here if you'd like to reference that.

BracketMaster avatar Mar 04 '20 22:03 BracketMaster