soc/amd/common/block/include/amdblocks/psp.h: Replace todo message
[coreboot.git] / README
blob651aa6191c6327d5e9ff43d85ee0bcf71c2b2392
1 -------------------------------------------------------------------------------
2 coreboot README
3 -------------------------------------------------------------------------------
5 coreboot is a Free Software project aimed at replacing the proprietary BIOS
6 (firmware) found in most computers.  coreboot performs a little bit of
7 hardware initialization and then executes additional boot logic, called a
8 payload.
10 With the separation of hardware initialization and later boot logic,
11 coreboot can scale from specialized applications that run directly
12 firmware, run operating systems in flash, load custom
13 bootloaders, or implement firmware standards, like PC BIOS services or
14 UEFI. This allows for systems to only include the features necessary
15 in the target application, reducing the amount of code and flash space
16 required.
18 coreboot was formerly known as LinuxBIOS.
21 Payloads
22 --------
24 After the basic initialization of the hardware has been performed, any
25 desired "payload" can be started by coreboot.
27 See https://www.coreboot.org/Payloads for a list of supported payloads.
30 Supported Hardware
31 ------------------
33 coreboot supports a wide range of chipsets, devices, and mainboards.
35 For details please consult:
37  * https://www.coreboot.org/Supported_Motherboards
38  * https://www.coreboot.org/Supported_Chipsets_and_Devices
41 Build Requirements
42 ------------------
44  * make
45  * gcc / g++
46    Because Linux distribution compilers tend to use lots of patches. coreboot
47    does lots of "unusual" things in its build system, some of which break due
48    to those patches, sometimes by gcc aborting, sometimes - and that's worse -
49    by generating broken object code.
50    Two options: use our toolchain (eg. make crosstools-i386) or enable the
51    ANY_TOOLCHAIN Kconfig option if you're feeling lucky (no support in this
52    case).
53  * iasl (for targets with ACPI support)
54  * pkg-config
55  * libssl-dev (openssl)
57 Optional:
59  * doxygen (for generating/viewing documentation)
60  * gdb (for better debugging facilities on some targets)
61  * ncurses (for 'make menuconfig' and 'make nconfig')
62  * flex and bison (for regenerating parsers)
65 Building coreboot
66 -----------------
68 Please consult https://www.coreboot.org/Build_HOWTO for details.
71 Testing coreboot Without Modifying Your Hardware
72 ------------------------------------------------
74 If you want to test coreboot without any risks before you really decide
75 to use it on your hardware, you can use the QEMU system emulator to run
76 coreboot virtually in QEMU.
78 Please see https://www.coreboot.org/QEMU for details.
81 Website and Mailing List
82 ------------------------
84 Further details on the project, a FAQ, many HOWTOs, news, development
85 guidelines and more can be found on the coreboot website:
87   https://www.coreboot.org
89 You can contact us directly on the coreboot mailing list:
91   https://www.coreboot.org/Mailinglist
94 Copyright and License
95 ---------------------
97 The copyright on coreboot is owned by quite a large number of individual
98 developers and companies. Please check the individual source files for details.
100 coreboot is licensed under the terms of the GNU General Public License (GPL).
101 Some files are licensed under the "GPL (version 2, or any later version)",
102 and some files are licensed under the "GPL, version 2". For some parts, which
103 were derived from other projects, other (GPL-compatible) licenses may apply.
104 Please check the individual source files for details.
106 This makes the resulting coreboot images licensed under the GPL, version 2.