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

Add a simplified diagram of the SoC in the README? #2

Closed
enjoy-digital opened this issue Dec 18, 2020 · 6 comments
Closed

Add a simplified diagram of the SoC in the README? #2

enjoy-digital opened this issue Dec 18, 2020 · 6 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@enjoy-digital
Copy link
Member

Adding a simplified / minimal diagram of the SoC to the README would I think provide a quick and better overview of the aim of the project and what's built with it.

Here is a first attempt I just did:

@gsomlo: If you could be interested, happy to review / do changes to it and create a PR to the README. I also don't want to change the style of the project or transform it, so if you have preference for a full text README or wants to create your own diagram, feel to reject this.

@enjoy-digital enjoy-digital added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 18, 2020
@gsomlo
Copy link
Collaborator

gsomlo commented Dec 18, 2020

@enjoy-digital: diagram looks great, thanks for creating it, and looking forward to the PR!

One thought: right now the DMA bus is essentially a point-to-point link between Rocket and LiteSDCard, but would you lay it out slightly differently knowing that we might one day (hopefully soon) add LiteSATA to the design, which will also need to be connected to the DMA bus? Making sure that addition will require minimal (visual) re-arrangement of the existing components might be worth a few seconds' thought :)

Finally, not sure if we want to add IRQs to the diagram or not (probably not, but just thinking out loud).

@enjoy-digital
Copy link
Member Author

@gsomlo: Thanks for the feedback, is it better like this? (rearranged the DMA + added IRQs):

LiteX(13)

Also, do you want the LiteX-Hub logo on it ? (feel free to say no, I just added it here to show you)

@gsomlo
Copy link
Collaborator

gsomlo commented Dec 18, 2020

@enjoy-digital: looks good, thanks! Also, LiteX-Hub logo is fine with me (although, visually, I'd probably place it somewhere underneath /dev/ttyUSBX on the left (probably aligned with the bottom of the rest of the image) where it wouldn't have to stick out vertically. It's a minor thing, perfectly OK where it is now if "bottom-right" is sort-of a standard for logo placement...

@enjoy-digital
Copy link
Member Author

PR #3 created with:

I'll also share with you the source of this diagram.

gsomlo added a commit that referenced this issue Dec 18, 2020
README: add simplified SoC diagram after short intro as discussed in #2.
@gsomlo
Copy link
Collaborator

gsomlo commented Dec 18, 2020

Thanks again, looks really good. Depending on what the source looks like, we might want to make that part of the repo itself -- what do you think?

@gsomlo
Copy link
Collaborator

gsomlo commented Dec 18, 2020

resolved by merging PR #3 -- Thanks again @enjoy-digital for putting it together!

@gsomlo gsomlo closed this as completed Dec 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants