Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

We need to document LiteX CSRs! #314

Open
gsomlo opened this issue Dec 10, 2019 · 5 comments
Open

We need to document LiteX CSRs! #314

gsomlo opened this issue Dec 10, 2019 · 5 comments

Comments

@gsomlo
Copy link
Collaborator

gsomlo commented Dec 10, 2019

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
Copy link
Collaborator Author

gsomlo commented Dec 10, 2019

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)

@mithro
Copy link
Collaborator

mithro commented Dec 10, 2019

@xobs this is probably of interest to you.

@BracketMaster
Copy link

Nice!

@enjoy-digital
Copy link
Owner

@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.

@BracketMaster
Copy link

BracketMaster commented Mar 4, 2020

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants