Update Box ID API documentation #344
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
meriac
reviewed
Sep 27, 2016
docs/api/API.md
Outdated
| <td>Return value</td> | ||
| <td colspan="2">The ID of the caller box, or -1 if there is no secure gateway calling box</td> | ||
| <td>`box_id_caller` value</td> | ||
| <td colspan="2">After a call, `box_id_caller` is set to the box ID of the calling box (the source box of the RPC). This is set before the RPC is dispatched, so that the RPC target function can read from this location to determine the calling box ID. This parameter is optional. PROTIP: When deciding which memory to provide for rpc_fncall_waitfor to use when writing box_id_caller, strongly prefer thread local storage when multiple threads in a box can handle incomign RPC.</td> |
Contributor
There was a problem hiding this comment.
@Patater Please don't use PROTIP, but blockquotes instead.
Patater
force-pushed
the
box-id-api-doc
branch
2 times, most recently
from
2e1513b to
d787a8d
Compare
Now that the RTOS integration has completed and RPC is available, how the Box ID API works has changed a bit. Update the documentation to reflect how the Box ID API works now.
Patater
force-pushed
the
box-id-api-doc
branch
from
d787a8d to
e1dbceb
Compare
|
retest uvisor |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Now that the RTOS integration has completed and RPC is available, how
the Box ID API works has changed a bit. Update the documentation to
reflect how the Box ID API works now.
@AlessandroA @niklas-arm @meriac
Preview https://github.com/Patater/uvisor/blob/box-id-api-doc/docs/api/API.md#box-identity