Document epicardium API
Add to logix (https://card10.badge.events.ccc.de/):
- New modules are declared in epicardium/epicardium.h and implemented in epicardium/modules/*.c and include in epicardium/modules/meson.build
- use Sphinx doccomments
- use unique API IDs
- FreeRTOS tasks (you don't know in which task you run - wait for the right task)
- calls look same on both cores
- Use only types from stdlib or epicardium.h (do not include random other .h)
- tools to build Docs: python-sphinx, python-sphinx-hawkmoth (AUR: python-sphinx-hawkmoth-git)
- error handling:
errno
s as return values, don't pass pointers into epicardium address space to (py)cardium (https://www.kernel.org/doc/html/v4.10/process/coding-style.html#function-return-values-and-names) (also see #17 (closed))
(Probably check with @rahix for correctness.)