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
7caa50af
Verified
Commit
7caa50af
authored
5 years ago
by
rahix
Browse files
Options
Downloads
Patches
Plain Diff
docs: Mention API Freeze Deadline
Signed-off-by:
Rahix
<
rahix@rahix.de
>
parent
abf87007
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
Documentation/epicardium-guide.rst
+13
-2
13 additions, 2 deletions
Documentation/epicardium-guide.rst
with
13 additions
and
2 deletions
Documentation/epicardium-guide.rst
+
13
−
2
View file @
7caa50af
...
@@ -31,8 +31,6 @@ There are a number of rules you should follow when defining new calls:
...
@@ -31,8 +31,6 @@ There are a number of rules you should follow when defining new calls:
* API calls have the prefix ``epic_`` which of course is just an abbreviation
* API calls have the prefix ``epic_`` which of course is just an abbreviation
for *Epicardium*.
for *Epicardium*.
* There are no special rules regarding call numbers, choose any number not yet
in use. Call numbers are ``uint32_t`` so you have plenty to choose from.
* Only use types from the standard library or types defined (and documented!)
* Only use types from the standard library or types defined (and documented!)
in ``epicardium.h``. **Never** include another header in ``epicardium.h``.
in ``epicardium.h``. **Never** include another header in ``epicardium.h``.
* When passing pointers, keep in mind that this will mean the other core will
* When passing pointers, keep in mind that this will mean the other core will
...
@@ -44,9 +42,22 @@ There are a number of rules you should follow when defining new calls:
...
@@ -44,9 +42,22 @@ There are a number of rules you should follow when defining new calls:
negative values denoting errors) if they are an imperative command or action
negative values denoting errors) if they are an imperative command or action
(ref `Kernel Coding Style`_). If you are reasonably sure your call cannot fail
(ref `Kernel Coding Style`_). If you are reasonably sure your call cannot fail
or an error is non-recoverable from core 1, return ``void``.
or an error is non-recoverable from core 1, return ``void``.
* There are no special rules regarding call numbers, choose any number not yet
in use. Call numbers are ``uint32_t`` so you have plenty to choose from.
.. _Kernel Coding Style: https://www.kernel.org/doc/html/v5.2/process/coding-style.html#function-return-values-and-names
.. _Kernel Coding Style: https://www.kernel.org/doc/html/v5.2/process/coding-style.html#function-return-values-and-names
.. warning::
After the 4th of August 00:00 UTC, **no** changes to existing IDs and the signature
and behavior of existing calls are allowed! This is necessary to ensure
compatibility of future firmware versions with older payloads. We call this
date the **API Freeze Deadline**. Addition of new calls will always be allowed.
In return this also means payloads compiled against a version of *Epicardium
API* released before that date are not guaranteed to work during and after
camp.
API Call Definition
API Call Definition
-------------------
-------------------
API calls should be defined in a source file in ``epicardium/modules``. If
API calls should be defined in a source file in ``epicardium/modules``. If
...
...
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