Libflashrom: Difference between revisions

From flashprog
Jump to navigation Jump to search
Uwe@flashrom.org/ (talk)
("Uwe@flashrom.org/: Start documenting libflashrom status, TODOs, API, etc.")
 
("nico.h@gmx.de: Rename flashrom -> flashprog")
Tag: Replaced
 
(8 intermediate revisions by 4 users not shown)
Line 1: Line 1:
'''libflashrom''' is a shared library which can be used to write programs which need to detect/read/write/erase flash ROM chips using various programmers.
[[Category:Deleted]]
 
It is, among other things, useful so that different frontends can be written (a command-line tool, various GUIs, libpayload integration, others).
 
== Status ==
 
Work in progress.
 
== Building ==
 
$ '''make libflashrom.a'''
 
== API ==
 
...
 
== TODO ==
 
This is a random list of TODO items which need to be fixed in order to make a usable and useful libflashrom.
 
* There should be one single '''flashrom.h''' or '''libflashrom.h''' include file, which contains (only!) the function prototypes and macros which belong to the public libflashrom API.
* All functions and macros of the public API should have a prefix in order to not pollute the namespace of the programs that link against libflashrom.
** Suggestion: '''fl_''' and '''FL_'''. Examples: '''fl_init()''' or '''FL_ERR_MALLOC'''.
* No function in libflashrom is allowed to call '''exit()'''.
* All public API functions should return meaningful and unique error codes (which should have useful macros/names such as '''FL_OK''', '''FL_ERR_MALLOC''', etc.).
* pkg-config support would be nice, i.e., some simple '''libflashrom.pc''' file.

Latest revision as of 17:46, 3 December 2023