diff options
Diffstat (limited to 'documentation/bsp-guide')
-rw-r--r-- | documentation/bsp-guide/bsp.rst | 40 |
1 files changed, 20 insertions, 20 deletions
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst index 361951b592..9a12c942bc 100644 --- a/documentation/bsp-guide/bsp.rst +++ b/documentation/bsp-guide/bsp.rst | |||
@@ -43,7 +43,7 @@ To help understand the BSP layer concept, consider the BSPs that the | |||
43 | Yocto Project supports and provides with each release. You can see the | 43 | Yocto Project supports and provides with each release. You can see the |
44 | layers in the `Yocto Project Source | 44 | layers in the `Yocto Project Source |
45 | Repositories <&YOCTO_DOCS_OM_URL;#yocto-project-repositories>`__ through | 45 | Repositories <&YOCTO_DOCS_OM_URL;#yocto-project-repositories>`__ through |
46 | a web interface at ` <&YOCTO_GIT_URL;>`__. If you go to that interface, | 46 | a web interface at :yocto_git:`/`. If you go to that interface, |
47 | you will find a list of repositories under "Yocto Metadata Layers". | 47 | you will find a list of repositories under "Yocto Metadata Layers". |
48 | 48 | ||
49 | .. note:: | 49 | .. note:: |
@@ -270,7 +270,7 @@ meta-bsp_root_name/recipes-graphics/\* | |||
270 | meta-bsp_root_name/recipes-kernel/linux/linux-yocto_kernel_rev.bbappend | 270 | meta-bsp_root_name/recipes-kernel/linux/linux-yocto_kernel_rev.bbappend |
271 | 271 | ||
272 | Below is an example of the Raspberry Pi BSP layer that is available from | 272 | Below is an example of the Raspberry Pi BSP layer that is available from |
273 | the `Source Respositories <&YOCTO_GIT_URL;>`__: | 273 | the :yocto_git:`Source Respositories <>`: |
274 | meta-raspberrypi/COPYING.MIT meta-raspberrypi/README.md | 274 | meta-raspberrypi/COPYING.MIT meta-raspberrypi/README.md |
275 | meta-raspberrypi/classes | 275 | meta-raspberrypi/classes |
276 | meta-raspberrypi/classes/sdcard_image-rpi.bbclass meta-raspberrypi/conf/ | 276 | meta-raspberrypi/classes/sdcard_image-rpi.bbclass meta-raspberrypi/conf/ |
@@ -487,7 +487,7 @@ This optional area contains useful pre-built kernels and user-space | |||
487 | filesystem images released with the BSP that are appropriate to the | 487 | filesystem images released with the BSP that are appropriate to the |
488 | target system. This directory typically contains graphical (e.g. Sato) | 488 | target system. This directory typically contains graphical (e.g. Sato) |
489 | and minimal live images when the BSP tarball has been created and made | 489 | and minimal live images when the BSP tarball has been created and made |
490 | available in the `Yocto Project <&YOCTO_HOME_URL;>`__ website. You can | 490 | available in the :yocto_home:`Yocto Project <>` website. You can |
491 | use these kernels and images to get a system running and quickly get | 491 | use these kernels and images to get a system running and quickly get |
492 | started on development tasks. | 492 | started on development tasks. |
493 | 493 | ||
@@ -871,13 +871,13 @@ Yocto Project: | |||
871 | ``meta-``\ bsp_root_name directory. This license covers the BSP | 871 | ``meta-``\ bsp_root_name directory. This license covers the BSP |
872 | Metadata as a whole. You must specify which license to use since no | 872 | Metadata as a whole. You must specify which license to use since no |
873 | default license exists when one is not specified. See the | 873 | default license exists when one is not specified. See the |
874 | ```COPYING.MIT`` <&YOCTO_GIT_URL;/cgit.cgi/meta-raspberrypi/tree/COPYING.MIT>`__ | 874 | :yocto_git:`COPYING.MIT </cgit.cgi/meta-raspberrypi/tree/COPYING.MIT>` |
875 | file for the Raspberry Pi BSP in the ``meta-raspberrypi`` BSP layer | 875 | file for the Raspberry Pi BSP in the ``meta-raspberrypi`` BSP layer |
876 | as an example. | 876 | as an example. |
877 | 877 | ||
878 | - *README File:* You must include a ``README`` file in the | 878 | - *README File:* You must include a ``README`` file in the |
879 | ``meta-``\ bsp_root_name directory. See the | 879 | ``meta-``\ bsp_root_name directory. See the |
880 | ```README.md`` <&YOCTO_GIT_URL;/cgit.cgi/meta-raspberrypi/tree/README.md>`__ | 880 | :yocto_git:`README.md </cgit.cgi/meta-raspberrypi/tree/README.md>` |
881 | file for the Raspberry Pi BSP in the ``meta-raspberrypi`` BSP layer | 881 | file for the Raspberry Pi BSP in the ``meta-raspberrypi`` BSP layer |
882 | as an example. | 882 | as an example. |
883 | 883 | ||
@@ -976,8 +976,8 @@ Yocto Project: | |||
976 | - *Use a Yocto Linux Kernel:* Kernel recipes in the BSP should be based | 976 | - *Use a Yocto Linux Kernel:* Kernel recipes in the BSP should be based |
977 | on a Yocto Linux kernel. Basing your recipes on these kernels reduces | 977 | on a Yocto Linux kernel. Basing your recipes on these kernels reduces |
978 | the costs for maintaining the BSP and increases its scalability. See | 978 | the costs for maintaining the BSP and increases its scalability. See |
979 | the ``Yocto Linux Kernel`` category in the `Source | 979 | the ``Yocto Linux Kernel`` category in the |
980 | Repositories <&YOCTO_GIT_URL;>`__ for these kernels. | 980 | :yocto_git:`Source Repositories <>` for these kernels. |
981 | 981 | ||
982 | Customizing a Recipe for a BSP | 982 | Customizing a Recipe for a BSP |
983 | ============================== | 983 | ============================== |
@@ -1067,7 +1067,7 @@ of the licensed version in the BSP recipe. | |||
1067 | 1067 | ||
1068 | For cases where you can substitute a free component and still maintain | 1068 | For cases where you can substitute a free component and still maintain |
1069 | the system's functionality, the "DOWNLOADS" selection from the | 1069 | the system's functionality, the "DOWNLOADS" selection from the |
1070 | "SOFTWARE" tab on the `Yocto Project website <&YOCTO_HOME_URL;>`__ makes | 1070 | "SOFTWARE" tab on the :yocto_home:`Yocto Project Website <>` makes |
1071 | available de-featured BSPs that are completely free of any IP | 1071 | available de-featured BSPs that are completely free of any IP |
1072 | encumbrances. For these cases, you can use the substitution directly and | 1072 | encumbrances. For these cases, you can use the substitution directly and |
1073 | without any further licensing requirements. If present, these fully | 1073 | without any further licensing requirements. If present, these fully |
@@ -1114,8 +1114,8 @@ list describes them in order of preference: | |||
1114 | image with no change at all to the normal build process. | 1114 | image with no change at all to the normal build process. |
1115 | 1115 | ||
1116 | 2. *Get a Pre-Built Version of the BSP:* You can get this type of BSP by | 1116 | 2. *Get a Pre-Built Version of the BSP:* You can get this type of BSP by |
1117 | selecting the "DOWNLOADS" item from the "SOFTWARE" tab on the `Yocto | 1117 | selecting the "DOWNLOADS" item from the "SOFTWARE" tab on the |
1118 | Project website <&YOCTO_HOME_URL;>`__. You can download BSP tarballs | 1118 | :yocto_home:`Yocto Project website <>`. You can download BSP tarballs |
1119 | that contain proprietary components after agreeing to the licensing | 1119 | that contain proprietary components after agreeing to the licensing |
1120 | requirements of each of the individually encumbered packages as part | 1120 | requirements of each of the individually encumbered packages as part |
1121 | of the download process. Obtaining the BSP this way allows you to | 1121 | of the download process. Obtaining the BSP this way allows you to |
@@ -1156,20 +1156,20 @@ Use these steps to create a BSP layer: | |||
1156 | - *Create a Layer Configuration File:* Every layer needs a layer | 1156 | - *Create a Layer Configuration File:* Every layer needs a layer |
1157 | configuration file. This configuration file establishes locations for | 1157 | configuration file. This configuration file establishes locations for |
1158 | the layer's recipes, priorities for the layer, and so forth. You can | 1158 | the layer's recipes, priorities for the layer, and so forth. You can |
1159 | find examples of ``layer.conf`` files in the Yocto Project `Source | 1159 | find examples of ``layer.conf`` files in the Yocto Project |
1160 | Repositories <&YOCTO_GIT_URL;>`__. To get examples of what you need | 1160 | :yocto_git:`Source Repositories <>`. To get examples of what you need |
1161 | in your configuration file, locate a layer (e.g. "meta-ti") and | 1161 | in your configuration file, locate a layer (e.g. "meta-ti") and |
1162 | examine the | 1162 | examine the |
1163 | ` <&YOCTO_GIT_URL;/cgit/cgit.cgi/meta-ti/tree/conf/layer.conf>`__ | 1163 | :yocto_git:`local.conf </cgit/cgit.cgi/meta-ti/tree/conf/layer.conf>` |
1164 | file. | 1164 | file. |
1165 | 1165 | ||
1166 | - *Create a Machine Configuration File:* Create a | 1166 | - *Create a Machine Configuration File:* Create a |
1167 | ``conf/machine/``\ bsp_root_name\ ``.conf`` file. See | 1167 | ``conf/machine/``\ bsp_root_name\ ``.conf`` file. See |
1168 | ```meta-yocto-bsp/conf/machine`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-yocto-bsp/conf/machine>`__ | 1168 | :yocto_git:`meta-yocto-bsp/conf/machine </cgit/cgit.cgi/poky/tree/meta-yocto-bsp/conf/machine>` |
1169 | for sample bsp_root_name\ ``.conf`` files. Other samples such as | 1169 | for sample bsp_root_name\ ``.conf`` files. Other samples such as |
1170 | ```meta-ti`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/meta-ti/tree/conf/machine>`__ | 1170 | :yocto_git:`meta-ti </cgit/cgit.cgi/meta-ti/tree/conf/machine>` |
1171 | and | 1171 | and |
1172 | ```meta-freescale`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/meta-freescale/tree/conf/machine>`__ | 1172 | :yocto_git:`meta-freescale </cgit/cgit.cgi/meta-freescale/tree/conf/machine>` |
1173 | exist from other vendors that have more specific machine and tuning | 1173 | exist from other vendors that have more specific machine and tuning |
1174 | examples. | 1174 | examples. |
1175 | 1175 | ||
@@ -1184,7 +1184,7 @@ Use these steps to create a BSP layer: | |||
1184 | 1184 | ||
1185 | The remainder of this section provides a description of the Yocto | 1185 | The remainder of this section provides a description of the Yocto |
1186 | Project reference BSP for Beaglebone, which resides in the | 1186 | Project reference BSP for Beaglebone, which resides in the |
1187 | ```meta-yocto-bsp`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-yocto-bsp>`__ | 1187 | :yocto_git:`meta-yocto-bsp </cgit/cgit.cgi/poky/tree/meta-yocto-bsp>` |
1188 | layer. | 1188 | layer. |
1189 | 1189 | ||
1190 | BSP Layer Configuration Example | 1190 | BSP Layer Configuration Example |
@@ -1199,8 +1199,8 @@ BBFILE_COLLECTIONS += "yoctobsp" BBFILE_PATTERN_yoctobsp = | |||
1199 | "^${LAYERDIR}/" BBFILE_PRIORITY_yoctobsp = "5" LAYERVERSION_yoctobsp = | 1199 | "^${LAYERDIR}/" BBFILE_PRIORITY_yoctobsp = "5" LAYERVERSION_yoctobsp = |
1200 | "4" LAYERSERIES_COMPAT_yoctobsp = "DISTRO_NAME_NO_CAP" The variables | 1200 | "4" LAYERSERIES_COMPAT_yoctobsp = "DISTRO_NAME_NO_CAP" The variables |
1201 | used in this file configure the layer. A good way to learn about layer | 1201 | used in this file configure the layer. A good way to learn about layer |
1202 | configuration files is to examine various files for BSP from the `Source | 1202 | configuration files is to examine various files for BSP from the |
1203 | Repositories <&YOCTO_GIT_URL;>`__. | 1203 | :yocto_git:`Source Repositories <>`. |
1204 | 1204 | ||
1205 | For a detailed description of this particular layer configuration file, | 1205 | For a detailed description of this particular layer configuration file, |
1206 | see "`step 3 <&YOCTO_DOCS_DEV_URL;#dev-layer-config-file-description>`__ | 1206 | see "`step 3 <&YOCTO_DOCS_DEV_URL;#dev-layer-config-file-description>`__ |
@@ -1409,7 +1409,7 @@ PREFERRED_VERSION_linux-yocto ?= "5.0%" The | |||
1409 | metadata used to build the kernel. In this case, a kernel append file | 1409 | metadata used to build the kernel. In this case, a kernel append file |
1410 | (i.e. ``linux-yocto_5.0.bbappend``) is used to override an established | 1410 | (i.e. ``linux-yocto_5.0.bbappend``) is used to override an established |
1411 | kernel recipe (i.e. ``linux-yocto_5.0.bb``), which is located in | 1411 | kernel recipe (i.e. ``linux-yocto_5.0.bb``), which is located in |
1412 | ` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/recipes-kernel/linux>`__. | 1412 | https://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/recipes-kernel/linux. |
1413 | 1413 | ||
1414 | Following is the contents of the append file: KBRANCH_genericx86 = | 1414 | Following is the contents of the append file: KBRANCH_genericx86 = |
1415 | "v5.0/standard/base" KBRANCH_genericx86-64 = "v5.0/standard/base" | 1415 | "v5.0/standard/base" KBRANCH_genericx86-64 = "v5.0/standard/base" |