diff options
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/bsp-guide/bsp.xml | 50 |
1 files changed, 25 insertions, 25 deletions
diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml index a14dd3b888..1658842597 100644 --- a/documentation/bsp-guide/bsp.xml +++ b/documentation/bsp-guide/bsp.xml | |||
@@ -34,12 +34,12 @@ | |||
34 | The BSP consists of a file structure inside a base directory. | 34 | The BSP consists of a file structure inside a base directory. |
35 | Collectively, you can think of the base directory and the file structure | 35 | Collectively, you can think of the base directory and the file structure |
36 | as a BSP Layer. | 36 | as a BSP Layer. |
37 | Although not a strict requirement, layers in the Yocto Project use the | 37 | Although not a strict requirement, layers in the Yocto Project use the |
38 | following well established naming convention: | 38 | following well established naming convention: |
39 | <literallayout class='monospaced'> | 39 | <literallayout class='monospaced'> |
40 | meta-<bsp_name> | 40 | meta-<bsp_name> |
41 | </literallayout> | 41 | </literallayout> |
42 | The string "meta-" is prepended to the machine or platform name, which is | 42 | The string "meta-" is prepended to the machine or platform name, which is |
43 | "bsp_name" in the above form. | 43 | "bsp_name" in the above form. |
44 | </para> | 44 | </para> |
45 | 45 | ||
@@ -54,7 +54,7 @@ | |||
54 | definition and from it build an image. | 54 | definition and from it build an image. |
55 | Here is an example: | 55 | Here is an example: |
56 | <literallayout class='monospaced'> | 56 | <literallayout class='monospaced'> |
57 | BBLAYERS = ?" \ | 57 | BBLAYERS ?= " \ |
58 | /usr/local/src/yocto/meta \ | 58 | /usr/local/src/yocto/meta \ |
59 | /usr/local/src/yocto/meta-yocto \ | 59 | /usr/local/src/yocto/meta-yocto \ |
60 | /usr/local/src/yocto/meta-yocto-bsp \ | 60 | /usr/local/src/yocto/meta-yocto-bsp \ |
@@ -261,7 +261,7 @@ | |||
261 | This file provides information on where to locate the BSP source files. | 261 | This file provides information on where to locate the BSP source files. |
262 | For example, information provides where to find the sources that comprise | 262 | For example, information provides where to find the sources that comprise |
263 | the images shipped with the BSP. | 263 | the images shipped with the BSP. |
264 | Information is also included to help you find the | 264 | Information is also included to help you find the |
265 | <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> | 265 | <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> |
266 | used to generate the images that ship with the BSP. | 266 | used to generate the images that ship with the BSP. |
267 | </para> | 267 | </para> |
@@ -331,7 +331,7 @@ | |||
331 | </para> | 331 | </para> |
332 | 332 | ||
333 | <para> | 333 | <para> |
334 | To illustrate the string substitutions, here are the corresponding statements | 334 | To illustrate the string substitutions, here are the corresponding statements |
335 | from the Crown Bay <filename>conf/layer.conf</filename> file: | 335 | from the Crown Bay <filename>conf/layer.conf</filename> file: |
336 | <literallayout class='monospaced'> | 336 | <literallayout class='monospaced'> |
337 | BBFILE_COLLECTIONS += "crownbay" | 337 | BBFILE_COLLECTIONS += "crownbay" |
@@ -382,8 +382,8 @@ | |||
382 | The <filename>crownbay.conf</filename> file is used for the Crown Bay BSP | 382 | The <filename>crownbay.conf</filename> file is used for the Crown Bay BSP |
383 | that supports the <trademark class='registered'>Intel</trademark> Embedded | 383 | that supports the <trademark class='registered'>Intel</trademark> Embedded |
384 | Media and Graphics Driver (<trademark class='registered'>Intel</trademark> | 384 | Media and Graphics Driver (<trademark class='registered'>Intel</trademark> |
385 | EMGD), while the <filename>crownbay-noemgd</filename> file is used for the | 385 | EMGD), while the <filename>crownbay-noemgd</filename> file is used for the |
386 | Crown Bay BSP that supports Video Electronics Standards Association (VESA) | 386 | Crown Bay BSP that supports Video Electronics Standards Association (VESA) |
387 | graphics only. | 387 | graphics only. |
388 | </para> | 388 | </para> |
389 | 389 | ||
@@ -581,7 +581,7 @@ | |||
581 | <ulink url='&YOCTO_DOCS_REF_URL;#var-KBRANCH'><filename>KBRANCH</filename></ulink> variable | 581 | <ulink url='&YOCTO_DOCS_REF_URL;#var-KBRANCH'><filename>KBRANCH</filename></ulink> variable |
582 | to ensure the build process uses the <filename>standard/crownbay</filename> | 582 | to ensure the build process uses the <filename>standard/crownbay</filename> |
583 | kernel branch. | 583 | kernel branch. |
584 | The | 584 | The |
585 | <ulink url='&YOCTO_DOCS_REF_URL;#var-KERNEL_FEATURES'><filename>KERNEL_FEATURES</filename></ulink> | 585 | <ulink url='&YOCTO_DOCS_REF_URL;#var-KERNEL_FEATURES'><filename>KERNEL_FEATURES</filename></ulink> |
586 | variable enables features specific to the kernel. | 586 | variable enables features specific to the kernel. |
587 | Finally, the append file points to specific commits in the | 587 | Finally, the append file points to specific commits in the |
@@ -788,7 +788,7 @@ | |||
788 | BSP layer maintainer. | 788 | BSP layer maintainer. |
789 | This is the person to whom patches and questions should | 789 | This is the person to whom patches and questions should |
790 | be sent. | 790 | be sent. |
791 | For information on how to find the right person, see the | 791 | For information on how to find the right person, see the |
792 | "<ulink url='&YOCTO_DOCS_DEV_URL;#how-to-submit-a-change'>How to Submit a Change</ulink>" | 792 | "<ulink url='&YOCTO_DOCS_DEV_URL;#how-to-submit-a-change'>How to Submit a Change</ulink>" |
793 | section in the Yocto Project Development Manual. | 793 | section in the Yocto Project Development Manual. |
794 | </para></listitem> | 794 | </para></listitem> |
@@ -894,7 +894,7 @@ | |||
894 | <itemizedlist> | 894 | <itemizedlist> |
895 | <listitem><para>Create a <filename>.bbappend</filename> | 895 | <listitem><para>Create a <filename>.bbappend</filename> |
896 | file for the modified recipe. | 896 | file for the modified recipe. |
897 | For information on using append files, see the | 897 | For information on using append files, see the |
898 | "<ulink url='&YOCTO_DOCS_DEV_URL;#using-bbappend-files'>Using .bbappend Files</ulink>" | 898 | "<ulink url='&YOCTO_DOCS_DEV_URL;#using-bbappend-files'>Using .bbappend Files</ulink>" |
899 | section in the Yocto Project Development Manual. | 899 | section in the Yocto Project Development Manual. |
900 | </para></listitem> | 900 | </para></listitem> |
@@ -903,15 +903,15 @@ | |||
903 | that supports your machine is such that it can be found | 903 | that supports your machine is such that it can be found |
904 | by the build system. | 904 | by the build system. |
905 | See the example later in this section for more information. | 905 | See the example later in this section for more information. |
906 | </para></listitem> | 906 | </para></listitem> |
907 | <listitem><para> | 907 | <listitem><para> |
908 | Put the append file in a directory whose name matches | 908 | Put the append file in a directory whose name matches |
909 | the machine's name and is located in an appropriate | 909 | the machine's name and is located in an appropriate |
910 | sub-directory inside the BSP layer (i.e. | 910 | sub-directory inside the BSP layer (i.e. |
911 | <filename>recipes-bsp</filename>, <filename>recipes-graphics</filename>, | 911 | <filename>recipes-bsp</filename>, <filename>recipes-graphics</filename>, |
912 | <filename>recipes-core</filename>, and so forth). | 912 | <filename>recipes-core</filename>, and so forth). |
913 | </para></listitem> | 913 | </para></listitem> |
914 | <listitem><para>Place the BSP-specific files in the directory named for | 914 | <listitem><para>Place the BSP-specific files in the directory named for |
915 | your machine inside the BSP layer. | 915 | your machine inside the BSP layer. |
916 | </para></listitem> | 916 | </para></listitem> |
917 | </itemizedlist> | 917 | </itemizedlist> |
@@ -930,7 +930,7 @@ | |||
930 | FILESEXTRAPATHS_prepend := "${THISDIR}/files:" | 930 | FILESEXTRAPATHS_prepend := "${THISDIR}/files:" |
931 | PRINC := "${@int(PRINC) + 2}" | 931 | PRINC := "${@int(PRINC) + 2}" |
932 | </literallayout> | 932 | </literallayout> |
933 | The append file needs to be in the | 933 | The append file needs to be in the |
934 | <filename>meta-xyz/recipes-core/init-ifupdown</filename> directory. | 934 | <filename>meta-xyz/recipes-core/init-ifupdown</filename> directory. |
935 | </para></listitem> | 935 | </para></listitem> |
936 | <listitem><para>Create and place the new <filename>interfaces</filename> | 936 | <listitem><para>Create and place the new <filename>interfaces</filename> |
@@ -938,11 +938,11 @@ | |||
938 | <literallayout class='monospaced'> | 938 | <literallayout class='monospaced'> |
939 | meta-xyz/recipes-core/init-ifupdown/files/xyz/interfaces | 939 | meta-xyz/recipes-core/init-ifupdown/files/xyz/interfaces |
940 | </literallayout> | 940 | </literallayout> |
941 | The | 941 | The |
942 | <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></ulink> | 942 | <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></ulink> |
943 | variable in the append files extends the search path | 943 | variable in the append files extends the search path |
944 | the build system uses to find files during the build. | 944 | the build system uses to find files during the build. |
945 | Consequently, for this example you need to have the | 945 | Consequently, for this example you need to have the |
946 | <filename>files</filename> directory in the same location | 946 | <filename>files</filename> directory in the same location |
947 | as your append file.</para></listitem> | 947 | as your append file.</para></listitem> |
948 | </orderedlist> | 948 | </orderedlist> |
@@ -978,7 +978,7 @@ | |||
978 | 978 | ||
979 | <para> | 979 | <para> |
980 | For cases where you can substitute a free component and still | 980 | For cases where you can substitute a free component and still |
981 | maintain the system's functionality, the "Downloads" page from the | 981 | maintain the system's functionality, the "Downloads" page from the |
982 | <ulink url='&YOCTO_HOME_URL;'>Yocto Project website's</ulink> | 982 | <ulink url='&YOCTO_HOME_URL;'>Yocto Project website's</ulink> |
983 | makes available de-featured BSPs | 983 | makes available de-featured BSPs |
984 | that are completely free of any IP encumbrances. | 984 | that are completely free of any IP encumbrances. |
@@ -1033,8 +1033,8 @@ | |||
1033 | can build the encumbered image with no change at all | 1033 | can build the encumbered image with no change at all |
1034 | to the normal build process.</para></listitem> | 1034 | to the normal build process.</para></listitem> |
1035 | <listitem><para><emphasis>Get a pre-built version of the BSP:</emphasis> | 1035 | <listitem><para><emphasis>Get a pre-built version of the BSP:</emphasis> |
1036 | You can get this type of BSP by visiting the | 1036 | You can get this type of BSP by visiting the |
1037 | "Downloads" page of the | 1037 | "Downloads" page of the |
1038 | <ulink url='&YOCTO_HOME_URL;'>Yocto Project website</ulink>. | 1038 | <ulink url='&YOCTO_HOME_URL;'>Yocto Project website</ulink>. |
1039 | You can download BSP tarballs that contain proprietary components | 1039 | You can download BSP tarballs that contain proprietary components |
1040 | after agreeing to the licensing | 1040 | after agreeing to the licensing |
@@ -1193,8 +1193,8 @@ | |||
1193 | the tools. | 1193 | the tools. |
1194 | <note> | 1194 | <note> |
1195 | You can also use the <filename>yocto-layer</filename> tool to create | 1195 | You can also use the <filename>yocto-layer</filename> tool to create |
1196 | a "generic" layer. | 1196 | a "generic" layer. |
1197 | For information on this tool, see the | 1197 | For information on this tool, see the |
1198 | "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-general-layer-using-the-yocto-layer-script'>Creating a General Layer Using the yocto-layer Script</ulink>" | 1198 | "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-general-layer-using-the-yocto-layer-script'>Creating a General Layer Using the yocto-layer Script</ulink>" |
1199 | section in the Yocto Project Development Guide. | 1199 | section in the Yocto Project Development Guide. |
1200 | </note> | 1200 | </note> |
@@ -1216,7 +1216,7 @@ | |||
1216 | by the Yocto Project, as well as QEMU versions of the same. | 1216 | by the Yocto Project, as well as QEMU versions of the same. |
1217 | The default mode of the script's operation is to prompt you for information needed | 1217 | The default mode of the script's operation is to prompt you for information needed |
1218 | to generate the BSP layer. | 1218 | to generate the BSP layer. |
1219 | </para> | 1219 | </para> |
1220 | 1220 | ||
1221 | <para> | 1221 | <para> |
1222 | For the current set of BSPs, the script prompts you for various important | 1222 | For the current set of BSPs, the script prompts you for various important |
@@ -1271,7 +1271,7 @@ | |||
1271 | with an invalid response causes the script to accept the default value. | 1271 | with an invalid response causes the script to accept the default value. |
1272 | Once the script completes, the new <filename>meta-myarm</filename> BSP layer | 1272 | Once the script completes, the new <filename>meta-myarm</filename> BSP layer |
1273 | is created in the current working directory. | 1273 | is created in the current working directory. |
1274 | This example assumes you have sourced the | 1274 | This example assumes you have sourced the |
1275 | <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink> | 1275 | <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink> |
1276 | and are currently in the top-level folder of the | 1276 | and are currently in the top-level folder of the |
1277 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | 1277 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. |