diff options
Diffstat (limited to 'documentation/ref-manual/classes.rst')
-rw-r--r-- | documentation/ref-manual/classes.rst | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 22c4301a49..8ad77319ec 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst | |||
@@ -128,6 +128,43 @@ It's useful to have some idea of how the tasks defined by the | |||
128 | - :ref:`ref-tasks-install` --- runs ``make install`` and | 128 | - :ref:`ref-tasks-install` --- runs ``make install`` and |
129 | passes in ``${``\ :term:`D`\ ``}`` as ``DESTDIR``. | 129 | passes in ``${``\ :term:`D`\ ``}`` as ``DESTDIR``. |
130 | 130 | ||
131 | .. _ref-classes-barebox: | ||
132 | |||
133 | ``barebox`` | ||
134 | =========== | ||
135 | |||
136 | The :ref:`ref-classes-barebox` class manages building the barebox bootloader. | ||
137 | |||
138 | If a file named ``defconfig`` is included in the :term:`SRC_URI`, it will be | ||
139 | copied to ``.config`` in the build directory and used as the barebox | ||
140 | configuration. | ||
141 | Instead of providing a ``defconfig`` file, you can set :term:`BAREBOX_CONFIG` | ||
142 | to a defconfig provided by the barebox source tree. | ||
143 | If neither ``defconfig`` nor :term:`BAREBOX_CONFIG` is specified, the class | ||
144 | will raise an error. | ||
145 | |||
146 | The :ref:`ref-classes-barebox` class supports config fragments and internally | ||
147 | includes the :ref:`ref-classes-cml1` class to provide `Kconfig | ||
148 | <https://docs.kernel.org/kbuild/kconfig-language.html>`__ support for | ||
149 | barebox, enabling tasks such as :ref:`ref-tasks-menuconfig` and | ||
150 | :ref:`ref-tasks-diffconfig`. | ||
151 | |||
152 | The generated barebox binaries are deployed to | ||
153 | :term:`DEPLOY_DIR_IMAGE` as well as installed to ``BAREBOX_INSTALL_PATH`` | ||
154 | (``/boot`` by default) making them part of the recipe’s base package. | ||
155 | This setup supports both using the barebox binaries as independent artifacts | ||
156 | and installing them into a rootfs. | ||
157 | :term:`BAREBOX_BINARY` can be used to select a distinct binary to deploy and | ||
158 | install. | ||
159 | If ``barebox`` is set as the :term:`EFI_PROVIDER`, the class will leverage | ||
160 | :oe_git:`conf/image-uefi.conf </openembedded-core/tree/meta/conf/image-uefi.conf>` | ||
161 | to define the default installation paths and naming conventions. | ||
162 | |||
163 | The compiled-in barebox environment can be extended by adding environment files | ||
164 | to the ``BAREBOX_ENV_DIR``. | ||
165 | The ``BAREBOX_FIRMWARE_DIR`` variable allows you to specify the firmware blob | ||
166 | search directory, enabling loading of additional firmware like TF-A or OP-TEE. | ||
167 | |||
131 | .. _ref-classes-base: | 168 | .. _ref-classes-base: |
132 | 169 | ||
133 | ``base`` | 170 | ``base`` |