Skip to content

Driver development guide#343

Open
keith-packard wants to merge 9 commits intofreedom-metal-nextfrom
driver-development-guide
Open

Driver development guide#343
keith-packard wants to merge 9 commits intofreedom-metal-nextfrom
driver-development-guide

Conversation

@keith-packard
Copy link
Contributor

No description provided.

@keith-packard keith-packard removed the request for review from bsousi5 September 24, 2020 17:57
@keith-packard keith-packard changed the base branch from master to freedom-metal-next September 24, 2020 17:58
@keith-packard keith-packard force-pushed the driver-development-guide branch from 2d3caf6 to 3d465ad Compare September 24, 2020 21:05
Copy link
Contributor

@nategraff-sifive nategraff-sifive left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Found some changes I'd like made so far.

--------------

To incorporate Device Tree data into the compiled driver, Freedom
Metal uses [Jinja](https://jinja.palletsprojects.com) templates. This
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reStructuredText uses a different syntax for links

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

doc/mee-spec.md Outdated
@@ -0,0 +1,170 @@
# MEE Specification
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file should probably not be put back.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

Signed-off-by: Keith Packard <keithp@keithp.com>
Include more APIs.
Fix exception/interrupt discussion.

Signed-off-by: Keith Packard <keithp@keithp.com>
Signed-off-by: Keith Packard <keithp@keithp.com>
This outlines how a Freedom Metal driver should be written.

Signed-off-by: Keith Packard <keithp@keithp.com>
This makes the tool name unique, which is useful for documentation.

Signed-off-by: Keith Packard <keithp@keithp.com>
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 <keithp@keithp.com>
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 <keithp@keithp.com>
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 <keithp@keithp.com>
This directory doesn't exist.

Signed-off-by: Keith Packard <keithp@keithp.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants