Skip to content

Clarify in spec that device id can never be 0 #557

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.

Sign up for GitHub

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

Merged
chrispsommers merged 5 commits into from
Jun 13, 2025
Merged

Clarify in spec that device id can never be 0 #557

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3dacb86
Clarify in spec that device id can never be 0
verios-google May 9, 2025
2a084bc
Addressed comment
verios-google May 9, 2025
d1cad5b
Fixed lint issue
verios-google May 9, 2025
f28e303
Addressed comments
verios-google May 14, 2025
25b0631
Addressing comments
verios-google Jun 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/v1/P4Runtime-Spec.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -601,14 +601,19 @@ their write requests. gRPC provides authentication methods cite:[gRPCAuth] that
should be deployed to prevent untrusted clients from creating channels, and thus
from making changes or even reading the state of the server.

=== Default Role
=== Default Role and Default Device ID

A controller can omit the role message in `MasterArbitrationUpdate`. This
implies the "default role", which corresponds to "full pipeline access".
This also implies that a default role has a `role_id` of `""` (default).
If using a default role, all RPCs from the controller (e.g. `Write`) must
leave the `role` unset.

The "default device_id" corresponds to `0`. As mentioned [previously](#sec-default-valued-fields),
an application is unable to distinguish between unset vs default valued scalar
fields. Some requests (e.g. [Cabilities](#sec-capabilities-rpc)) uniquely handle an unset `device_id`.
Therefore, a device must NEVER be assigned a `device_id` of 0.

[#sec-arbitration-role-config]
=== Role Config

Expand Down Expand Up @@ -6027,6 +6032,7 @@ error {
}
----

[#sec-capabilities-rpc]
== `Capabilities` RPC

The `Capabilities` RPC offers a mechanism through which a P4Runtime client can
Expand Down