Documentation/index.md

   1 # Welcome to the coreboot documentation
   2
   3 This is the developer documentation for [coreboot](https://coreboot.org).
   4 It is built from Markdown files in the
   5 [Documentation](https://review.coreboot.org/cgit/coreboot.git/tree/Documentation)
   6 directory in the source code.
   7
   8 ## Purpose of coreboot
   9
  10 coreboot is a project to develop open source boot firmware for various
  11 architectures. Its design philosophy is to do the bare minimum necessary to
  12 ensure that hardware is usable and then pass control to a different program
  13 called the _payload_.
  14
  15 ### Separation of concerns
  16
  17 The payload can then provide user interfaces, file system drivers,
  18 various policies etc. to load the OS. Through this separation of concerns
  19 coreboot maximizes reusability of the complicated and fundamental hardware
  20 initialization routines across many different use cases, no matter if
  21 they provide standard interfaces or entirely custom boot flows.
  22
  23 Popular [payloads](payloads.md) in use with coreboot are SeaBIOS,
  24 which provides PCBIOS services, Tianocore, which provides UEFI services,
  25 GRUB2, the bootloader used by many Linux distributions, or depthcharge,
  26 a custom boot loader used on Chromebooks.
  27
  28 ### No resident services (if possible)
  29
  30 Ideally coreboot completely hands over control to the payload with no
  31 piece of coreboot remaining resident in the system, or even available
  32 for callback.  Given the reality of contemporary computer design,
  33 there's often a small piece that survives for the whole runtime of
  34 the computer. It runs in a highly privileged CPU mode (e.g. SMM on x86)
  35 and provides some limited amount of services to the OS. But here, too,
  36 coreboot aims to keep everything at the minimum possible, both in scope
  37 (e.g. services provided) and code size.
  38
  39 ### No specification of its own
  40
  41 coreboot uses a very minimal interface to the payload, and otherwise
  42 doesn't impose any standards on the ecosystem. This is made possible by
  43 separating out concerns (interfaces and resident services are delegated
  44 to the payload), but it's also a value that is deeply ingrained in the
  45 project. We fearlessly rip out parts of the architecture and remodel it
  46 when a better way of doing the same was identified.
  47
  48 That said, since there are attempts to coerce coreboot to move in various
  49 directions by outside "standardization", long-established practices of
  50 coreboot as well as aligned projects can be documented as best practices,
  51 making them standards in their own right. However we reserve the right to
  52 retire them as the landscape shifts around us.
  53
  54 ### One tree for everything
  55
  56 Another difference to various other firmware projects is that we try
  57 to avoid fragmentation: the traditional development model of firmware
  58 is one of "set and forget" in which some code base is copied, adapted
  59 for the purpose at hands, shipped and only touched again if there's an
  60 important fix to do.
  61
  62 All newer development happens on another copy of some code base without
  63 flowing back to any older copy, and so normally there's a huge amount
  64 of fragmentation.
  65
  66 In coreboot, we try to keep everything in a single source tree, and
  67 lift up older devices when we change something fundamentally. That way,
  68 new and old devices benefit alike from new development in the common parts.
  69
  70 There's a downside to that: Some devices might have no maintainer anymore
  71 who could ensure that coreboot is still functional for them after a big
  72 rework, or maybe a rework even requires knowledge that doesn't exist
  73 anymore within the project (for example because the developer moved on
  74 to do something else).
  75
  76 In this case, we announce the deprecation of the device and defer the big
  77 rework until the deprecation period passed, typically 6-12 months. This
  78 gives interested developers a chance to step in and bring devices up to
  79 latest standards.
  80
  81 While without this deprecation mechanism we could inflate the number
  82 of supported devices (probably 300+), only a tiny fraction of them
  83 would even work, which helps nobody.
  84
  85 ## Scope of the coreboot project
  86
  87 coreboot as a project is closer to the Linux kernel than to most
  88 user level programs. One place where this becomes apparent is the
  89 distribution mechanism: The project itself only provides source code
  90 and does not ship ready-to-install coreboot-based firmware binaries.
  91
  92 What the project distributes, even if - strictly speaking - it's not
  93 part of the project, is a collection of vendor binaries (that we call
  94 "blobs") that are redistributable. They cover the parts of hardware init
  95 that we haven't managed to open up, and while some hardware requires them,
  96 there's still hardware that can boot without any such binary components.
  97
  98 The build system can integrate them into the build automatically if
  99 required, but that requires explicit opt-in and downloads a separate
 100 repository to ensure that the distinction remains clear.
 101
 102 There are various [distributions](distributions.md), some shipping
 103 coreboot with their hardware (e.g. Purism or Chromebooks), others
 104 providing after-market images for various devices (e.g. Libreboot,
 105 MrChromebox).
 106
 107 If you want to use coreboot on your system, that's great!
 108
 109 Please note that the infrastructure around coreboot.org is built for
 110 development purposes. We gladly help out users through our communication
 111 channels, but we also expect a "firmware developer mindset": If compiling
 112 your own firmware and, at some point, recovering from a bad flash by
 113 hooking wires onto chips in your computer sounds scary to you, you're
 114 right, as it is.
 115
 116 If that's _way_ beyond your comfort zone, consider looking into the
 117 various distributions, as they typically provide pre-tested binaries
 118 which massively reduces the risk that the binary you write to flash is
 119 one that won't boot the system (with the consequence that to get it to work
 120 again, you'll need to attach various tools to various chips)
 121
 122 ## The coreboot community
 123
 124 If you're interested in getting your hands dirty (incl. potentially wiring
 125 up an external flasher to your computer), you've come to the right place!
 126
 127 We have various [forums](community/forums.md) where we discuss and coordinate
 128 our activities, review patches, and help out each other. To
 129 help promote a positive atmosphere, we established a [Code of
 130 Conduct](community/code_of_conduct.md). We invested a lot of time
 131 to balance it out, so please keep it in mind when engaging with the
 132 coreboot community.
 133
 134 Every now and then, coreboot is present in one way or another at
 135 [conferences](community/conferences.md). If you're around, come and
 136 say hello!
 137
 138 ## Getting the source code
 139
 140 coreboot is primarily developed in the
 141 [git](https://review.coreboot.org/cgit/coreboot.git) version control
 142 system, using [Gerrit](https://review.coreboot.org) to manage
 143 contributions and code review.
 144
 145 In general we try to keep the `master` branch in the repository functional
 146 for all hardware we support. So far, the only guarantee we can make is
 147 that the master branch will (nearly) always build for all boards in a
 148 standard configuration.
 149
 150 However, we're continually working on improvements to our infrastructure to
 151 get better in that respect, e.g. by setting up boot testing facilities. This
 152 is obviously more complex than regular integration testing, so progress
 153 is slow.
 154
 155 ### What our releases mean
 156
 157 We also schedule two source code releases every year, around April and
 158 October. These releases see some very limited testing and mostly serve
 159 as synchronization points for deprecation notices and for other projects
 160 such as external distributions.
 161
 162 This approach and terminology differs somewhat from how other projects handle
 163 releases where releases are well-tested artifacts and the development
 164 repository tends to be unstable. The "rolling release" model of some projects,
 165 for example OpenBSD, is probably the closest cousin of our approach.
 166
 167 Contents:
 168
 169 * [Getting Started](getting_started/index.md)
 170 * [Tutorial](tutorial/index.md)
 171 * [Contributing](contributing/index.md)
 172 * [Community](community/index.md)
 173 * [Payloads](payloads.md)
 174 * [Distributions](distributions.md)
 175 * [Technotes](technotes/index.md)
 176 * [ACPI](acpi/index.md)
 177 * [Native Graphics Initialization with libgfxinit](gfx/libgfxinit.md)
 178 * [Display panel](gfx/display-panel.md)
 179 * [CPU Architecture](arch/index.md)
 180 * [Platform independent drivers](drivers/index.md)
 181 * [Northbridge](northbridge/index.md)
 182 * [System on Chip](soc/index.md)
 183 * [Mainboard](mainboard/index.md)
 184 * [Payloads](lib/payloads/index.md)
 185 * [Libraries](lib/index.md)
 186 * [Options](lib/option.md)
 187 * [Security](security/index.md)
 188 * [SuperIO](superio/index.md)
 189 * [Vendorcode](vendorcode/index.md)
 190 * [Utilities](util.md)
 191 * [coreboot infrastructure](infrastructure/index.md)
 192 * [Release notes](releases/index.md)
 193 * [Flashing firmware tutorial](flash_tutorial/index.md)