summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-10-22 18:06:54 (GMT)
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-10-22 23:03:16 (GMT)
commit0526e01ddfe392ca3fece28a885104b5e19e3a39 (patch)
treef72f23fb774488d2cf3da7136c2f9dc3297287c2
parenta4266b454cad4cab43de4c6fc823ff2c4e53e5c9 (diff)
downloadpoky-0526e01ddfe392ca3fece28a885104b5e19e3a39.tar.gz
documentation: bsp-guide - Final edits before 1.3 lockdown
Updated some example text based on the latest source repositories for crown bay. Replaced fishriver example with fri2. Updated some capitalization usage for source directory and build directory. (From yocto-docs rev: 65973f7b30699fbb82b4d7f1b907e947489ba7d0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/bsp-guide/bsp.xml68
1 files changed, 42 insertions, 26 deletions
diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml
index 3732498..a53ea98 100644
--- a/documentation/bsp-guide/bsp.xml
+++ b/documentation/bsp-guide/bsp.xml
@@ -19,8 +19,7 @@
19 </para> 19 </para>
20 20
21 <para> 21 <para>
22 This chapter (or document if you are reading the BSP Developer's Guide) 22 This guide presents information about BSP Layers, defines a structure for components
23 talks about BSP Layers, defines a structure for components
24 so that BSPs follow a commonly understood layout, discusses how to customize 23 so that BSPs follow a commonly understood layout, discusses how to customize
25 a recipe for a BSP, addresses BSP licensing, and provides information that 24 a recipe for a BSP, addresses BSP licensing, and provides information that
26 shows you how to create and manage a 25 shows you how to create and manage a
@@ -48,7 +47,7 @@
48 This root is what you add to the 47 This root is what you add to the
49 <ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'><filename>BBLAYERS</filename></ulink> 48 <ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'><filename>BBLAYERS</filename></ulink>
50 variable in the <filename>conf/bblayers.conf</filename> file found in the 49 variable in the <filename>conf/bblayers.conf</filename> file found in the
51 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>. 50 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
52 Adding the root allows the OpenEmbedded build system to recognize the BSP 51 Adding the root allows the OpenEmbedded build system to recognize the BSP
53 definition and from it build an image. 52 definition and from it build an image.
54 Here is an example: 53 Here is an example:
@@ -84,8 +83,6 @@
84 For more detailed information on layers, see the 83 For more detailed information on layers, see the
85 "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" 84 "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>"
86 section of the Yocto Project Development Manual. 85 section of the Yocto Project Development Manual.
87 You can also see the detailed examples in the appendices of the
88 <ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Manual</ulink>.
89 </para> 86 </para>
90 </section> 87 </section>
91 88
@@ -183,9 +180,10 @@
183 meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-config/crownbay-noemgd/xorg.conf 180 meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-config/crownbay-noemgd/xorg.conf
184 meta-crownbay/recipes-kernel/ 181 meta-crownbay/recipes-kernel/
185 meta-crownbay/recipes-kernel/linux/ 182 meta-crownbay/recipes-kernel/linux/
186 meta-crownbay/recipes-kernel/linux/linux-yocto-rt_3.0.bbappend 183 meta-crownbay/recipes-kernel/linux/linux-yocto-rt_3.2.bbappend
187 meta-crownbay/recipes-kernel/linux/linux-yocto_2.6.37.bbappend 184 meta-crownbay/recipes-kernel/linux/linux-yocto-rt_3.4.bbappend
188 meta-crownbay/recipes-kernel/linux/linux-yocto_3.0.bbappend 185 meta-crownbay/recipes-kernel/linux/linux-yocto_3.2.bbappend
186 meta-crownbay/recipes-kernel/linux/linux-yocto_3.4.bbappend
189 </literallayout> 187 </literallayout>
190 </para> 188 </para>
191 189
@@ -496,11 +494,17 @@
496 Suppose you are using the <filename>linux-yocto_3.4.bb</filename> recipe to build 494 Suppose you are using the <filename>linux-yocto_3.4.bb</filename> recipe to build
497 the kernel. 495 the kernel.
498 In other words, you have selected the kernel in your 496 In other words, you have selected the kernel in your
499 <filename>&lt;bsp_name&gt;.conf</filename> file by adding the following statements: 497 <filename>&lt;bsp_name&gt;.conf</filename> file by adding these types
498 of statements:
500 <literallayout class='monospaced'> 499 <literallayout class='monospaced'>
501 PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto" 500 PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto"
502 PREFERRED_VERSION_linux-yocto = "3.4%" 501 PREFERRED_VERSION_linux-yocto = "3.4%"
503 </literallayout> 502 </literallayout>
503 <note>
504 When the preferred provider is assumed by default, the
505 <filename>PREFERRED_PROVIDER</filename> statement does not appear in the
506 <filename>&lt;bsp_name&gt;.conf</filename> file.
507 </note>
504 You would use the <filename>linux-yocto_3.4.bbappend</filename> file to append 508 You would use the <filename>linux-yocto_3.4.bbappend</filename> file to append
505 specific BSP settings to the kernel, thus configuring the kernel for your particular BSP. 509 specific BSP settings to the kernel, thus configuring the kernel for your particular BSP.
506 </para> 510 </para>
@@ -519,17 +523,22 @@
519 523
520 COMPATIBLE_MACHINE_crownbay = "crownbay" 524 COMPATIBLE_MACHINE_crownbay = "crownbay"
521 KMACHINE_crownbay = "crownbay" 525 KMACHINE_crownbay = "crownbay"
522 KBRANCH_crownbay = "standard/default/crownbay" 526 KBRANCH_crownbay = "standard/crownbay"
523 527
524 COMPATIBLE_MACHINE_crownbay-noemgd = "crownbay-noemgd" 528 COMPATIBLE_MACHINE_crownbay-noemgd = "crownbay-noemgd"
525 KMACHINE_crownbay-noemgd = "crownbay" 529 KMACHINE_crownbay-noemgd = "crownbay"
526 KBRANCH_crownbay-noemgd = "standard/default/crownbay" 530 KBRANCH_crownbay-noemgd = "standard/crownbay"
531
532 SRCREV_machine_pn-linux-yocto_crownbay ?= "449f7f520350700858f21a5554b81cc8ad23267d"
533 SRCREV_meta_pn-linux-yocto_crownbay ?= "9e3bdb7344054264b750e53fbbb6394cc1c942ac"
534 SRCREV_emgd_pn-linux-yocto_crownbay ?= "86643bdd8cbad616a161ab91f51108cf0da827bc"
527 535
528 SRCREV_machine_pn-linux-yocto_crownbay ?= "48101e609711fcfe8d5e737a37a5a69f4bd57d9a" 536 SRCREV_machine_pn-linux-yocto_crownbay-noemgd ?= "449f7f520350700858f21a5554b81cc8ad23267d"
529 SRCREV_meta_pn-linux-yocto_crownbay ?= "5b4c9dc78b5ae607173cc3ddab9bce1b5f78129b" 537 SRCREV_meta_pn-linux-yocto_crownbay-noemgd ?= "9e3bdb7344054264b750e53fbbb6394cc1c942ac"
530 538
531 SRCREV_machine_pn-linux-yocto_crownbay-noemgd ?= "48101e609711fcfe8d5e737a37a5a69f4bd57d9a" 539 KSRC_linux_yocto_3_4 ?= "git.yoctoproject.org/linux-yocto-3.4.git"
532 SRCREV_meta_pn-linux-yocto_crownbay-noemgd ?= "5b4c9dc78b5ae607173cc3ddab9bce1b5f78129b" 540 SRC_URI_crownbay = "git://git.yoctoproject.org/linux-yocto-3.4.git;protocol=git;nocheckout=1;branch=${KBRANCH},meta,emgd-1.14;name=machine,meta,emgd"
541 SRC_URI_crownbay-noemgd = "git://git.yoctoproject.org/linux-yocto-3.4.git;protocol=git;nocheckout=1;branch=${KBRANCH},meta;name=machine,meta"
533 </literallayout> 542 </literallayout>
534 This append file contains statements used to support the Crown Bay BSP for both 543 This append file contains statements used to support the Crown Bay BSP for both
535 <trademark class='registered'>Intel</trademark> EMGD and the VESA graphics. 544 <trademark class='registered'>Intel</trademark> EMGD and the VESA graphics.
@@ -542,10 +551,11 @@
542 551
543 COMPATIBLE_MACHINE_crownbay = "crownbay" 552 COMPATIBLE_MACHINE_crownbay = "crownbay"
544 KMACHINE_crownbay = "crownbay" 553 KMACHINE_crownbay = "crownbay"
545 KBRANCH_crownbay = "standard/default/crownbay" 554 KBRANCH_crownbay = "standard/crownbay"
546 555
547 SRCREV_machine_pn-linux-yocto_crownbay ?= "48101e609711fcfe8d5e737a37a5a69f4bd57d9a" 556 SRCREV_machine_pn-linux-yocto_crownbay ?= "449f7f520350700858f21a5554b81cc8ad23267d"
548 SRCREV_meta_pn-linux-yocto_crownbay ?= "5b4c9dc78b5ae607173cc3ddab9bce1b5f78129b" 557 SRCREV_meta_pn-linux-yocto_crownbay ?= "9e3bdb7344054264b750e53fbbb6394cc1c942ac"
558 SRCREV_emgd_pn-linux-yocto_crownbay ?= "86643bdd8cbad616a161ab91f51108cf0da827bc"
549 </literallayout> 559 </literallayout>
550 The append file defines <filename>crownbay</filename> as the 560 The append file defines <filename>crownbay</filename> as the
551 <ulink url='&YOCTO_DOCS_REF_URL;#var-COMPATIBLE_MACHINE'><filename>COMPATIBLE_MACHINE</filename></ulink> 561 <ulink url='&YOCTO_DOCS_REF_URL;#var-COMPATIBLE_MACHINE'><filename>COMPATIBLE_MACHINE</filename></ulink>
@@ -557,10 +567,16 @@
557 <ulink url='&YOCTO_DOCS_REF_URL;#var-KBRANCH'><filename>KBRANCH</filename></ulink> variable 567 <ulink url='&YOCTO_DOCS_REF_URL;#var-KBRANCH'><filename>KBRANCH</filename></ulink> variable
558 to ensure the build process uses the <filename>standard/default/crownbay</filename> 568 to ensure the build process uses the <filename>standard/default/crownbay</filename>
559 kernel branch. 569 kernel branch.
560 Finally, the append file points to the specific top commits in the 570 Finally, the append file points to specific commits in the
561 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> Git 571 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> Git
562 repository and the <filename>meta</filename> Git repository branches to identify the 572 repository and the <filename>meta</filename> Git repository branches to identify the
563 exact kernel needed to build the Crown Bay BSP. 573 exact kernel needed to build the Crown Bay BSP.
574 <note>
575 For <filename>crownbay</filename>, a specific commit is also needed to point
576 to the branch that supports EMGD graphics.
577 At a minimum, every BSP points to the
578 <filename>machine</filename> and <filename>meta</filename> commits.
579 </note>
564 </para> 580 </para>
565 581
566 <para> 582 <para>
@@ -724,15 +740,15 @@
724 You must specify which license to use since there is no 740 You must specify which license to use since there is no
725 default license if one is not specified. 741 default license if one is not specified.
726 See the 742 See the
727 <ulink url='&YOCTO_GIT_URL;/cgit.cgi/meta-intel/tree/meta-fishriver/COPYING.MIT'><filename>COPYING.MIT</filename></ulink> 743 <ulink url='&YOCTO_GIT_URL;/cgit.cgi/meta-intel/tree/meta-fri2/COPYING.MIT'><filename>COPYING.MIT</filename></ulink>
728 file for the Fish River BSP in the <filename>meta-fishriver</filename> BSP layer 744 file for the Fish River Island 2 BSP in the <filename>meta-fri2</filename> BSP layer
729 as an example.</para></listitem> 745 as an example.</para></listitem>
730 <listitem><para><emphasis>README File:</emphasis> 746 <listitem><para><emphasis>README File:</emphasis>
731 You must include a <filename>README</filename> file in the 747 You must include a <filename>README</filename> file in the
732 <filename>meta-&lt;bsp_name&gt;</filename> directory. 748 <filename>meta-&lt;bsp_name&gt;</filename> directory.
733 See the 749 See the
734 <ulink url='&YOCTO_GIT_URL;/cgit.cgi/meta-intel/tree/meta-fishriver/README'><filename>README</filename></ulink> 750 <ulink url='&YOCTO_GIT_URL;/cgit.cgi/meta-intel/tree/meta-fri2/README'><filename>README</filename></ulink>
735 file for the Fish River BSP in the <filename>meta-fishriver</filename> BSP layer 751 file for the Fish River Island 2 BSP in the <filename>meta-fri2</filename> BSP layer
736 as an example.</para> 752 as an example.</para>
737 <para>At a minimum, the <filename>README</filename> file should 753 <para>At a minimum, the <filename>README</filename> file should
738 contain the following: 754 contain the following:
@@ -772,8 +788,8 @@
772 generate the binary images contained in the 788 generate the binary images contained in the
773 <filename>/binary</filename> directory, if present. 789 <filename>/binary</filename> directory, if present.
774 See the 790 See the
775 <ulink url='&YOCTO_GIT_URL;/cgit.cgi/meta-intel/tree/meta-fishriver/README.sources'><filename>README.sources</filename></ulink> 791 <ulink url='&YOCTO_GIT_URL;/cgit.cgi/meta-intel/tree/meta-fri2/README.sources'><filename>README.sources</filename></ulink>
776 file for the Fish River BSP in the <filename>meta-fishriver</filename> BSP layer 792 file for the Fish River Island 2 BSP in the <filename>meta-fri2</filename> BSP layer
777 as an example.</para></listitem> 793 as an example.</para></listitem>
778 <listitem><para><emphasis>Layer Configuration File:</emphasis> 794 <listitem><para><emphasis>Layer Configuration File:</emphasis>
779 You must include a <filename>conf/layer.conf</filename> in the 795 You must include a <filename>conf/layer.conf</filename> in the
@@ -839,7 +855,7 @@
839 Basing your recipes on these kernels reduces the costs for maintaining 855 Basing your recipes on these kernels reduces the costs for maintaining
840 the BSP and increases its scalability. 856 the BSP and increases its scalability.
841 See the <filename>Yocto Linux Kernel</filename> category in the 857 See the <filename>Yocto Linux Kernel</filename> category in the
842 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'><filename>Yocto Source Repositories</filename></ulink> 858 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'>Source Repositories</ulink>
843 for these kernels.</para></listitem> 859 for these kernels.</para></listitem>
844 </itemizedlist> 860 </itemizedlist>
845 </para> 861 </para>