Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
F
firmware
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
External wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Monitor
Service Desk
Analyze
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
card10
firmware
Commits
df5e0d28
Verified
Commit
df5e0d28
authored
5 years ago
by
rahix
Browse files
Options
Downloads
Patches
Plain Diff
chore(doc): Restructure docs
Signed-off-by:
Rahix
<
rahix@rahix.de
>
parent
e9ca7b4d
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
Documentation/epicardium/intro.rst
+5
-10
5 additions, 10 deletions
Documentation/epicardium/intro.rst
Documentation/index.rst
+11
-3
11 additions, 3 deletions
Documentation/index.rst
Documentation/pycardium/intro.rst
+5
-0
5 additions, 0 deletions
Documentation/pycardium/intro.rst
with
21 additions
and
13 deletions
Documentation/epicardium.rst
→
Documentation/epicardium
/intro
.rst
+
5
−
10
View file @
df5e0d28
Epicardium
==========
Epicardium
Intro
==========
======
Epicardium is the main firmware. It runs on core0 and is
based on FreeRTOS.
Epicardium provides an API to a payload running on the
other core which exposes
most functionality. This section of the docs details this "Epicardium API"
.
Epicardium is the main
component of the
firmware. It runs on core0 and is
based on FreeRTOS.
Epicardium provides an API to a payload running on the
other core which exposes most functionality
.
The API functions follow the kernel convention of either returning a boolean if
the function is a predicate or returning a success integer (with negative
...
...
@@ -33,8 +33,3 @@ values denoting errors) if it is an action or imperative command. To quote:
for success or -EBUSY for failure. In the same way, ``PCI device present`` is
a predicate, and the pci_dev_present() function returns 1 if it succeeds in
finding a matching device or 0 if it doesn't.
.. toctree::
:maxdepth: 1
epicardium/api
This diff is collapsed.
Click to expand it.
Documentation/index.rst
+
11
−
3
View file @
df5e0d28
...
...
@@ -12,7 +12,15 @@ The design roughly looks like this:
.. toctree::
:maxdepth: 2
:caption:
Contents
:caption:
Epicardium
epicardium
pycardium
epicardium/intro
epicardium/api
.. toctree::
:maxdepth: 2
:caption: Pycardium
pycardium/intro
pycardium/color
pycardium/leds
This diff is collapsed.
Click to expand it.
Documentation/pycardium.rst
→
Documentation/pycardium
/intro
.rst
+
5
−
0
View file @
df5e0d28
Pycardium
=========
Pycardium
Intro
=========
======
Pycardium is a core1 payload based on MicroPython. It can interface with
card10 using the Epicardium API, which is wrapped in a bunch of python modules.
These modules are documented in this section.
.. toctree::
:maxdepth: 1
:caption: Modules:
pycardium/color
pycardium/leds
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment