New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[RFC] Private TBF TLV tag entry #1762
Conversation
Signed-off-by: Rajiv Ranganath <rajiv.ranganath@atihita.com>
I think this should be documented under the "TLV Elements" heading. One possibility is line 195 (the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 Seems like a useful parallel to the syscall driver numbering convention.
But we should capture this in the /docs as well.
Thanks for the feedback. I've added comments under section Please review. |
doc/TockBinaryFormat.md
Outdated
@@ -201,6 +203,12 @@ will be padded with up to 3 bytes. Each element begins with a 16-bit type and | |||
TBF may contain arbitrary element types. A standard set of element types are | |||
standardized. | |||
|
|||
The standard set of element types shall have its highest bit (bit 15) | |||
of `Type` unset. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"standard" is not defined here. The closest sentence to a definition ("A standard set of element types are standardized") needs a rewrite. This makes this section somewhat vague.
How about:
TBF may contain arbitrary element types. To avoid type ID collisions between elements defined by the Tock project and elements defined out-of-tree, the ID space is partitioned into two segments. Type IDs defined by the Tock project will have their high bit (bit 15) unset, and type IDs defined out-of-tree should have their high bit set.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the suggestion. I've applied it. Please review.
Corrected typo
16 byte specifier
to16 bit specifier
I would like to propose that we consider making TLV entries that have highest bit of the 16-bit tag specifier set for private use similar to how we do for
driver_num
Motivating reasons are -