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

Document C code hardware drivers #133

Closed
npetersen2 opened this issue Jul 26, 2020 · 1 comment
Closed

Document C code hardware drivers #133

npetersen2 opened this issue Jul 26, 2020 · 1 comment
Assignees
Labels
docs Updates for docs.

Comments

@npetersen2
Copy link
Collaborator

Now that the C code drivers are maturing (i.e. ./drv/foo.c), we should make detailed documents about how to use them from a user perspective.

This should include:

  1. Brief explanation of how the internals of the driver work. Should link to the IP core docs if appropriate.
  2. Index of all available function calls and what they do.
  3. Example code which exercises the driver.
@npetersen2
Copy link
Collaborator Author

Closing since this issue belongs in the new docs.amdc.dev.

I recreated the issue over there:

Severson-Group/docs.amdc.dev#13

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

No branches or pull requests

1 participant