Driver development guide #343
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
keith-packard
requested review from
bsousi5 and
nategraff-sifive
as code owners
keith-packard
force-pushed
the
driver-development-guide
branch
from
2d3caf6 to
3d465ad
Compare
nategraff-sifive
suggested changes
Oct 1, 2020
doc/sphinx/driver.rst
Outdated
| -------------- | ||
|
|
||
| To incorporate Device Tree data into the compiled driver, Freedom | ||
| Metal uses [Jinja](https://jinja.palletsprojects.com) templates. This |
There was a problem hiding this comment.
reStructuredText uses a different syntax for links
doc/mee-spec.md
Outdated
| @@ -0,0 +1,170 @@ | |||
| # MEE Specification | |||
There was a problem hiding this comment.
This file should probably not be put back.
Signed-off-by: Keith Packard <[email protected]>
Include more APIs. Fix exception/interrupt discussion. Signed-off-by: Keith Packard <[email protected]>
Signed-off-by: Keith Packard <[email protected]>
This outlines how a Freedom Metal driver should be written. Signed-off-by: Keith Packard <[email protected]>
This makes the tool name unique, which is useful for documentation. Signed-off-by: Keith Packard <[email protected]>
This switches how interrupts are named in the application configuration file from the actual IRQ number to the index within the device 'interrupts' list, allowing .ini files to be relatively independent of the interrupt mapping of the target device. Signed-off-by: Keith Packard <[email protected]>
rst uses a different syntax for links; adapt source code to match. Move information about freedom-metal-generate to a new 'generate' chapter'. Signed-off-by: Keith Packard <[email protected]>
Use suggested syntax for chapter headers (surrounded by asterisks). Clean up some minor sphinx errors where invalid code-block tags were used. Remove missing chapters from toc. Signed-off-by: Keith Packard <[email protected]>
This directory doesn't exist. Signed-off-by: Keith Packard <[email protected]>
keith-packard
force-pushed
the
driver-development-guide
branch
from
3d465ad to
e947bc9
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.