diff options
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/bsp-guide/bsp.xml | 80 |
1 files changed, 40 insertions, 40 deletions
diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml index fd143ede14..482f2ebe7f 100644 --- a/documentation/bsp-guide/bsp.xml +++ b/documentation/bsp-guide/bsp.xml | |||
| @@ -37,7 +37,7 @@ | |||
| 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-<replaceable>bsp_name</replaceable> |
| 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. |
| @@ -50,7 +50,7 @@ | |||
| 50 | <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink> | 50 | <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink> |
| 51 | through a web interface at | 51 | through a web interface at |
| 52 | <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi'></ulink>. | 52 | <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi'></ulink>. |
| 53 | If you go to that interface you will find near the bottom of the list | 53 | If you go to that interface, you will find near the bottom of the list |
| 54 | under "Yocto Metadata Layers" several BSP layers all of which are | 54 | under "Yocto Metadata Layers" several BSP layers all of which are |
| 55 | supported by the Yocto Project (e.g. <filename>meta-minnow</filename>, | 55 | supported by the Yocto Project (e.g. <filename>meta-minnow</filename>, |
| 56 | <filename>meta-raspberrypi</filename>, and | 56 | <filename>meta-raspberrypi</filename>, and |
| @@ -72,7 +72,7 @@ | |||
| 72 | </para> | 72 | </para> |
| 73 | 73 | ||
| 74 | <para> | 74 | <para> |
| 75 | The layer's base directory (<filename>meta-<bsp_name></filename>) is the root | 75 | The layer's base directory (<filename>meta-<replaceable>bsp_name</replaceable></filename>) is the root |
| 76 | of the BSP Layer. | 76 | of the BSP Layer. |
| 77 | This root is what you add to the | 77 | This root is what you add to the |
| 78 | <ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'><filename>BBLAYERS</filename></ulink> | 78 | <ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'><filename>BBLAYERS</filename></ulink> |
| @@ -175,17 +175,17 @@ | |||
| 175 | for specific BSPs could differ. | 175 | for specific BSPs could differ. |
| 176 | 176 | ||
| 177 | <literallayout class='monospaced'> | 177 | <literallayout class='monospaced'> |
| 178 | meta-<bsp_name>/ | 178 | meta-<replaceable>bsp_name</replaceable>/ |
| 179 | meta-<bsp_name>/<bsp_license_file> | 179 | meta-<replaceable>bsp_name</replaceable>/<replaceable>bsp_license_file</replaceable> |
| 180 | meta-<bsp_name>/README | 180 | meta-<replaceable>bsp_name</replaceable>/README |
| 181 | meta-<bsp_name>/README.sources | 181 | meta-<replaceable>bsp_name</replaceable>/README.sources |
| 182 | meta-<bsp_name>/binary/<bootable_images> | 182 | meta-<replaceable>bsp_name</replaceable>/binary/<replaceable>bootable_images</replaceable> |
| 183 | meta-<bsp_name>/conf/layer.conf | 183 | meta-<replaceable>bsp_name</replaceable>/conf/layer.conf |
| 184 | meta-<bsp_name>/conf/machine/*.conf | 184 | meta-<replaceable>bsp_name</replaceable>/conf/machine/*.conf |
| 185 | meta-<bsp_name>/recipes-bsp/* | 185 | meta-<replaceable>bsp_name</replaceable>/recipes-bsp/* |
| 186 | meta-<bsp_name>/recipes-core/* | 186 | meta-<replaceable>bsp_name</replaceable>/recipes-core/* |
| 187 | meta-<bsp_name>/recipes-graphics/* | 187 | meta-<replaceable>bsp_name</replaceable>/recipes-graphics/* |
| 188 | meta-<bsp_name>/recipes-kernel/linux/linux-yocto_<kernel_rev>.bbappend | 188 | meta-<replaceable>bsp_name</replaceable>/recipes-kernel/linux/linux-yocto_<replaceable>kernel_rev</replaceable>.bbappend |
| 189 | </literallayout> | 189 | </literallayout> |
| 190 | </para> | 190 | </para> |
| 191 | 191 | ||
| @@ -221,7 +221,6 @@ | |||
| 221 | meta-crownbay/recipes-kernel/linux/linux-yocto-dev.bbappend | 221 | meta-crownbay/recipes-kernel/linux/linux-yocto-dev.bbappend |
| 222 | meta-crownbay/recipes-kernel/linux/linux-yocto-rt_3.10.bbappend | 222 | meta-crownbay/recipes-kernel/linux/linux-yocto-rt_3.10.bbappend |
| 223 | meta-crownbay/recipes-kernel/linux/linux-yocto_3.10.bbappend | 223 | meta-crownbay/recipes-kernel/linux/linux-yocto_3.10.bbappend |
| 224 | meta-crownbay/recipes-kernel/linux/linux-yocto_3.14.bbappend | ||
| 225 | </literallayout> | 224 | </literallayout> |
| 226 | </para> | 225 | </para> |
| 227 | 226 | ||
| @@ -235,7 +234,7 @@ | |||
| 235 | <para> | 234 | <para> |
| 236 | You can find these files in the BSP Layer at: | 235 | You can find these files in the BSP Layer at: |
| 237 | <literallayout class='monospaced'> | 236 | <literallayout class='monospaced'> |
| 238 | meta-<bsp_name>/<bsp_license_file> | 237 | meta-<replaceable>bsp_name</replaceable>/<replaceable>bsp_license_file</replaceable> |
| 239 | </literallayout> | 238 | </literallayout> |
| 240 | </para> | 239 | </para> |
| 241 | 240 | ||
| @@ -257,7 +256,7 @@ | |||
| 257 | <para> | 256 | <para> |
| 258 | You can find this file in the BSP Layer at: | 257 | You can find this file in the BSP Layer at: |
| 259 | <literallayout class='monospaced'> | 258 | <literallayout class='monospaced'> |
| 260 | meta-<bsp_name>/README | 259 | meta-<replaceable>bsp_name</replaceable>/README |
| 261 | </literallayout> | 260 | </literallayout> |
| 262 | </para> | 261 | </para> |
| 263 | 262 | ||
| @@ -281,7 +280,7 @@ | |||
| 281 | <para> | 280 | <para> |
| 282 | You can find this file in the BSP Layer at: | 281 | You can find this file in the BSP Layer at: |
| 283 | <literallayout class='monospaced'> | 282 | <literallayout class='monospaced'> |
| 284 | meta-<bsp_name>/README.sources | 283 | meta-<replaceable>bsp_name</replaceable>/README.sources |
| 285 | </literallayout> | 284 | </literallayout> |
| 286 | </para> | 285 | </para> |
| 287 | 286 | ||
| @@ -300,7 +299,7 @@ | |||
| 300 | <para> | 299 | <para> |
| 301 | You can find these files in the BSP Layer at: | 300 | You can find these files in the BSP Layer at: |
| 302 | <literallayout class='monospaced'> | 301 | <literallayout class='monospaced'> |
| 303 | meta-<bsp_name>/binary/<bootable_images> | 302 | meta-<replaceable>bsp_name</replaceable>/binary/<replaceable>bootable_images</replaceable> |
| 304 | </literallayout> | 303 | </literallayout> |
| 305 | </para> | 304 | </para> |
| 306 | 305 | ||
| @@ -316,7 +315,7 @@ | |||
| 316 | 315 | ||
| 317 | <para> | 316 | <para> |
| 318 | The exact types of binaries present are highly hardware-dependent. | 317 | The exact types of binaries present are highly hardware-dependent. |
| 319 | However, a README file should be present in the BSP Layer that explains how to use | 318 | However, a <filename>README</filename> file should be present in the BSP Layer that explains how to use |
| 320 | the kernels and images with the target hardware. | 319 | the kernels and images with the target hardware. |
| 321 | If pre-built binaries are present, source code to meet licensing requirements must also | 320 | If pre-built binaries are present, source code to meet licensing requirements must also |
| 322 | exist in some form. | 321 | exist in some form. |
| @@ -328,7 +327,7 @@ | |||
| 328 | <para> | 327 | <para> |
| 329 | You can find this file in the BSP Layer at: | 328 | You can find this file in the BSP Layer at: |
| 330 | <literallayout class='monospaced'> | 329 | <literallayout class='monospaced'> |
| 331 | meta-<bsp_name>/conf/layer.conf | 330 | meta-<replaceable>bsp_name</replaceable>/conf/layer.conf |
| 332 | </literallayout> | 331 | </literallayout> |
| 333 | </para> | 332 | </para> |
| 334 | 333 | ||
| @@ -338,9 +337,9 @@ | |||
| 338 | contents of the layer, and contains information about how the build | 337 | contents of the layer, and contains information about how the build |
| 339 | system should use it. | 338 | system should use it. |
| 340 | Generally, a standard boilerplate file such as the following works. | 339 | Generally, a standard boilerplate file such as the following works. |
| 341 | In the following example, you would replace "<filename>bsp</filename>" and | 340 | In the following example, you would replace "<replaceable>bsp</replaceable>" and |
| 342 | "<filename>_bsp</filename>" with the actual name | 341 | "<replaceable>_bsp</replaceable>" with the actual name |
| 343 | of the BSP (i.e. <filename><bsp_name></filename> from the example template). | 342 | of the BSP (i.e. <replaceable>bsp_name</replaceable> from the example template). |
| 344 | </para> | 343 | </para> |
| 345 | 344 | ||
| 346 | <para> | 345 | <para> |
| @@ -381,7 +380,7 @@ | |||
| 381 | <para> | 380 | <para> |
| 382 | You can find these files in the BSP Layer at: | 381 | You can find these files in the BSP Layer at: |
| 383 | <literallayout class='monospaced'> | 382 | <literallayout class='monospaced'> |
| 384 | meta-<bsp_name>/conf/machine/*.conf | 383 | meta-<replaceable>bsp_name</replaceable>/conf/machine/*.conf |
| 385 | </literallayout> | 384 | </literallayout> |
| 386 | </para> | 385 | </para> |
| 387 | 386 | ||
| @@ -441,7 +440,7 @@ | |||
| 441 | <para> | 440 | <para> |
| 442 | You can find these files in the BSP Layer at: | 441 | You can find these files in the BSP Layer at: |
| 443 | <literallayout class='monospaced'> | 442 | <literallayout class='monospaced'> |
| 444 | meta-<bsp_name>/recipes-bsp/* | 443 | meta-<replaceable>bsp_name</replaceable>/recipes-bsp/* |
| 445 | </literallayout> | 444 | </literallayout> |
| 446 | </para> | 445 | </para> |
| 447 | 446 | ||
| @@ -478,7 +477,7 @@ | |||
| 478 | <para> | 477 | <para> |
| 479 | You can find these files in the BSP Layer at: | 478 | You can find these files in the BSP Layer at: |
| 480 | <literallayout class='monospaced'> | 479 | <literallayout class='monospaced'> |
| 481 | meta-<bsp_name>/recipes-graphics/* | 480 | meta-<replaceable>bsp_name</replaceable>/recipes-graphics/* |
| 482 | </literallayout> | 481 | </literallayout> |
| 483 | </para> | 482 | </para> |
| 484 | 483 | ||
| @@ -502,7 +501,7 @@ | |||
| 502 | <para> | 501 | <para> |
| 503 | You can find these files in the BSP Layer at: | 502 | You can find these files in the BSP Layer at: |
| 504 | <literallayout class='monospaced'> | 503 | <literallayout class='monospaced'> |
| 505 | meta-<bsp_name>/recipes-kernel/linux/linux-yocto_*.bbappend | 504 | meta-<replaceable>bsp_name</replaceable>/recipes-kernel/linux/linux-yocto_*.bbappend |
| 506 | </literallayout> | 505 | </literallayout> |
| 507 | </para> | 506 | </para> |
| 508 | 507 | ||
| @@ -515,13 +514,13 @@ | |||
| 515 | at <filename>meta/recipes-kernel/linux</filename>. | 514 | at <filename>meta/recipes-kernel/linux</filename>. |
| 516 | You can append your specific changes to the kernel recipe by using a | 515 | You can append your specific changes to the kernel recipe by using a |
| 517 | similarly named append file, which is located in the BSP Layer (e.g. | 516 | similarly named append file, which is located in the BSP Layer (e.g. |
| 518 | the <filename>meta-<bsp_name>/recipes-kernel/linux</filename> directory). | 517 | the <filename>meta-<replaceable>bsp_name</replaceable>/recipes-kernel/linux</filename> directory). |
| 519 | </para> | 518 | </para> |
| 520 | <para> | 519 | <para> |
| 521 | Suppose you are using the <filename>linux-yocto_3.10.bb</filename> recipe to build | 520 | Suppose you are using the <filename>linux-yocto_3.10.bb</filename> recipe to build |
| 522 | the kernel. | 521 | the kernel. |
| 523 | In other words, you have selected the kernel in your | 522 | In other words, you have selected the kernel in your |
| 524 | <filename><bsp_name>.conf</filename> file by adding these types | 523 | <replaceable>bsp_name</replaceable><filename>.conf</filename> file by adding these types |
| 525 | of statements: | 524 | of statements: |
| 526 | <literallayout class='monospaced'> | 525 | <literallayout class='monospaced'> |
| 527 | PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto" | 526 | PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto" |
| @@ -530,7 +529,7 @@ | |||
| 530 | <note> | 529 | <note> |
| 531 | When the preferred provider is assumed by default, the | 530 | When the preferred provider is assumed by default, the |
| 532 | <filename>PREFERRED_PROVIDER</filename> statement does not appear in the | 531 | <filename>PREFERRED_PROVIDER</filename> statement does not appear in the |
| 533 | <filename><bsp_name>.conf</filename> file. | 532 | <replaceable>bsp_name</replaceable><filename>.conf</filename> file. |
| 534 | </note> | 533 | </note> |
| 535 | You would use the <filename>linux-yocto_3.10.bbappend</filename> file to append | 534 | You would use the <filename>linux-yocto_3.10.bbappend</filename> file to append |
| 536 | specific BSP settings to the kernel, thus configuring the kernel for your particular BSP. | 535 | specific BSP settings to the kernel, thus configuring the kernel for your particular BSP. |
| @@ -752,7 +751,7 @@ | |||
| 752 | </para></listitem> | 751 | </para></listitem> |
| 753 | <listitem><para><emphasis>License File:</emphasis> | 752 | <listitem><para><emphasis>License File:</emphasis> |
| 754 | You must include a license file in the | 753 | You must include a license file in the |
| 755 | <filename>meta-<bsp_name></filename> directory. | 754 | <filename>meta-<replaceable>bsp_name</replaceable></filename> directory. |
| 756 | This license covers the BSP Metadata as a whole. | 755 | This license covers the BSP Metadata as a whole. |
| 757 | You must specify which license to use since there is no | 756 | You must specify which license to use since there is no |
| 758 | default license if one is not specified. | 757 | default license if one is not specified. |
| @@ -762,7 +761,7 @@ | |||
| 762 | as an example.</para></listitem> | 761 | as an example.</para></listitem> |
| 763 | <listitem><para><emphasis>README File:</emphasis> | 762 | <listitem><para><emphasis>README File:</emphasis> |
| 764 | You must include a <filename>README</filename> file in the | 763 | You must include a <filename>README</filename> file in the |
| 765 | <filename>meta-<bsp_name></filename> directory. | 764 | <filename>meta-<replaceable>bsp_name</replaceable></filename> directory. |
| 766 | See the | 765 | See the |
| 767 | <ulink url='&YOCTO_GIT_URL;/cgit.cgi/meta-intel/tree/meta-fri2/README'><filename>README</filename></ulink> | 766 | <ulink url='&YOCTO_GIT_URL;/cgit.cgi/meta-intel/tree/meta-fri2/README'><filename>README</filename></ulink> |
| 768 | file for the Fish River Island 2 BSP in the <filename>meta-fri2</filename> BSP layer | 767 | file for the Fish River Island 2 BSP in the <filename>meta-fri2</filename> BSP layer |
| @@ -804,7 +803,7 @@ | |||
| 804 | </itemizedlist></para></listitem> | 803 | </itemizedlist></para></listitem> |
| 805 | <listitem><para><emphasis>README.sources File:</emphasis> | 804 | <listitem><para><emphasis>README.sources File:</emphasis> |
| 806 | You must include a <filename>README.sources</filename> in the | 805 | You must include a <filename>README.sources</filename> in the |
| 807 | <filename>meta-<bsp_name></filename> directory. | 806 | <filename>meta-<replaceable>bsp_name</replaceable></filename> directory. |
| 808 | This file specifies exactly where you can find the sources used to | 807 | This file specifies exactly where you can find the sources used to |
| 809 | generate the binary images contained in the | 808 | generate the binary images contained in the |
| 810 | <filename>binary</filename> directory, if present. | 809 | <filename>binary</filename> directory, if present. |
| @@ -814,12 +813,13 @@ | |||
| 814 | as an example.</para></listitem> | 813 | as an example.</para></listitem> |
| 815 | <listitem><para><emphasis>Layer Configuration File:</emphasis> | 814 | <listitem><para><emphasis>Layer Configuration File:</emphasis> |
| 816 | You must include a <filename>conf/layer.conf</filename> in the | 815 | You must include a <filename>conf/layer.conf</filename> in the |
| 817 | <filename>meta-<bsp_name></filename> directory. | 816 | <filename>meta-<replaceable>bsp_name</replaceable></filename> directory. |
| 818 | This file identifies the <filename>meta-<bsp_name></filename> | 817 | This file identifies the <filename>meta-<replaceable>bsp_name</replaceable></filename> |
| 819 | BSP layer as a layer to the build system.</para></listitem> | 818 | BSP layer as a layer to the build system.</para></listitem> |
| 820 | <listitem><para><emphasis>Machine Configuration File:</emphasis> | 819 | <listitem><para><emphasis>Machine Configuration File:</emphasis> |
| 821 | You must include one or more <filename>conf/machine/<bsp_name>.conf</filename> | 820 | You must include one or more |
| 822 | files in the <filename>meta-<bsp_name></filename> directory. | 821 | <filename>conf/machine/<replaceable>bsp_name</replaceable>.conf</filename> |
| 822 | files in the <filename>meta-<replaceable>bsp_name</replaceable></filename> directory. | ||
| 823 | These configuration files define machine targets that can be built | 823 | These configuration files define machine targets that can be built |
| 824 | using the BSP layer. | 824 | using the BSP layer. |
| 825 | Multiple machine configuration files define variations of machine | 825 | Multiple machine configuration files define variations of machine |
| @@ -866,7 +866,7 @@ | |||
| 866 | filesystems meant to allow users to boot the BSP for evaluation | 866 | filesystems meant to allow users to boot the BSP for evaluation |
| 867 | purposes, you should put the images and artifacts within a | 867 | purposes, you should put the images and artifacts within a |
| 868 | <filename>binary/</filename> subdirectory located in the | 868 | <filename>binary/</filename> subdirectory located in the |
| 869 | <filename>meta-<bsp_name></filename> directory. | 869 | <filename>meta-<replaceable>bsp_name</replaceable></filename> directory. |
| 870 | <note>If you do include a bootable image as part of the BSP and the image | 870 | <note>If you do include a bootable image as part of the BSP and the image |
| 871 | was built by software covered by the GPL or other open source licenses, | 871 | was built by software covered by the GPL or other open source licenses, |
| 872 | it is your responsibility to understand | 872 | it is your responsibility to understand |
| @@ -1100,7 +1100,7 @@ | |||
| 1100 | Consequently, to use the scripts, you must <filename>source</filename> the | 1100 | Consequently, to use the scripts, you must <filename>source</filename> the |
| 1101 | environment just as you would when invoking a build: | 1101 | environment just as you would when invoking a build: |
| 1102 | <literallayout class='monospaced'> | 1102 | <literallayout class='monospaced'> |
| 1103 | $ source oe-init-build-env [build_dir] | 1103 | $ source oe-init-build-env <replaceable>build_dir</replaceable> |
| 1104 | </literallayout> | 1104 | </literallayout> |
| 1105 | </para> | 1105 | </para> |
| 1106 | 1106 | ||
