Add constants for fast path resume copying
[coreboot.git] / README
1 -------------------------------------------------------------------------------
2 coreboot README
3 -------------------------------------------------------------------------------
4
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.
9
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.
17
18 coreboot was formerly known as LinuxBIOS.
19
20
21 Payloads
22 --------
23
24 After the basic initialization of the hardware has been performed, any
25 desired "payload" can be started by coreboot.
26
27 See http://www.coreboot.org/Payloads for a list of supported payloads.
28
29
30 Supported Hardware
31 ------------------
32
33 coreboot supports a wide range of chipsets, devices, and mainboards.
34
35 For details please consult:
36
37  * http://www.coreboot.org/Supported_Motherboards
38  * http://www.coreboot.org/Supported_Chipsets_and_Devices
39
40
41 Build Requirements
42 ------------------
43
44  * gcc / g++
45  * make
46
47 Optional:
48
49  * doxygen (for generating/viewing documentation)
50  * iasl (for targets with ACPI support)
51  * gdb (for better debugging facilities on some targets)
52  * ncurses (for 'make menuconfig')
53  * flex and bison (for regenerating parsers)
54
55
56 Building coreboot
57 -----------------
58
59 Please consult http://www.coreboot.org/Build_HOWTO for details.
60
61
62 Testing coreboot Without Modifying Your Hardware
63 ------------------------------------------------
64
65 If you want to test coreboot without any risks before you really decide
66 to use it on your hardware, you can use the QEMU system emulator to run
67 coreboot virtually in QEMU.
68
69 Please see http://www.coreboot.org/QEMU for details.
70
71
72 Website and Mailing List
73 ------------------------
74
75 Further details on the project, a FAQ, many HOWTOs, news, development
76 guidelines and more can be found on the coreboot website:
77
78   http://www.coreboot.org
79
80 You can contact us directly on the coreboot mailing list:
81
82   http://www.coreboot.org/Mailinglist
83
84
85 Copyright and License
86 ---------------------
87
88 The copyright on coreboot is owned by quite a large number of individual
89 developers and companies. Please check the individual source files for details.
90
91 coreboot is licensed under the terms of the GNU General Public License (GPL).
92 Some files are licensed under the "GPL (version 2, or any later version)",
93 and some files are licensed under the "GPL, version 2". For some parts, which
94 were derived from other projects, other (GPL-compatible) licenses may apply.
95 Please check the individual source files for details.
96
97 This makes the resulting coreboot images licensed under the GPL, version 2.
98