diff options
Diffstat (limited to 'documentation/bsp-guide/bsp.rst')
| -rw-r--r-- | documentation/bsp-guide/bsp.rst | 97 |
1 files changed, 41 insertions, 56 deletions
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst index 8ec7f2957e..353d56777b 100644 --- a/documentation/bsp-guide/bsp.rst +++ b/documentation/bsp-guide/bsp.rst @@ -1,8 +1,8 @@ .. SPDX-License-Identifier: CC-BY-SA-2.0-UK -************************************************ -Board Support Packages (BSP) - Developer's Guide -************************************************ +************************************************** +Board Support Packages (BSP) --- Developer's Guide +************************************************** A Board Support Package (BSP) is a collection of information that defines how to support a particular hardware device, set of devices, or @@ -128,7 +128,7 @@ you want to work with, such as:: and so on. For more information on layers, see the -":ref:`dev-manual/common-tasks:understanding and creating layers`" +":ref:`dev-manual/layers:understanding and creating layers`" section of the Yocto Project Development Tasks Manual. Preparing Your Build Host to Work With BSP Layers @@ -464,7 +464,7 @@ requirements are handled with the ``COPYING.MIT`` file. Licensing files can be MIT, BSD, GPLv*, and so forth. These files are recommended for the BSP but are optional and totally up to the BSP developer. For information on how to maintain license compliance, see -the ":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`" +the ":ref:`dev-manual/licenses:maintaining open source license compliance during your product's lifecycle`" section in the Yocto Project Development Tasks Manual. README File @@ -590,7 +590,7 @@ filenames correspond to the values to which users have set the These files define things such as the kernel package to use (:term:`PREFERRED_PROVIDER` of -:ref:`virtual/kernel <dev-manual/common-tasks:using virtual providers>`), +:ref:`virtual/kernel <dev-manual/new-recipe:using virtual providers>`), the hardware drivers to include in different types of images, any special software components that are needed, any bootloader information, and also any special image format requirements. @@ -757,7 +757,7 @@ workflow. OpenEmbedded build system knows about. For more information on layers, see the ":ref:`overview-manual/yp-intro:the yocto project layer model`" section in the Yocto Project Overview and Concepts Manual. You can also - reference the ":ref:`dev-manual/common-tasks:understanding and creating layers`" + reference the ":ref:`dev-manual/layers:understanding and creating layers`" section in the Yocto Project Development Tasks Manual. For more information on BSP layers, see the ":ref:`bsp-guide/bsp:bsp layers`" section. @@ -774,20 +774,6 @@ workflow. - Two general IA platforms (``genericx86`` and ``genericx86-64``) - - There are three core Intel BSPs in the Yocto Project - release, in the ``meta-intel`` layer: - - - ``intel-core2-32``, which is a BSP optimized for the Core2 - family of CPUs as well as all CPUs prior to the Silvermont - core. - - - ``intel-corei7-64``, which is a BSP optimized for Nehalem - and later Core and Xeon CPUs as well as Silvermont and later - Atom CPUs, such as the Baytrail SoCs. - - - ``intel-quark``, which is a BSP optimized for the Intel - Galileo gen1 & gen2 development boards. - When you set up a layer for a new BSP, you should follow a standard layout. This layout is described in the ":ref:`bsp-guide/bsp:example filesystem layout`" section. In the standard layout, notice @@ -816,7 +802,7 @@ workflow. key configuration files are configured appropriately: the ``conf/local.conf`` and the ``conf/bblayers.conf`` file. You must make the OpenEmbedded build system aware of your new layer. See the - ":ref:`dev-manual/common-tasks:enabling your layer`" + ":ref:`dev-manual/layers:enabling your layer`" section in the Yocto Project Development Tasks Manual for information on how to let the build system know about your new layer. @@ -845,7 +831,7 @@ Before looking at BSP requirements, you should consider the following: layer that can be added to the Yocto Project. For guidelines on creating a layer that meets these base requirements, see the ":ref:`bsp-guide/bsp:bsp layers`" section in this manual and the - ":ref:`dev-manual/common-tasks:understanding and creating layers`" + ":ref:`dev-manual/layers:understanding and creating layers`" section in the Yocto Project Development Tasks Manual. - The requirements in this section apply regardless of how you package @@ -867,8 +853,7 @@ Before looking at BSP requirements, you should consider the following: dictating that a specific kernel or kernel version be used in a given BSP. -Following are the requirements for a released BSP that conform to the -Yocto Project: +The requirements for a released BSP that conform to the Yocto Project are: - *Layer Name:* The BSP must have a layer name that follows the Yocto Project standards. For information on BSP layer names, see the @@ -893,8 +878,8 @@ Yocto Project: ``recipes-*`` subdirectories specific to the recipe's function, or within a subdirectory containing a set of closely-related recipes. The recipes themselves should follow the general guidelines for - recipes used in the Yocto Project found in the ":oe_wiki:`OpenEmbedded - Style Guide </Styleguide>`". + recipes found in the ":doc:`../contributor-guide/recipe-style-guide`" + in the Yocto Project and OpenEmbedded Contributor Guide. - *License File:* You must include a license file in the ``meta-bsp_root_name`` directory. This license covers the BSP @@ -927,8 +912,8 @@ Yocto Project: - The name and contact information for the BSP layer maintainer. This is the person to whom patches and questions should be sent. For information on how to find the right person, see the - ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" - section in the Yocto Project Development Tasks Manual. + :doc:`../contributor-guide/submit-changes` section in the Yocto Project and + OpenEmbedded Contributor Guide. - Instructions on how to build the BSP using the BSP layer. @@ -972,7 +957,7 @@ Yocto Project: Released BSP Recommendations ---------------------------- -Following are recommendations for released BSPs that conform to the +Here are recommendations for released BSPs that conform to the Yocto Project: - *Bootable Images:* Released BSPs can contain one or more bootable @@ -1013,7 +998,7 @@ the following: - Create a ``*.bbappend`` file for the modified recipe. For information on using append files, see the - ":ref:`dev-manual/common-tasks:appending other layers metadata with your layer`" + ":ref:`dev-manual/layers:appending other layers metadata with your layer`" section in the Yocto Project Development Tasks Manual. - Ensure your directory structure in the BSP layer that supports your @@ -1034,7 +1019,7 @@ the following: that additional hierarchy and the files would obviously not be able to reside in a machine-specific directory. -Following is a specific example to help you better understand the +Here is a specific example to help you better understand the process. This example customizes a recipe by adding a BSP-specific configuration file named ``interfaces`` to the ``init-ifupdown_1.0.bb`` recipe for machine "xyz" where the BSP layer @@ -1117,7 +1102,7 @@ list describes them in order of preference: Specifying the matching license string signifies that you agree to the license. Thus, the build system can build the corresponding recipe and include the component in the image. See the - ":ref:`dev-manual/common-tasks:enabling commercially licensed recipes`" + ":ref:`dev-manual/licenses:enabling commercially licensed recipes`" section in the Yocto Project Development Tasks Manual for details on how to use these variables. @@ -1169,7 +1154,7 @@ Use these steps to create a BSP layer: ``create-layer`` subcommand to create a new general layer. For instructions on how to create a general layer using the ``bitbake-layers`` script, see the - ":ref:`dev-manual/common-tasks:creating a general layer using the \`\`bitbake-layers\`\` script`" + ":ref:`dev-manual/layers:creating a general layer using the \`\`bitbake-layers\`\` script`" section in the Yocto Project Development Tasks Manual. - *Create a Layer Configuration File:* Every layer needs a layer @@ -1179,14 +1164,14 @@ Use these steps to create a BSP layer: :yocto_git:`Source Repositories <>`. To get examples of what you need in your configuration file, locate a layer (e.g. "meta-ti") and examine the - :yocto_git:`local.conf </meta-ti/tree/conf/layer.conf>` + :yocto_git:`local.conf </meta-ti/tree/meta-ti-bsp/conf/layer.conf>` file. - *Create a Machine Configuration File:* Create a ``conf/machine/bsp_root_name.conf`` file. See :yocto_git:`meta-yocto-bsp/conf/machine </poky/tree/meta-yocto-bsp/conf/machine>` for sample ``bsp_root_name.conf`` files. There are other samples such as - :yocto_git:`meta-ti </meta-ti/tree/conf/machine>` + :yocto_git:`meta-ti </meta-ti/tree/meta-ti-bsp/conf/machine>` and :yocto_git:`meta-freescale </meta-freescale/tree/conf/machine>` from other vendors that have more specific machine and tuning @@ -1194,7 +1179,7 @@ Use these steps to create a BSP layer: - *Create a Kernel Recipe:* Create a kernel recipe in ``recipes-kernel/linux`` by either using a kernel append file or a - new custom kernel recipe file (e.g. ``yocto-linux_4.12.bb``). The BSP + new custom kernel recipe file (e.g. ``linux-yocto_4.12.bb``). The BSP layers mentioned in the previous step also contain different kernel examples. See the ":ref:`kernel-dev/common:modifying an existing recipe`" section in the Yocto Project Linux Kernel Development Manual for @@ -1209,7 +1194,7 @@ BSP Layer Configuration Example ------------------------------- The layer's ``conf`` directory contains the ``layer.conf`` configuration -file. In this example, the ``conf/layer.conf`` is the following:: +file. In this example, the ``conf/layer.conf`` file is the following:: # We have a conf and classes directory, add to BBPATH BBPATH .= ":${LAYERDIR}" @@ -1229,7 +1214,7 @@ configuration files is to examine various files for BSP from the :yocto_git:`Source Repositories <>`. For a detailed description of this particular layer configuration file, -see ":ref:`step 3 <dev-manual/common-tasks:creating your own layer>`" +see ":ref:`step 3 <dev-manual/layers:creating your own layer>`" in the discussion that describes how to create layers in the Yocto Project Development Tasks Manual. @@ -1449,39 +1434,39 @@ The kernel recipe used to build the kernel image for the BeagleBone device was established in the machine configuration:: PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto" - PREFERRED_VERSION_linux-yocto ?= "5.0%" + PREFERRED_VERSION_linux-yocto ?= "5.15%" The ``meta-yocto-bsp/recipes-kernel/linux`` directory in the layer contains metadata used to build the kernel. In this case, a kernel append file -(i.e. ``linux-yocto_5.0.bbappend``) is used to override an established -kernel recipe (i.e. ``linux-yocto_5.0.bb``), which is located in -:yocto_git:`/poky/tree/meta/recipes-kernel/linux`. +(i.e. ``linux-yocto_5.15.bbappend``) is used to override an established +kernel recipe (i.e. ``linux-yocto_5.15.bb``), which is located in +:yocto_git:`/poky/tree/meta-yocto-bsp/recipes-kernel/linux`. -Following is the contents of the append file:: +The contents of the append file are:: - KBRANCH:genericx86 = "v5.0/standard/base" - KBRANCH:genericx86-64 = "v5.0/standard/base" - KBRANCH:edgerouter = "v5.0/standard/edgerouter" - KBRANCH:beaglebone-yocto = "v5.0/standard/beaglebone" + KBRANCH:genericx86 = "v5.15/standard/base" + KBRANCH:genericx86-64 = "v5.15/standard/base" + KBRANCH:edgerouter = "v5.15/standard/edgerouter" + KBRANCH:beaglebone-yocto = "v5.15/standard/beaglebone" KMACHINE:genericx86 ?= "common-pc" KMACHINE:genericx86-64 ?= "common-pc-64" KMACHINE:beaglebone-yocto ?= "beaglebone" - SRCREV_machine:genericx86 ?= "3df4aae6074e94e794e27fe7f17451d9353cdf3d" - SRCREV_machine:genericx86-64 ?= "3df4aae6074e94e794e27fe7f17451d9353cdf3d" - SRCREV_machine:edgerouter ?= "3df4aae6074e94e794e27fe7f17451d9353cdf3d" - SRCREV_machine:beaglebone-yocto ?= "3df4aae6074e94e794e27fe7f17451d9353cdf3d" + SRCREV_machine:genericx86 ?= "0b628306d1f9ea28c0e86369ce9bb87a47893c9c" + SRCREV_machine:genericx86-64 ?= "0b628306d1f9ea28c0e86369ce9bb87a47893c9c" + SRCREV_machine:edgerouter ?= "90f1ee6589264545f548d731c2480b08a007230f" + SRCREV_machine:beaglebone-yocto ?= "9aabbaa89fcb21af7028e814c1f5b61171314d5a" COMPATIBLE_MACHINE:genericx86 = "genericx86" COMPATIBLE_MACHINE:genericx86-64 = "genericx86-64" COMPATIBLE_MACHINE:edgerouter = "edgerouter" COMPATIBLE_MACHINE:beaglebone-yocto = "beaglebone-yocto" - LINUX_VERSION:genericx86 = "5.0.3" - LINUX_VERSION:genericx86-64 = "5.0.3" - LINUX_VERSION:edgerouter = "5.0.3" - LINUX_VERSION:beaglebone-yocto = "5.0.3" + LINUX_VERSION:genericx86 = "5.15.72" + LINUX_VERSION:genericx86-64 = "5.15.72" + LINUX_VERSION:edgerouter = "5.15.54" + LINUX_VERSION:beaglebone-yocto = "5.15.54" This particular append file works for all the machines that are part of the ``meta-yocto-bsp`` layer. The relevant statements are |