openwrt/flashrom
1
0
Fork 0
mirror of https://review.coreboot.org/flashrom.git synced 2025-08-15 19:40:19 +02:00
Code Issues Releases Wiki Activity

doc: Release notes for v1.6.0

Browse Source 
Change-Id: I7067f0756bd7a3e6387039cbc4290526723dc4d8
Signed-off-by: Anastasia Klimchuk <aklm@flashrom.org>
Reviewed-on: https://review.coreboot.org/c/flashrom/+/88321
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Peter Marheine <pmarheine@chromium.org>
This commit is contained in:
Anastasia Klimchuk
2025-07-05 22:36:56 +10:00
parent 546c74e1fc
commit b0cdde91db
3 changed files with 183 additions and 97 deletions
Download Patch File Download Diff File Expand all files Collapse all files

97
doc/release_notes/devel.rst
View File

@@ -16,100 +16,3 @@ Systems with AMD "Promontory" IO extenders (mostly "Zen" desktop platforms) are
not currently supported.
https://ticket.coreboot.org/issues/370
flashchips.c split into separate files by vendor
================================================
``flashchips.c`` file was split into separate files per vendor. flashchips.c still exists in the source
code but it is much smaller and only contain "generic" chip entries.
With this, instead of one file ``flashchips.c`` we now have a ``flashchips/`` directory which contains
all the files.
There are no changes to the usage, and everything that's supported stays the same.
New features
============
-r/-w/-v argument is optional when using -i
-------------------------------------------
See :doc:`/classic_cli_manpage` for details.
Hall of Fame added to documentation
-----------------------------------
The flashrom HTML documentation (and web site) now includes an
automatically-generated list of historical contributors, to acknowledge
everybody who has made flashrom into what it is:
:doc:`../about_flashrom/hall_of_fame`.
When building the documentation, the ``generate_authors_list`` Meson option will
cause the lists to be generated, requiring a runnable copy of Git on the system
and that the source tree being built is a Git working copy. If those
requirements are not satisfied or the option is disabled, the authors lists will
be replaced with placeholders unless the ``generate_authors_list`` option is set
to ``enabled`` in which case the build will fail if the requirements are not
satisfied.
Programmer updates
------------------
* spidriver: Add support for the Excamera Labs SPIDriver
libflashrom API updates
=======================
New API for progress reporting
------------------------------------------
The old ``flashrom_set_progress_callback`` function for requesting progress updates
during library operations is now deprecated. Users should call
``flashrom_set_progress_callback_v2`` instead, which also changes the signature
of the callback function. Specifically, new function type ``flashrom_progress_callback_v2``
should be used from now on.
This new API fixes limitations with the old one where most users would need to
define their own global state to track progress, and it was impossible to fix that
issue while maintaining binary compatibility without adding a new API.
New API for logging and setting log level
-----------------------------------------
New API ``flashrom_set_log_callback_v2`` is added which allows the users to provide
a pointer to user data, the latter is managed by the caller of the API. New API also
introduces a new signature for log callback function, ``flashrom_log_callback_v2``.
New API supports setting the log level for messages from libflashrom, ``flashrom_set_log_level``.
The log callback is invoked only for the messages with log level less or equal than the one
requested (i.e. only for the messages at least as urgent as the level requested).
Old API ``flashrom_set_log_callback`` without user data continues to work as before.
New API for probing flashchips
------------------------------
New API for probing is added ``flashrom_flash_probe_v2`` which can (if requested)
go through all known flashchips and find all matches. v2 returns the number of matches
found (or 0 if none found) and the list of names of all matched entries.
``flashrom_flash_probe_v2`` continues to support an optional parameter ``chip_name``
if the caller want to probe for only one specific chip with given name.
Command line interface is now using ``flashrom_flash_probe_v2``.
Old API ``flashrom_flash_probe`` is deprecated. It stays available "as is" for now,
however will be removed at some point in future. Users should switch to v2.
The main reason for deprecation is that it was returning incomplete information in
case when multiple matching chips were found during probing. Specifically, the only
info returned was error code of "multiple chips match" with no details of which are
the matches and how many. This left the caller unable to proceed further. Consequently,
even flashrom's own command line interface was unable to use old libflashrom probing API,
and had to maintain separate logic for probing.
New API to get list of supported programmers
--------------------------------------------
New API ``flashrom_supported_programmers`` returns the list of all programmers that are
supported on a current run environment.