Verified Commit df5e0d28 authored by Rahix's avatar Rahix
Browse files

chore(doc): Restructure docs


Signed-off-by: Rahix's avatarRahix <rahix@rahix.de>
parent e9ca7b4d
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
......@@ -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
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
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment