Clarify TimeAlarm relay and ACPI contracts - #47
Merged
Merged
Conversation
Document the existing nine-command mapping, setter status, timestamp padding compatibility, and relevant FF-A sample offsets without adding wake or notification integration. Assisted-by: GitHub Copilot:gpt-6-astra Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Distinguish method-specific failure values from relay status, return a timestamp buffer, and declare the required arguments. Document existing timestamp decoder compatibility restrictions. Assisted-by: GitHub Copilot:gpt-6-astra Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
Two documentation corrections remain for scalar fallback values and the _GRT argument count.
Get a fresh assessment by requesting another Copilot review.
Review effort: Lite
Findings: 1
Open (1)
What changed in this PR
Clarifies the nine-command TimeAlarm relay and ACPI contracts.
Changes:
- Documents command layouts, response IDs, and status conventions.
- Corrects ACPI examples and argument-count requirements.
- Records timestamp compatibility and decoder limitations.
| File | Summary |
|---|---|
docs/src/specs/ec_interface/ffa/time-alarm.md |
Updates TimeAlarm relay and ACPI documentation. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Clarify that SP response sentinels differ from the ACPI examples fallback policy when FF-A delivery fails or is unavailable. Assisted-by: GitHub Copilot:gpt-6-astra Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
RobertZ2011
approved these changes
Sep 23, 2026
kat-perez
approved these changes
Sep 24, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Clarify the existing nine-command TimeAlarm interface, including policy commands 8/9, argument layouts, relay response IDs, and FF-A status placement.
Distinguish the transport status convention from normative ACPI method results: _SRT failure is 0xFFFFFFFF; _CWS, _STV, and _STP failure is 1. Correct directly conflicting examples to return a timestamp Buffer from _GRT and declare required argument counts. Document timestamp-padding compatibility and existing milliseconds/daylight decoder restrictions without presenting them as ACPI errata.
Closes #46.
This is documentation only. Physical wake, power integration, notifications, executable-ASL qualification, and the retired peripheral-memory interface remain outside scope. The examples are illustrative and are not claimed to be validated by tests of the separate shipped platform ASL.
Validation
mdbook build docs passes. It reports an existing unrelated unclosed-tag warning in the HID battery document.
Related broader work: OpenDevicePartnership/embedded-services#156 and OpenDevicePartnership/embedded-services#149.