Skip to content

Clarify in README that v0.9 and v1.0 are withdrawn #80

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
jmarinho merged 1 commit into from
Dec 15, 2025
+6 −7
Merged

Clarify in README that v0.9 and v1.0 are withdrawn #80

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 6 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ This repository contains the Firmware Handoff specification, which defines a
data structure to transfer essential configuration information between firmware
stages during platform initialization.

Note that versions 0.9 and 1.0 of this specification are withdrawn and should not be used for product development.

Copy link
Contributor

@danh-arm danh-arm Nov 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think all the changes should be in the status section below, which is no longer accurate at all. Also, those versions are withdrawn, not deprecated. I think you could also say this is due to a mismatch in the checksum algorithm in the spec versus implementations (at least in the commit message).

The documentation is generated using the Sphinx framework. A version of this
specification, rendered in HTML, is available
[here](https://firmwarehandoff.github.io/firmware_handoff/).
Expand Down Expand Up @@ -47,11 +49,8 @@ The output of these build commands goes into subdirectory `build`.
Status
======

The first release of the specification has been published. We are currently in
the implementation phase, looking at various target projects, including U-Boot,
coreboot, TF-A and Tianocore. Once this is done we will review the result to see
if any serious flaws have come to light, meaning that changes are needed. If
so, these will be undertaken in each project.
As of November 2025, version 1.0 is withdrawn and should not be used.
Version 1.0 was withdrawn because products shipped with a TL header cheksum implementation that differed from the version 1.0 definition.
Copy link
Contributor

@danh-arm danh-arm Dec 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor: I think this file generally tries to stick to an 80 column limit.


By the end of 2024, the spec will be considered stable and will be published
as version 1. From there on, backwards compatibility will be maintained.
A version 2.0 of the specification is currently under work and will be published shortly.
Implementations should adopt version 2.0 of the specification.
Loading