619086d105
In the last coreboot leadership meeting, the doxygen documentation was declared to be dead. Remove it. Doxygen style comments can still be added to files, and we may generate doxygen based documentation, but it won't be for the entire project, but instead just for those individual areas where it is being maintained. Signed-off-by: Martin Roth <gaumless@gmail.com> Change-Id: I8983a20793786a18d2331763660842fea836aa2a Reviewed-on: https://review.coreboot.org/c/coreboot/+/64228 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Felix Singer <felixsinger@posteo.net> Reviewed-by: Paul Menzel <paulepanter@mailbox.org>
103 lines
3.2 KiB
Markdown
103 lines
3.2 KiB
Markdown
coreboot README
|
|
===============
|
|
|
|
coreboot is a Free Software project aimed at replacing the proprietary BIOS
|
|
(firmware) found in most computers. coreboot performs a little bit of
|
|
hardware initialization and then executes additional boot logic, called a
|
|
payload.
|
|
|
|
With the separation of hardware initialization and later boot logic,
|
|
coreboot can scale from specialized applications that run directly
|
|
firmware, run operating systems in flash, load custom
|
|
bootloaders, or implement firmware standards, like PC BIOS services or
|
|
UEFI. This allows for systems to only include the features necessary
|
|
in the target application, reducing the amount of code and flash space
|
|
required.
|
|
|
|
coreboot was formerly known as LinuxBIOS.
|
|
|
|
|
|
Payloads
|
|
--------
|
|
|
|
After the basic initialization of the hardware has been performed, any
|
|
desired "payload" can be started by coreboot.
|
|
|
|
See <https://www.coreboot.org/Payloads> for a list of supported payloads.
|
|
|
|
|
|
Supported Hardware
|
|
------------------
|
|
|
|
coreboot supports a wide range of chipsets, devices, and mainboards.
|
|
|
|
For details please consult:
|
|
|
|
* <https://www.coreboot.org/Supported_Motherboards>
|
|
|
|
|
|
Build Requirements
|
|
------------------
|
|
|
|
* make
|
|
* gcc / g++
|
|
Because Linux distribution compilers tend to use lots of patches. coreboot
|
|
does lots of "unusual" things in its build system, some of which break due
|
|
to those patches, sometimes by gcc aborting, sometimes - and that's worse -
|
|
by generating broken object code.
|
|
Two options: use our toolchain (eg. make crosstools-i386) or enable the
|
|
`ANY_TOOLCHAIN` Kconfig option if you're feeling lucky (no support in this
|
|
case).
|
|
* iasl (for targets with ACPI support)
|
|
* pkg-config
|
|
* libssl-dev (openssl)
|
|
|
|
Optional:
|
|
|
|
* gdb (for better debugging facilities on some targets)
|
|
* ncurses (for `make menuconfig` and `make nconfig`)
|
|
* flex and bison (for regenerating parsers)
|
|
|
|
|
|
Building coreboot
|
|
-----------------
|
|
|
|
Please consult <https://www.coreboot.org/Build_HOWTO> for details.
|
|
|
|
|
|
Testing coreboot Without Modifying Your Hardware
|
|
------------------------------------------------
|
|
|
|
If you want to test coreboot without any risks before you really decide
|
|
to use it on your hardware, you can use the QEMU system emulator to run
|
|
coreboot virtually in QEMU.
|
|
|
|
Please see <https://www.coreboot.org/QEMU> for details.
|
|
|
|
|
|
Website and Mailing List
|
|
------------------------
|
|
|
|
Further details on the project, a FAQ, many HOWTOs, news, development
|
|
guidelines and more can be found on the coreboot website:
|
|
|
|
<https://www.coreboot.org>
|
|
|
|
You can contact us directly on the coreboot mailing list:
|
|
|
|
<https://www.coreboot.org/Mailinglist>
|
|
|
|
|
|
Copyright and License
|
|
---------------------
|
|
|
|
The copyright on coreboot is owned by quite a large number of individual
|
|
developers and companies. Please check the individual source files for details.
|
|
|
|
coreboot is licensed under the terms of the GNU General Public License (GPL).
|
|
Some files are licensed under the "GPL (version 2, or any later version)",
|
|
and some files are licensed under the "GPL, version 2". For some parts, which
|
|
were derived from other projects, other (GPL-compatible) licenses may apply.
|
|
Please check the individual source files for details.
|
|
|
|
This makes the resulting coreboot images licensed under the GPL, version 2.
|