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
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
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
Marek
firmware
Commits
06ada12c
Verified
Commit
06ada12c
authored
5 years ago
by
rahix
Browse files
Options
Downloads
Patches
Plain Diff
doc: Update documentation
Signed-off-by:
Rahix
<
rahix@rahix.de
>
parent
df5e0d28
No related branches found
No related tags found
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
Documentation/epicardium/intro.rst
+15
-1
15 additions, 1 deletion
Documentation/epicardium/intro.rst
Documentation/pycardium/intro.rst
+9
-1
9 additions, 1 deletion
Documentation/pycardium/intro.rst
with
24 additions
and
2 deletions
Documentation/epicardium/intro.rst
+
15
−
1
View file @
06ada12c
Epicardium Intro
================
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.
API Design
----------
.. note::
This is the current design. We might adjust it in the future to allow for
more performance in cases where this approach is too slow.
The API is strictly synchroneous. This means, an API call looks exactly the
same as calling any other function. Internally, the call will wake up
Epicardium and dispatch the call. Once the call has finished, it will return a
result.
API Conventions
---------------
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
values denoting errors) if it is an action or imperative command. To quote:
...
...
This diff is collapsed.
Click to expand it.
Documentation/pycardium/intro.rst
+
9
−
1
View file @
06ada12c
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.
Pycardium also contains a number of Python stdlib modules. To see the full
list, type:
.. code-block:: python
help("modules")
The following pages detail card10 specific modules.
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