From 0526e01ddfe392ca3fece28a885104b5e19e3a39 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 22 Oct 2012 11:06:54 -0700 Subject: 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 Signed-off-by: Richard Purdie --- documentation/bsp-guide/bsp.xml | 68 +++++++++++++++++++++++++---------------- 1 file changed, 42 insertions(+), 26 deletions(-) (limited to 'documentation') diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml index 3732498873..a53ea98d8a 100644 --- a/documentation/bsp-guide/bsp.xml +++ b/documentation/bsp-guide/bsp.xml @@ -19,8 +19,7 @@ - This chapter (or document if you are reading the BSP Developer's Guide) - talks about BSP Layers, defines a structure for components + This guide presents information about BSP Layers, defines a structure for components so that BSPs follow a commonly understood layout, discusses how to customize a recipe for a BSP, addresses BSP licensing, and provides information that shows you how to create and manage a @@ -48,7 +47,7 @@ This root is what you add to the BBLAYERS variable in the conf/bblayers.conf file found in the - build directory. + Build Directory. Adding the root allows the OpenEmbedded build system to recognize the BSP definition and from it build an image. Here is an example: @@ -84,8 +83,6 @@ For more detailed information on layers, see the "Understanding and Creating Layers" section of the Yocto Project Development Manual. - You can also see the detailed examples in the appendices of the - Yocto Project Development Manual. @@ -183,9 +180,10 @@ meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-config/crownbay-noemgd/xorg.conf meta-crownbay/recipes-kernel/ meta-crownbay/recipes-kernel/linux/ - meta-crownbay/recipes-kernel/linux/linux-yocto-rt_3.0.bbappend - meta-crownbay/recipes-kernel/linux/linux-yocto_2.6.37.bbappend - meta-crownbay/recipes-kernel/linux/linux-yocto_3.0.bbappend + meta-crownbay/recipes-kernel/linux/linux-yocto-rt_3.2.bbappend + meta-crownbay/recipes-kernel/linux/linux-yocto-rt_3.4.bbappend + meta-crownbay/recipes-kernel/linux/linux-yocto_3.2.bbappend + meta-crownbay/recipes-kernel/linux/linux-yocto_3.4.bbappend @@ -496,11 +494,17 @@ Suppose you are using the linux-yocto_3.4.bb recipe to build the kernel. In other words, you have selected the kernel in your - <bsp_name>.conf file by adding the following statements: + <bsp_name>.conf file by adding these types + of statements: PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto" PREFERRED_VERSION_linux-yocto = "3.4%" + + When the preferred provider is assumed by default, the + PREFERRED_PROVIDER statement does not appear in the + <bsp_name>.conf file. + You would use the linux-yocto_3.4.bbappend file to append specific BSP settings to the kernel, thus configuring the kernel for your particular BSP. @@ -519,17 +523,22 @@ COMPATIBLE_MACHINE_crownbay = "crownbay" KMACHINE_crownbay = "crownbay" - KBRANCH_crownbay = "standard/default/crownbay" + KBRANCH_crownbay = "standard/crownbay" COMPATIBLE_MACHINE_crownbay-noemgd = "crownbay-noemgd" KMACHINE_crownbay-noemgd = "crownbay" - KBRANCH_crownbay-noemgd = "standard/default/crownbay" + KBRANCH_crownbay-noemgd = "standard/crownbay" + + SRCREV_machine_pn-linux-yocto_crownbay ?= "449f7f520350700858f21a5554b81cc8ad23267d" + SRCREV_meta_pn-linux-yocto_crownbay ?= "9e3bdb7344054264b750e53fbbb6394cc1c942ac" + SRCREV_emgd_pn-linux-yocto_crownbay ?= "86643bdd8cbad616a161ab91f51108cf0da827bc" - SRCREV_machine_pn-linux-yocto_crownbay ?= "48101e609711fcfe8d5e737a37a5a69f4bd57d9a" - SRCREV_meta_pn-linux-yocto_crownbay ?= "5b4c9dc78b5ae607173cc3ddab9bce1b5f78129b" + SRCREV_machine_pn-linux-yocto_crownbay-noemgd ?= "449f7f520350700858f21a5554b81cc8ad23267d" + SRCREV_meta_pn-linux-yocto_crownbay-noemgd ?= "9e3bdb7344054264b750e53fbbb6394cc1c942ac" - SRCREV_machine_pn-linux-yocto_crownbay-noemgd ?= "48101e609711fcfe8d5e737a37a5a69f4bd57d9a" - SRCREV_meta_pn-linux-yocto_crownbay-noemgd ?= "5b4c9dc78b5ae607173cc3ddab9bce1b5f78129b" + KSRC_linux_yocto_3_4 ?= "git.yoctoproject.org/linux-yocto-3.4.git" + 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" + SRC_URI_crownbay-noemgd = "git://git.yoctoproject.org/linux-yocto-3.4.git;protocol=git;nocheckout=1;branch=${KBRANCH},meta;name=machine,meta" This append file contains statements used to support the Crown Bay BSP for both Intel EMGD and the VESA graphics. @@ -542,10 +551,11 @@ COMPATIBLE_MACHINE_crownbay = "crownbay" KMACHINE_crownbay = "crownbay" - KBRANCH_crownbay = "standard/default/crownbay" + KBRANCH_crownbay = "standard/crownbay" - SRCREV_machine_pn-linux-yocto_crownbay ?= "48101e609711fcfe8d5e737a37a5a69f4bd57d9a" - SRCREV_meta_pn-linux-yocto_crownbay ?= "5b4c9dc78b5ae607173cc3ddab9bce1b5f78129b" + SRCREV_machine_pn-linux-yocto_crownbay ?= "449f7f520350700858f21a5554b81cc8ad23267d" + SRCREV_meta_pn-linux-yocto_crownbay ?= "9e3bdb7344054264b750e53fbbb6394cc1c942ac" + SRCREV_emgd_pn-linux-yocto_crownbay ?= "86643bdd8cbad616a161ab91f51108cf0da827bc" The append file defines crownbay as the COMPATIBLE_MACHINE @@ -557,10 +567,16 @@ KBRANCH variable to ensure the build process uses the standard/default/crownbay kernel branch. - Finally, the append file points to the specific top commits in the + Finally, the append file points to specific commits in the Source Directory Git repository and the meta Git repository branches to identify the exact kernel needed to build the Crown Bay BSP. + + For crownbay, a specific commit is also needed to point + to the branch that supports EMGD graphics. + At a minimum, every BSP points to the + machine and meta commits. + @@ -724,15 +740,15 @@ You must specify which license to use since there is no default license if one is not specified. See the - COPYING.MIT - file for the Fish River BSP in the meta-fishriver BSP layer + COPYING.MIT + file for the Fish River Island 2 BSP in the meta-fri2 BSP layer as an example. README File: You must include a README file in the meta-<bsp_name> directory. See the - README - file for the Fish River BSP in the meta-fishriver BSP layer + README + file for the Fish River Island 2 BSP in the meta-fri2 BSP layer as an example. At a minimum, the README file should contain the following: @@ -772,8 +788,8 @@ generate the binary images contained in the /binary directory, if present. See the - README.sources - file for the Fish River BSP in the meta-fishriver BSP layer + README.sources + file for the Fish River Island 2 BSP in the meta-fri2 BSP layer as an example. Layer Configuration File: You must include a conf/layer.conf in the @@ -839,7 +855,7 @@ Basing your recipes on these kernels reduces the costs for maintaining the BSP and increases its scalability. See the Yocto Linux Kernel category in the - Yocto Source Repositories + Source Repositories for these kernels. -- cgit v1.2.3-54-g00ecf