Skip to contentSkip to conversation

Docs - BSP Guide Updates for changes to the BSP template

PATCH Applied Scott Rifenbark 3 participants 32 messages Dec 20, 2010 – Dec 21, 2010

lore
Share & tools
lore
#0 lore raw

cover Docs - BSP Guide Updates for changes to the BSP template

This group of commits represents the work done to the BSP Guide with Tom Z. and Saul W. I have updated the template to match a more generic standard that is based on the crownbay BSP that Tom has created. The rest of the work reflects re-writing the individual sections to match changes in the template. There were several iterations to the work between Tom and I.

Pull URL: git://git.pokylinux.org/poky-contrib.git
Branch: srifenbark/bsp-work
Browse: http://git.pokylinux.org/cgit.cgi/poky-contrib/log/?h=srifenbark/bsp-work

Thanks,
Scott Rifenbark <[email protected]>
---

Scott Rifenbark (29):
documentation/bsp-guide/bsp.xml: Changed meta naming convention documentation/bsp-guide/bsp.xml: Added note qualifying BSP file
structure.

  documentation/bsp-guide/bsp.xml:  Fixed typo
  documentation/bsp-guide/bsp.xml:  Added information about /binary
  documentation/bsp-guide/bsp.xml:  Created better BSP example base
    names
  documentation/bsp-guide/bsp.xml:  Inserted text before the file
    structure example
  documentation/bsp-guide/bsp.xml:  Updated common form for file
    structure.
  documentation/bsp-work/bsp.xml:  Added crownbay BSP example to
    section 1.1.
  documentation/bsp-guide/bsp.xml:  Updated the introductary paragraph
    to the sections.
  documentation/bsp-guide/bsp.xml:  Added new "License Files" section.
  documentation/bsp-guide/bsp.xml:  Added the README section.
  documentation/bsp-guide/bsp.xml:  Updated the Pre-built User Binaries

section.
documenation/bsp-guide/bsp.xml: Updated the Layer Configuration File
section.
documentation/bsp-guide/bsp.xml: Updated the Hardware Configuration
Options section
documentation/bsp-guide/bsp.xml: Added a Miscellaneous Recipe Files
section
documentation/bsp-guide/bsp.xml: Removed the recipes-bsp/formfactor
directory from the common structure.
documentation/bsp-guide/bsp.xml: Added a Display Support Files
section.
documentation/bsp-guide/bsp.xml: Updated Linux Kernel Configuration
section.
documentation/bsp-guide/bsp.xml: Commented out three sections. documentation/bsp-guide/bsp.xml: Changed numbering scheme. documentation/bsp-guide/bsp.xml: Updated Layer Configuration File
Section
documentation/bsp-guild/bsp.xml: Updated Miscellaneous Recipe Files
section
documentation/bsp-guide/bsp.xml: Updated Display Support Files
section.
documentation/bsp-guide/bsp.xml: Updated Linux Kernel Configuration
section.
documentation/bsp-guide/bsp.xml: Added reference to Kernel
documentation.
documentation/bsp-guide/bsp.xml: Updated the Linux Kernel
Configuration section
documentation/bsp-guide/bsp.xml: replaced the append file line in
the template
documentation/bsp-guide/bsp.xml: Updated Linux Kernel Configuration
section.
documentation/bsp-guide/bsp.xml: Spell checked the file.

 documentation/bsp-guide/bsp.xml |  324 ++++++++++++++++++++++++++++++---------
 1 files changed, 250 insertions(+), 74 deletions(-)
#1 lore raw

PATCH 1/29 documentation/bsp-guide/bsp.xml: Changed meta naming convention

Replaced meta-<bsp_name>/recipes-<bsp_name> with meta-<bsp_name>/recipes-bsp. This conforms to how the BSP standard will be working.

---
 documentation/bsp-guide/bsp.xml |    6 +++---
 1 files changed, 3 insertions(+), 3 deletions(-)
documentation/bsp-guide/bsp.xml +3 -3
index 3cad0fd..f55d14c 100644
@@ -82,9 +82,9 @@ meta-&lt;bsp_name&gt;/recipes-kernel/bootloader/bootloader_0.1.bb
 meta-&lt;bsp_name&gt;/recipes-kernel/linux/linux-bsp-2.6.50/*.patch
 meta-&lt;bsp_name&gt;/recipes-kernel/linux/linux-bsp-2.6.50/defconfig-bsp
 meta-&lt;bsp_name&gt;/recipes-kernel/linux/linux-bsp_2.6.50.bb
-meta-&lt;bsp_name&gt;/recipes-&lt;bsp_name&gt;/modem/modem-driver_0.1.bb
-meta-&lt;bsp_name&gt;/recipes-&lt;bsp_name&gt;/modem/modem-daemon_0.1.bb
-meta-&lt;bsp_name&gt;/recipes-&lt;bsp_name&gt;/image-creator/image-creator-native_0.1.bb
+meta-&lt;bsp_name&gt;/recipes-bsp/modem/modem-driver_0.1.bb
+meta-&lt;bsp_name&gt;/recipes-bsp/modem/modem-daemon_0.1.bb
+meta-&lt;bsp_name&gt;/recipes-bsp/image-creator/image-creator-native_0.1.bb
 meta-&lt;bsp_name&gt;/prebuilds/
                 </programlisting>
             </para>
Signature · 1 line
1.7.0.4
#2 lore raw

PATCH 2/29 documentation/bsp-guide/bsp.xml: Added note qualifying BSP file structure.

In reply to Scott Rifenbark

Inserted a note that states the BSP file structure shown is an example only and that a given BSP could have different files.

---
 documentation/bsp-guide/bsp.xml |    5 +++++
 1 files changed, 5 insertions(+), 0 deletions(-)
documentation/bsp-guide/bsp.xml +5 -0
index f55d14c..21bc5e4 100644
@@ -41,6 +41,11 @@
             the build system they are using.
         </para>
 
+        <note><para>
+            The file structure shown below is only an example and actual structures for 
+            specific BSPs could differ.
+        </para></note>
+
         <para>
             The BSP specification does not include a build system or other tools -
             it is concerned with the hardware-specific components only. 
Signature · 1 line
1.7.0.4
#3 lore raw

PATCH 3/29 documentation/bsp-guide/bsp.xml: Fixed typo

In reply to Scott Rifenbark

Two lines had been earlier turned into a single sentence but the capitalization of the second line still remained.
I switched "The" into "the".

---
 documentation/bsp-guide/bsp.xml |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)
documentation/bsp-guide/bsp.xml +1 -1
index 21bc5e4..9698e93 100644
@@ -33,7 +33,7 @@
             It is intended that this information can be 
             used by other systems besides Poky and OpenEmbedded and that it will be simple
             to extract information and convert it to other formats if required.
-            Poky, through its standard layers mechanism, can directly accept The format 
+            Poky, through its standard layers mechanism, can directly accept the format 
             described as a layer.
             The BSP captures all 
             the hardware-specific details in one place in a standard format, which is 
Signature · 1 line
1.7.0.4
#4 lore raw

PATCH 4/29 documentation/bsp-guide/bsp.xml: Added information about /binary

In reply to Scott Rifenbark

Added information in the section about Pre-built User Binaries. In the first paragraph I stated that this directory would contain the Application Development Toolkit and minimal live images when the BSP is "tarred" up and placed on the Yocto Project website.

---
 documentation/bsp-guide/bsp.xml |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)
documentation/bsp-guide/bsp.xml +3 -1
index 9698e93..321965a 100644
@@ -105,7 +105,9 @@ meta-&lt;bsp_name&gt;/prebuilds/
 
             <para>
                 This optional area contains useful pre-built kernels and userspace filesystem 
-                images appropriate to the target system. 
+                images appropriate to the target system.
+                This directory contains the Application Development Toolkit (ADT) and minimal
+                live images when the BSP is has been "tar-balled" and placed on the Yocto Project website. 
                 You can use these kernels and images to get a system running and quickly get started 
                 on development tasks. 
                 The exact types of binaries present are highly hardware-dependent.
Signature · 1 line
1.7.0.4
#5 lore raw

PATCH 5/29 documentation/bsp-guide/bsp.xml: Created better BSP example base names

In reply to Scott Rifenbark

Lowered the "E" for the "meta-emenlow" BSP.
Removed the "oaktrail" one, which is an Intel code name and replaced it with "beagleboard", which is a non-Intel board.

---
 documentation/bsp-guide/bsp.xml |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)
documentation/bsp-guide/bsp.xml +2 -2
index 321965a..10fff0b 100644
@@ -68,9 +68,9 @@
                 "bsp_name" is a placeholder for the machine or platform name.
                 Here are some example base directory names:
                 <literallayout class='monospaced'>
-     meta-Emenlow
+     meta-emenlow
      meta-intel_n450
-     meta-oaktrail
+     meta-beagleboard
                 </literallayout>
             </para>
 
Signature · 1 line
1.7.0.4
#6 lore raw

PATCH 6/29 documentation/bsp-guide/bsp.xml: Inserted text before the file structure example

In reply to Scott Rifenbark

Added some text in section 1.1 explaining that the file structure example is an example and that the file structure of specific BSPs could differ.

---
 documentation/bsp-guide/bsp.xml |   10 ++++------
 1 files changed, 4 insertions(+), 6 deletions(-)
documentation/bsp-guide/bsp.xml +4 -6
index 10fff0b..874ef6d 100644
@@ -41,11 +41,6 @@
             the build system they are using.
         </para>
 
-        <note><para>
-            The file structure shown below is only an example and actual structures for 
-            specific BSPs could differ.
-        </para></note>
-
         <para>
             The BSP specification does not include a build system or other tools -
             it is concerned with the hardware-specific components only. 
@@ -75,7 +70,10 @@
             </para>
 
             <para>
-                The file structure inside the base directory takes on the following form:
+                Below is the common form for the file structure inside a base directory.
+                While you can use this basic form for the standard, realize that the actual structures
+                for specific BSPs could differ. 
+
                 <programlisting>
 meta-&lt;bsp_name&gt;/                                
 meta-&lt;bsp_name&gt;/binary/zImage
Signature · 1 line
1.7.0.4
#7 lore raw

PATCH 7/29 documentation/bsp-guide/bsp.xml: Updated common form for file structure.

In reply to Scott Rifenbark
---
 documentation/bsp-guide/bsp.xml |   20 ++++++++------------
 1 files changed, 8 insertions(+), 12 deletions(-)
documentation/bsp-guide/bsp.xml +8 -12
index 874ef6d..f7dd12e 100644
@@ -76,19 +76,15 @@
 
                 <programlisting>
 meta-&lt;bsp_name&gt;/                                
-meta-&lt;bsp_name&gt;/binary/zImage
-meta-&lt;bsp_name&gt;/binary/poky-image-minimal.directdisk
+meta-&lt;bsp_name&gt;/&lt;bsp_license_file&gt;
+meta-&lt;bsp_name&gt;/README
+meta-&lt;bsp_name&gt;/binary/&lt;bootable_images&gt;
 meta-&lt;bsp_name&gt;/conf/layer.conf 
-meta-&lt;bsp_name&gt;/conf/machine/*.conf             
-meta-&lt;bsp_name&gt;/conf/machine/include/tune-*.inc
-meta-&lt;bsp_name&gt;/recipes-kernel/bootloader/bootloader_0.1.bb
-meta-&lt;bsp_name&gt;/recipes-kernel/linux/linux-bsp-2.6.50/*.patch
-meta-&lt;bsp_name&gt;/recipes-kernel/linux/linux-bsp-2.6.50/defconfig-bsp
-meta-&lt;bsp_name&gt;/recipes-kernel/linux/linux-bsp_2.6.50.bb
-meta-&lt;bsp_name&gt;/recipes-bsp/modem/modem-driver_0.1.bb
-meta-&lt;bsp_name&gt;/recipes-bsp/modem/modem-daemon_0.1.bb
-meta-&lt;bsp_name&gt;/recipes-bsp/image-creator/image-creator-native_0.1.bb
-meta-&lt;bsp_name&gt;/prebuilds/
+meta-&lt;bsp_name&gt;/conf/machine/*.conf
+meta-&lt;bsp_name&gt;/recipes-bsp/*
+meta-&lt;bsp_name&gt;/recipes-bsp/formfactor/formfactor/&lt;bsp_name&gt;/*
+meta-&lt;bsp_name&gt;/recipes-graphics/*            
+meta-&lt;bsp_name&gt;/recipes-kernel/linux/linux-wrs_git.bbappend
                 </programlisting>
             </para>
 
Signature · 1 line
1.7.0.4
#8 lore raw

PATCH 8/29 documentation/bsp-work/bsp.xml: Added crownbay BSP example to section 1.1.

In reply to Scott Rifenbark
---
 documentation/bsp-guide/bsp.xml |   24 ++++++++++++++++++++++++
 1 files changed, 24 insertions(+), 0 deletions(-)
documentation/bsp-guide/bsp.xml +24 -0
index f7dd12e..d2e293f 100644
@@ -89,6 +89,30 @@ meta-&lt;bsp_name&gt;/recipes-kernel/linux/linux-wrs_git.bbappend
             </para>
 
             <para>
+                Below is an example of the crownbay BSP:
+
+                <programlisting>
+meta-crownbay/COPYING.MIT
+meta-crownbay/README
+meta-crownbay/binary/.gitignore
+meta-crownbay/conf/layer.conf
+meta-crownbay/conf/machine/crownbay.conf
+meta-crownbay/recipes-bsp/formfactor/formfactor/crownbay/machconfig
+meta-crownbay/recipes-bsp/formfactor/formfactor_0.0.bbappend
+meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-config/crownbay/xcorg.conf
+meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-config_0.1.bbappend
+meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-emgd-bin/.gitignore
+meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-emgd-bin_1.7.99.2.bb
+meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-emgd/crosscompile.patch
+meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-emgd/fix_open_max_preprocessor_error.patch
+meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-emgd/macro_tweak.patch
+meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-emgd/nodolt.patch
+meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-emgd_1.7.99.2.bb
+meta-crownbay/recipes-kernel/linux/linux-wrs_git.bbappend
+                </programlisting>
+            </para>
+
+            <para>
                 The following sections detail what these files and directories could contain.
             </para>
 
Signature · 1 line
1.7.0.4
#9 lore raw

PATCH 9/29 documentation/bsp-guide/bsp.xml: Updated the introductary paragraph to the sections.

In reply to Scott Rifenbark
---
 documentation/bsp-guide/bsp.xml |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)
documentation/bsp-guide/bsp.xml +1 -1
index d2e293f..46746dc 100644
@@ -113,7 +113,7 @@ meta-crownbay/recipes-kernel/linux/linux-wrs_git.bbappend
             </para>
 
             <para>
-                The following sections detail what these files and directories could contain.
+                The following sections describe each part of the proposed BSP format.
             </para>
 
         </section>
Signature · 1 line
1.7.0.4
#10 lore raw

PATCH 10/29 documentation/bsp-guide/bsp.xml: Added new "License Files" section.

In reply to Scott Rifenbark
---
 documentation/bsp-guide/bsp.xml |   19 +++++++++++++++++++
 1 files changed, 19 insertions(+), 0 deletions(-)
documentation/bsp-guide/bsp.xml +19 -0
index 46746dc..2a96b56 100644
@@ -118,6 +118,25 @@ meta-crownbay/recipes-kernel/linux/linux-wrs_git.bbappend
 
         </section>
 
+        <section id="bsp-filelayout-license">
+            <title>License Files</title>
+            <programlisting>
+meta-&lt;bsp_name&gt;/&lt;bsp_license_file&gt;
+            </programlisting>
+
+            <para>
+                These optional files satisfy licensing requirements for the BSP.
+                The type or types of files here can vary depending on the licensing requirements.
+                For example, in the crownbay BSP all licensing requirements are handled with the 
+                <filename>COPYING.MIT</filename> file.  
+            </para>
+
+            <para>
+                Licensing files can be MIT, BSD, GPLv*, and so forth.
+                These files are recommended for the BSP but are optional and totally up to the BSP developer.
+            </para>
+        </section>
+
         <section id="bsp-filelayout-binary">
             <title>Pre-built User Binaries (meta-&lt;bsp_name&gt;/binary/*)</title>
 
Signature · 1 line
1.7.0.4
#11 lore raw

PATCH 11/29 documentation/bsp-guide/bsp.xml: Added the README section.

In reply to Scott Rifenbark
---
 documentation/bsp-guide/bsp.xml |   19 +++++++++++++++++++
 1 files changed, 19 insertions(+), 0 deletions(-)
documentation/bsp-guide/bsp.xml +19 -0
index 2a96b56..fcf10a6 100644
@@ -137,6 +137,25 @@ meta-&lt;bsp_name&gt;/&lt;bsp_license_file&gt;
             </para>
         </section>
 
+        <section id="bsp-filelayout-readme">
+            <title>README File</title>
+            <programlisting>
+meta-&lt;bsp_name&gt;/README
+            </programlisting>
+
+            <para>
+                This file provides information on how to boot the live images that are optionally 
+                included in the <filename>/binary</filename> directory.
+                The <filename>README</filename> file also provides special information needed for 
+                building the image.
+            </para>
+
+            <para>
+                Technically speaking a <filename>README</filename> is optional but it is highly 
+                recommended that every BSP has one.
+            </para>
+        </section>
+
         <section id="bsp-filelayout-binary">
             <title>Pre-built User Binaries (meta-&lt;bsp_name&gt;/binary/*)</title>
 
Signature · 1 line
1.7.0.4
#12 lore raw

PATCH 12/29 documentation/bsp-guide/bsp.xml: Updated the Pre-built User Binaries section.

In reply to Scott Rifenbark
---
 documentation/bsp-guide/bsp.xml |   14 ++++++++++----
 1 files changed, 10 insertions(+), 4 deletions(-)
documentation/bsp-guide/bsp.xml +10 -4
index fcf10a6..397ef85 100644
@@ -157,7 +157,10 @@ meta-&lt;bsp_name&gt;/README
         </section>
 
         <section id="bsp-filelayout-binary">
-            <title>Pre-built User Binaries (meta-&lt;bsp_name&gt;/binary/*)</title>
+            <title>Pre-built User Binaries</title>
+            <programlisting>
+meta-&lt;bsp_name&gt;/binary/&lt;bootable_images&gt;
+            </programlisting>
 
             <para>
                 This optional area contains useful pre-built kernels and userspace filesystem 
@@ -165,10 +168,13 @@ meta-&lt;bsp_name&gt;/README
                 This directory contains the Application Development Toolkit (ADT) and minimal
                 live images when the BSP is has been "tar-balled" and placed on the Yocto Project website. 
                 You can use these kernels and images to get a system running and quickly get started 
-                on development tasks. 
+                on development tasks.
+            </para>
+
+            <para> 
                 The exact types of binaries present are highly hardware-dependent.
-                However, a README file should be present that explains how to use the kernels and 
-                images with the target hardware. 
+                However, a README file should be present in the BSP file structure that explains how to use 
+                the kernels and images with the target hardware. 
                 If pre-built binaries are present, source code to meet licensing requirements must also 
                 be provided in some form.
             </para>
Signature · 1 line
1.7.0.4
#13 lore raw

PATCH 13/29 documenation/bsp-guide/bsp.xml: Updated the Layer Configuration File section.

In reply to Scott Rifenbark
---
 documentation/bsp-guide/bsp.xml |    8 +++++---
 1 files changed, 5 insertions(+), 3 deletions(-)
documentation/bsp-guide/bsp.xml +5 -3
index 397ef85..e59417d 100644
@@ -181,12 +181,14 @@ meta-&lt;bsp_name&gt;/binary/&lt;bootable_images&gt;
         </section>
 
         <section id='bsp-filelayout-layer'>
-            <title>Layer Configuration (meta-&lt;bsp_name&gt;/conf/layer.conf)</title>
+            <title>Layer Configuration File</title>
+            <programlisting>
+meta-&lt;bsp_name&gt;/conf/layer.conf 
+            </programlisting>
 
             <para>
                 This file identifies the structure as a Poky layer, identifies the  
-                contents of the layer, and contains information about how Poky should use 
-                it. 
+                contents of the layer, and contains information about how Poky should use it. 
                 Generally, a standard boilerplate file such as the following works:
             </para>
 
Signature · 1 line
1.7.0.4
#14 lore raw

PATCH 14/29 documentation/bsp-guide/bsp.xml: Updated the Hardware Configuration Options section

In reply to Scott Rifenbark

I combined the tuning stuff into this section.

---
 documentation/bsp-guide/bsp.xml |   13 ++++++-------
 1 files changed, 6 insertions(+), 7 deletions(-)
documentation/bsp-guide/bsp.xml +6 -7
index e59417d..752cb12 100644
@@ -213,7 +213,10 @@ BBFILE_PRIORITY_bsp = "5"
         </section>
 
         <section id="bsp-filelayout-machine">
-            <title>Hardware Configuration Options (meta-&lt;bsp_name&gt;/conf/machine/*.conf)</title>
+            <title>Hardware Configuration Options</title>
+            <programlisting>
+meta-&lt;bsp_name&gt;/conf/machine/*.conf
+            </programlisting>
 
             <para>
                 The machine files bind together all the information contained elsewhere
@@ -232,16 +235,12 @@ BBFILE_PRIORITY_bsp = "5"
             </para>
 
             <para>
-                At least one machine file is required for a Poky BSP layer.
+                At least one machine file is required for a BSP layer.
                 However, you can supply more than one file.
             </para>
-        </section>
-
-        <section id="bsp-filelayout-tune">
-            <title>Hardware Optimization Options (meta-&lt;bsp_name&gt;/conf/machine/include/tune-*.inc)</title>
 
             <para>
-                These files are shared hardware "tuning" definitions and are commonly used to
+                This directory could also contain shared hardware "tuning" definitions that are commonly used to
                 pass specific optimization flags to the compiler. 
                 An example is <filename>tune-atom.inc</filename>:
             </para>
Signature · 1 line
1.7.0.4
#15 lore raw

PATCH 15/29 documentation/bsp-guide/bsp.xml: Added a Miscellaneous Recipe Files section

In reply to Scott Rifenbark
---
 documentation/bsp-guide/bsp.xml |   18 ++++++++++++++++++
 1 files changed, 18 insertions(+), 0 deletions(-)
documentation/bsp-guide/bsp.xml +18 -0
index 752cb12..ba03981 100644
@@ -265,6 +265,24 @@ TARGET_CC_ARCH = "-m32 -march=core2 -msse3 -mtune=generic -mfpmath=sse"
             </para>
         </section>
 
+        <section id='bsp-filelayout-misc-recipes'>
+            <title>Miscellaneous Recipe Files</title>
+            <programlisting>
+meta-&lt;bsp_name&gt;/recipes-bsp/*
+            </programlisting>
+
+            <para>
+                This directory contains miscellaneous recipe files for the BSP.
+                Most notably would be the formactor files.
+                For example, in the crownbay BSP there is a <filename>machconfig</filename> file and a
+                <filename>formfactor_0.0.bbappend</filename> file:
+                <programlisting>
+meta-crownbay/recipes-bsp/formfactor/formfactor/crownbay/machconfig
+meta-crownbay/recipes-bsp/formfactor/formfactor_0.0.bbappend
+                </programlisting>
+            </para>
+        </section>
+
         <section id='bsp-filelayout-kernel'>
             <title>Linux Kernel Configuration (meta-&lt;bsp_name&gt;/recipes-kernel/linux/*)</title>
 
Signature · 1 line
1.7.0.4
#16 lore raw

PATCH 16/29 documentation/bsp-guide/bsp.xml: Removed the recipes-bsp/formfactor directory from the common structure.

In reply to Scott Rifenbark
---
 documentation/bsp-guide/bsp.xml |    1 -
 1 files changed, 0 insertions(+), 1 deletions(-)
documentation/bsp-guide/bsp.xml +0 -1
index ba03981..4a3b441 100644
@@ -82,7 +82,6 @@ meta-&lt;bsp_name&gt;/binary/&lt;bootable_images&gt;
 meta-&lt;bsp_name&gt;/conf/layer.conf 
 meta-&lt;bsp_name&gt;/conf/machine/*.conf
 meta-&lt;bsp_name&gt;/recipes-bsp/*
-meta-&lt;bsp_name&gt;/recipes-bsp/formfactor/formfactor/&lt;bsp_name&gt;/*
 meta-&lt;bsp_name&gt;/recipes-graphics/*            
 meta-&lt;bsp_name&gt;/recipes-kernel/linux/linux-wrs_git.bbappend
                 </programlisting>
Signature · 1 line
1.7.0.4
#17 lore raw

PATCH 17/29 documentation/bsp-guide/bsp.xml: Added a Display Support Files section.

In reply to Scott Rifenbark
---
 documentation/bsp-guide/bsp.xml |   24 ++++++++++++++++++++++++
 1 files changed, 24 insertions(+), 0 deletions(-)
documentation/bsp-guide/bsp.xml +24 -0
index 4a3b441..5058777 100644
@@ -282,6 +282,30 @@ meta-crownbay/recipes-bsp/formfactor/formfactor_0.0.bbappend
             </para>
         </section>
 
+        <section id='bsp-filelayout-recipes-graphics'>
+            <title>Display Support Files</title>
+            <programlisting>
+meta-&lt;bsp_name&gt;/recipes-graphics/*            
+            </programlisting>
+
+            <para>
+                This directory contains graphics recipes for the BSP.
+                All files that are needed for the BSP to support a display are kept here. 
+                For example, in the crownbay BSP several display support files exist:
+                <programlisting>
+meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-config/crownbay/xcorg.conf
+meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-config_0.1.bbappend
+meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-emgd-bin/.gitignore
+meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-emgd-bin_1.7.99.2.bb
+meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-emgd/crosscompile.patch
+meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-emgd/fix_open_max_preprocessor_error.patch
+meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-emgd/macro_tweak.patch
+meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-emgd/nodolt.patch
+meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-emgd_1.7.99.2.bb
+                </programlisting>
+            </para>
+        </section>
+
         <section id='bsp-filelayout-kernel'>
             <title>Linux Kernel Configuration (meta-&lt;bsp_name&gt;/recipes-kernel/linux/*)</title>
 
Signature · 1 line
1.7.0.4
#18 lore raw

PATCH 18/29 documentation/bsp-guide/bsp.xml: Updated Linux Kernel Configuration section.

In reply to Scott Rifenbark
---
 documentation/bsp-guide/bsp.xml |    9 ++++++---
 1 files changed, 6 insertions(+), 3 deletions(-)
documentation/bsp-guide/bsp.xml +6 -3
index 5058777..25bc2a8 100644
@@ -307,7 +307,10 @@ meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-emgd_1.7.99.2.bb
         </section>
 
         <section id='bsp-filelayout-kernel'>
-            <title>Linux Kernel Configuration (meta-&lt;bsp_name&gt;/recipes-kernel/linux/*)</title>
+            <title>Linux Kernel Configuration</title>
+            <programlisting>
+meta-&lt;bsp_name&gt;/recipes-kernel/linux/linux-wrs_git.bbappend
+            </programlisting>
 
             <para>
                 These files make up the definition of a kernel to use with this hardware. 
@@ -316,7 +319,7 @@ meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-emgd_1.7.99.2.bb
                 However, kernels can be shared between many machines as well.
                 Following is an example:
                <programlisting>
-meta-Emenlow/recipes-kernel/linux/linux-bsp_2.6.50.bb
+meta-emenlow/recipes-kernel/linux/linux-bsp_2.6.50.bb
                </programlisting>
                 This example file is the core kernel recipe that details from where to get the kernel
                 source.
@@ -340,7 +343,7 @@ linux-bsp-2.6.50/*.patch
             </para>
             <para>
                 <programlisting>
-meta-Emenlow/recipes-kernel/linux/linux-bsp-2.6.50/defconfig-bsp
+meta-emenlow/recipes-kernel/linux/linux-bsp-2.6.50/defconfig-bsp
                 </programlisting>
             </para>
             <para>
Signature · 1 line
1.7.0.4
#19 lore raw

PATCH 19/29 documentation/bsp-guide/bsp.xml: Commented out three sections.

In reply to Scott Rifenbark

There are some sections now that don't correspond one-to-one with the standard file structure presented in section 1.1. So I am commenting them out for now. Since I am still in the process of iterating on this manual I don't want to just delete the information.

---
 documentation/bsp-guide/bsp.xml |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)
documentation/bsp-guide/bsp.xml +2 -2
index 25bc2a8..37e7fe8 100644
@@ -355,7 +355,7 @@ meta-emenlow/recipes-kernel/linux/linux-bsp-2.6.50/defconfig-bsp
             </para>
         </section>
 
-        <section id='bsp-filelayout-packages'>
+<!--        <section id='bsp-filelayout-packages'>
             <title>Other Software (meta-&lt;bsp_name&gt;/recipes-kernel/*)</title>
 
             <para>
@@ -442,7 +442,7 @@ FILESEXTRAPATHS := "${THISDIR}/${PN}"
                 Assuming a compatible configuration is used, Poky can process and use these optional pre-compiled 
                 representations to provide much faster build times.
             </para>
-        </section>
+        </section> -->
 
         <section id='bsp-click-through-licensing'>
             <title>BSP 'Click-Through' Licensing Procedure</title>
Signature · 1 line
1.7.0.4
#20 lore raw

PATCH 20/29 documentation/bsp-guide/bsp.xml: Changed numbering scheme.

In reply to Scott Rifenbark

It makes more sense to have the sections that describe the various parts of the common structure as sub-sections to that. That pulls out the click-through licensing into a higher-level section. This is better overall section organization.

---
 documentation/bsp-guide/bsp.xml |   47 +++++++++++++++++++--------------------
 1 files changed, 23 insertions(+), 24 deletions(-)
documentation/bsp-guide/bsp.xml +23 -24
index 37e7fe8..8518bf0 100644
@@ -115,9 +115,7 @@ meta-crownbay/recipes-kernel/linux/linux-wrs_git.bbappend
                 The following sections describe each part of the proposed BSP format.
             </para>
 
-        </section>
-
-        <section id="bsp-filelayout-license">
+            <section id="bsp-filelayout-license">
             <title>License Files</title>
             <programlisting>
 meta-&lt;bsp_name&gt;/&lt;bsp_license_file&gt;
@@ -134,9 +132,9 @@ meta-&lt;bsp_name&gt;/&lt;bsp_license_file&gt;
                 Licensing files can be MIT, BSD, GPLv*, and so forth.
                 These files are recommended for the BSP but are optional and totally up to the BSP developer.
             </para>
-        </section>
+            </section>
 
-        <section id="bsp-filelayout-readme">
+            <section id="bsp-filelayout-readme">
             <title>README File</title>
             <programlisting>
 meta-&lt;bsp_name&gt;/README
@@ -153,9 +151,9 @@ meta-&lt;bsp_name&gt;/README
                 Technically speaking a <filename>README</filename> is optional but it is highly 
                 recommended that every BSP has one.
             </para>
-        </section>
+            </section>
 
-        <section id="bsp-filelayout-binary">
+            <section id="bsp-filelayout-binary">
             <title>Pre-built User Binaries</title>
             <programlisting>
 meta-&lt;bsp_name&gt;/binary/&lt;bootable_images&gt;
@@ -177,9 +175,9 @@ meta-&lt;bsp_name&gt;/binary/&lt;bootable_images&gt;
                 If pre-built binaries are present, source code to meet licensing requirements must also 
                 be provided in some form.
             </para>
-        </section>
+            </section>
 
-        <section id='bsp-filelayout-layer'>
+            <section id='bsp-filelayout-layer'>
             <title>Layer Configuration File</title>
             <programlisting>
 meta-&lt;bsp_name&gt;/conf/layer.conf 
@@ -209,9 +207,9 @@ BBFILE_PRIORITY_bsp = "5"
                 This file simply makes BitBake aware of the recipes and configuration directories.
                 This file must exist so that Poky can recognize the BSP.
             </para>
-        </section>
+            </section>
 
-        <section id="bsp-filelayout-machine">
+            <section id="bsp-filelayout-machine">
             <title>Hardware Configuration Options</title>
             <programlisting>
 meta-&lt;bsp_name&gt;/conf/machine/*.conf
@@ -262,9 +260,9 @@ TARGET_CC_ARCH = "-m32 -march=core2 -msse3 -mtune=generic -mfpmath=sse"
             <para>
                 Both the base package architecuture file and the tune file are optional for a Poky BSP layer.
             </para>
-        </section>
+            </section>
 
-        <section id='bsp-filelayout-misc-recipes'>
+            <section id='bsp-filelayout-misc-recipes'>
             <title>Miscellaneous Recipe Files</title>
             <programlisting>
 meta-&lt;bsp_name&gt;/recipes-bsp/*
@@ -280,9 +278,9 @@ meta-crownbay/recipes-bsp/formfactor/formfactor/crownbay/machconfig
 meta-crownbay/recipes-bsp/formfactor/formfactor_0.0.bbappend
                 </programlisting>
             </para>
-        </section>
+            </section>
 
-        <section id='bsp-filelayout-recipes-graphics'>
+            <section id='bsp-filelayout-recipes-graphics'>
             <title>Display Support Files</title>
             <programlisting>
 meta-&lt;bsp_name&gt;/recipes-graphics/*            
@@ -304,9 +302,9 @@ meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-emgd/nodolt.patch
 meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-emgd_1.7.99.2.bb
                 </programlisting>
             </para>
-        </section>
+            </section>
 
-        <section id='bsp-filelayout-kernel'>
+            <section id='bsp-filelayout-kernel'>
             <title>Linux Kernel Configuration</title>
             <programlisting>
 meta-&lt;bsp_name&gt;/recipes-kernel/linux/linux-wrs_git.bbappend
@@ -353,9 +351,9 @@ meta-emenlow/recipes-kernel/linux/linux-bsp-2.6.50/defconfig-bsp
                 Examples of kernel recipes are available in Poky itself, and thus, make these files optional.
                 However, it would be unusual not to have a kernel configuration.
             </para>
-        </section>
+            </section>
 
-<!--        <section id='bsp-filelayout-packages'>
+<!--            <section id='bsp-filelayout-packages'>
             <title>Other Software (meta-&lt;bsp_name&gt;/recipes-kernel/*)</title>
 
             <para>
@@ -400,9 +398,9 @@ meta-Emenlow/recipes-Emenlow/modem/modem-daemon_0.1.bb
 meta-Emenlow/recipes-Emenlow/image-creator/image-creator-native_0.1.bb
                </programlisting>
             </para>
-        </section>
+            </section>
 
-        <section id='bs-filelayout-bbappend'>
+            <section id='bs-filelayout-bbappend'>
             <title>Append BSP-Specific Information to Existing Recipes</title>
             <para>
                 Suppose you have a recipe such as "pointercal" that requires machine-specific information.
@@ -432,9 +430,9 @@ FILESEXTRAPATHS := "${THISDIR}/${PN}"
             which will be picked up by BitBake. 
             For an example see <filename>meta-emenlow/packages/formfactor</filename>.
             </para>
-        </section>
+            </section>
 
-        <section id="bsp-filelayout-prebuilds">
+            <section id="bsp-filelayout-prebuilds">
             <title>Pre-build Data (meta-&lt;bsp_name&gt;/prebuilds/*)</title>
             <para>
                 This location can contain precompiled representations of the source code 
@@ -442,7 +440,8 @@ FILESEXTRAPATHS := "${THISDIR}/${PN}"
                 Assuming a compatible configuration is used, Poky can process and use these optional pre-compiled 
                 representations to provide much faster build times.
             </para>
-        </section> -->
+            </section> -->
+        </section>
 
         <section id='bsp-click-through-licensing'>
             <title>BSP 'Click-Through' Licensing Procedure</title>
Signature · 1 line
1.7.0.4
#21 lore raw

PATCH 21/29 documentation/bsp-guide/bsp.xml: Updated Layer Configuration File Section

In reply to Scott Rifenbark

Added wording to be sure user knows to replace "bsp" and "_bsp" in the boilerplate template example with the actual BSP name (i.e. <bsp_name>).

---
 documentation/bsp-guide/bsp.xml |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)
documentation/bsp-guide/bsp.xml +3 -1
index 8518bf0..5dd4aa7 100644
@@ -186,7 +186,9 @@ meta-&lt;bsp_name&gt;/conf/layer.conf
             <para>
                 This file identifies the structure as a Poky layer, identifies the  
                 contents of the layer, and contains information about how Poky should use it. 
-                Generally, a standard boilerplate file such as the following works:
+                Generally, a standard boilerplate file such as the following works.
+                In the following example you would replace "bsp" and "_bsp" with the actual name
+                of the BSP (i.e. &lt;bsp_name&gt; from the example template).
             </para>
 
             <para>
Signature · 1 line
1.7.0.4
#22 lore raw

PATCH 22/29 documentation/bsp-guild/bsp.xml: Updated Miscellaneous Recipe Files section

In reply to Scott Rifenbark

Found a mis-spelling that I corrected.
Also added wording to indicate this directory is optional. Put in a note telling that defaults are set if a formfactor is not found.

---
 documentation/bsp-guide/bsp.xml |    9 +++++++--
 1 files changed, 7 insertions(+), 2 deletions(-)
documentation/bsp-guide/bsp.xml +7 -2
index 5dd4aa7..2120a1b 100644
@@ -271,8 +271,8 @@ meta-&lt;bsp_name&gt;/recipes-bsp/*
             </programlisting>
 
             <para>
-                This directory contains miscellaneous recipe files for the BSP.
-                Most notably would be the formactor files.
+                This optional directory contains miscellaneous recipe files for the BSP.
+                Most notably would be the formfactor files.
                 For example, in the crownbay BSP there is a <filename>machconfig</filename> file and a
                 <filename>formfactor_0.0.bbappend</filename> file:
                 <programlisting>
@@ -280,6 +280,11 @@ meta-crownbay/recipes-bsp/formfactor/formfactor/crownbay/machconfig
 meta-crownbay/recipes-bsp/formfactor/formfactor_0.0.bbappend
                 </programlisting>
             </para>
+
+            <note><para>
+                If a BSP does not have a formfactor entry, defaults are established according to
+                the configuration script.
+            </para></note>
             </section>
 
             <section id='bsp-filelayout-recipes-graphics'>
Signature · 1 line
1.7.0.4
#23 lore raw

PATCH 23/29 documentation/bsp-guide/bsp.xml: Updated Display Support Files section.

In reply to Scott Rifenbark

Added wording to indicate this directory as optional if the BSP had special requirements for graphics support.

---
 documentation/bsp-guide/bsp.xml |    3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)
documentation/bsp-guide/bsp.xml +2 -1
index 2120a1b..94dd516 100644
@@ -294,7 +294,8 @@ meta-&lt;bsp_name&gt;/recipes-graphics/*
             </programlisting>
 
             <para>
-                This directory contains graphics recipes for the BSP.
+                This optional directory contains recipes for the BSP if it has 
+                special requirements for graphics support.
                 All files that are needed for the BSP to support a display are kept here. 
                 For example, in the crownbay BSP several display support files exist:
                 <programlisting>
Signature · 1 line
1.7.0.4
#24 lore raw

PATCH 24/29 documentation/bsp-guide/bsp.xml: Updated Linux Kernel Configuration section.

In reply to Scott Rifenbark

I have re-written this section extensively based on a phone call with Tom Z.

---
 documentation/bsp-guide/bsp.xml |   69 ++++++++++++++++++++++----------------
 1 files changed, 40 insertions(+), 29 deletions(-)
documentation/bsp-guide/bsp.xml +40 -29
index 94dd516..cf9c91f 100644
@@ -319,46 +319,57 @@ meta-&lt;bsp_name&gt;/recipes-kernel/linux/linux-wrs_git.bbappend
             </programlisting>
 
             <para>
-                These files make up the definition of a kernel to use with this hardware. 
-                In this case, it is a complete self-contained kernel with its own
-                configuration and patches.
-                However, kernels can be shared between many machines as well.
-                Following is an example:
-               <programlisting>
-meta-emenlow/recipes-kernel/linux/linux-bsp_2.6.50.bb
-               </programlisting>
-                This example file is the core kernel recipe that details from where to get the kernel
-                source.
-                All standard source code locations are supported.
-                Consequently, the source could be a release tarball, a git repository, or source included in
-                the directory within the BSP itself.
-            </para>
-            <para>
-                The file then contains information about what patches to apply and how to configure and build them.
-                Because the file can reuse the main Poky kernel build class, the definitions here can 
-                remain very simple.   
+                This file appends your specific changes to the kernel you are using.
             </para>
             <para>
-                <programlisting>
-linux-bsp-2.6.50/*.patch
-                </programlisting>
+                For your BSP you typically want to use an existing Poky kernel found in the 
+                Poky repository at <filename class='directory'>meta/recipes-kernel/kernel</filename>.
+                You can append your specific changes to the kernel by using a 
+                <filename>.bbappend</filename> file, which is located in the 
+                <filename class='directory'>meta-&lt;bsp_name&gt;/recipes-kernel/linux</filename>
+                directory.
             </para>
             <para>
-                The above example file contains patches you can apply against the base kernel, from wherever
-                they may have been obtained.
+                Consider a BSP that uses the <filename>linux-yocto-stable_git.bb</filename> kernel.
+                You would use the <filename>linux-yocto-stable_git.bbappend</filename> file to add 
+                specific BSP settings to the kernel, thus configuring the kernel for your particular BSP.
             </para>
             <para>
+                Consider an example for the existing "crownbay" BSP.
+                The <filename>.bbaappend</filename> file used for the "crownbay" BSP is:
+                <programlisting>
+meta-crownbay/recipes-kernel/linux/linux-wrs_git.bbappend
+                </programlisting>
+                The file contains the following:
                 <programlisting>
-meta-emenlow/recipes-kernel/linux/linux-bsp-2.6.50/defconfig-bsp
+FILESEXTRAPATHS := "${THISDIR}/${PN}"
+COMPATIBLE_MACHINE_crownbay = "cronwbay"
+KMACHINE_crownbay = "crownbay"
                 </programlisting>
+                This <filename>.bbappend</filename> file adds "crownbay" as a compatible machine,
+                and additionally sets a Yocto Kernel-specific variable that identifies the name of the 
+                BSP branch to use in the GIT repository to find configuration information.
             </para>
-            <para>
-                Finally, this last example file contains kernel configuration information.
+            <note><para>
+                For an established BSP the configuration information is incorporated directly into the 
+                git tree.
+                For a new BSP, however, the <filename>.bbappend</filename> file needs to 
+                include its own set of configuration options in a file called 
+                <filename>defconfig</filename> located in a directory that matches the recipe name.
+                <programlisting>
+SRC_URI += "file://defconfig"
+                </programlisting>
+                Once a BSP is committed, the Yocto kernel maintainer moves this configuration information
+                into the git tree so that the <filename>.bbappend</filename> file does not need to locate
+                its own configuration options.
+                Again, the initial configuration options using the SRC_URI are put into a 
+                directory named 
+                <filename class='directory'>meta-&lt;bsp_name&gt;/recipes/linux/linux-yocto-stable</filename>.
             </para>
             <para>
-                Examples of kernel recipes are available in Poky itself, and thus, make these files optional.
-                However, it would be unusual not to have a kernel configuration.
-            </para>
+                 You can find more information about creating a BSP that is based on an existing similar
+                 BSP by reading the "Yocto Project Kernel Architecture and Use Manual."
+            </para></note>
             </section>
 
 <!--            <section id='bsp-filelayout-packages'>
Signature · 1 line
1.7.0.4
#25 lore raw

PATCH 25/29 documentation/bsp-guide/bsp.xml: Added reference to Kernel documentation.

In reply to Scott Rifenbark

I added a reference to the specific section in the kernel documentation that describes how to create a BSP Based on an existing similar BSP. The tools we have that create the PDF manuals from the DocBook XML do not support cross-referencing to another PDF manual. So, I was left with adding a clunky text-based reference to the section and a link to the docs page on the web-site.

---
 documentation/bsp-guide/bsp.xml |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)
documentation/bsp-guide/bsp.xml +3 -1
index cf9c91f..75640cc 100644
@@ -368,7 +368,9 @@ SRC_URI += "file://defconfig"
             </para>
             <para>
                  You can find more information about creating a BSP that is based on an existing similar
-                 BSP by reading the "Yocto Project Kernel Architecture and Use Manual."
+                 BSP by reading the "Creating a BSP Based on an Existing Similar BSP" section in the 
+                 "<ulink url="http://www.yoctoproject.org/community/documentation">Yocto Project
+                 Kernel Architecture and Use Manual</ulink>".
             </para></note>
             </section>
 
Signature · 1 line
1.7.0.4
#26 lore raw

PATCH 26/29 documentation/bsp-guide/bsp.xml: Updated the Linux Kernel Configuration section

In reply to Scott Rifenbark

These changes are another round of edits from Tom Z.

---
 documentation/bsp-guide/bsp.xml |   89 +++++++++++++++++++++++++++-----------
 1 files changed, 63 insertions(+), 26 deletions(-)
documentation/bsp-guide/bsp.xml +63 -26
index 75640cc..ff8a481 100644
@@ -324,21 +324,22 @@ meta-&lt;bsp_name&gt;/recipes-kernel/linux/linux-wrs_git.bbappend
             <para>
                 For your BSP you typically want to use an existing Poky kernel found in the 
                 Poky repository at <filename class='directory'>meta/recipes-kernel/kernel</filename>.
-                You can append your specific changes to the kernel by using a 
-                <filename>.bbappend</filename> file, which is located in the 
-                <filename class='directory'>meta-&lt;bsp_name&gt;/recipes-kernel/linux</filename>
+                You can append your specific changes to the kernel recipe by using an append file, 
+                which is located in the 
+                <filename class='directory'>meta-&lt;bsp_name&gt;/recipes-kernel/linux</filename> 
                 directory.
             </para>
             <para>
-                Consider a BSP that uses the <filename>linux-yocto-stable_git.bb</filename> kernel.
-                You would use the <filename>linux-yocto-stable_git.bbappend</filename> file to add 
+                Consider a BSP that uses the <filename>linux-yocto-stable_git.bb</filename> kernel, 
+                which is the preferred kernel to use for developing a new BSP using the Yocto Project.
+                You would use the <filename>linux-yocto-stable_git.bbappend</filename> file to append 
                 specific BSP settings to the kernel, thus configuring the kernel for your particular BSP.
             </para>
             <para>
                 Consider an example for the existing "crownbay" BSP.
-                The <filename>.bbaappend</filename> file used for the "crownbay" BSP is:
+                The append file used for the "crownbay" BSP is:
                 <programlisting>
-meta-crownbay/recipes-kernel/linux/linux-wrs_git.bbappend
+meta-crownbay/recipes-kernel/linux/linux-yocto-stable_git.bbappend
                 </programlisting>
                 The file contains the following:
                 <programlisting>
@@ -346,31 +347,67 @@ FILESEXTRAPATHS := "${THISDIR}/${PN}"
 COMPATIBLE_MACHINE_crownbay = "cronwbay"
 KMACHINE_crownbay = "crownbay"
                 </programlisting>
-                This <filename>.bbappend</filename> file adds "crownbay" as a compatible machine,
+                This append file adds "crownbay" as a compatible machine,
                 and additionally sets a Yocto Kernel-specific variable that identifies the name of the 
                 BSP branch to use in the GIT repository to find configuration information.
             </para>
-            <note><para>
-                For an established BSP the configuration information is incorporated directly into the 
-                git tree.
-                For a new BSP, however, the <filename>.bbappend</filename> file needs to 
-                include its own set of configuration options in a file called 
-                <filename>defconfig</filename> located in a directory that matches the recipe name.
+            <para>
+                One thing missing in this particular BSP, which you will typically need when 
+                developing a BSP, is the kernel configuration (.config) for your BSP.
+                When developing a BSP, you probably have a kernel configuration file or a set of kernel
+                configuration files that, when taken together, define the kernel configuration for your BSP.
+                You can accomplish this definition by putting the configurations in a file or a set of files 
+                inside a directory located at the same level as your append file and having the same name 
+                as the kernel.
+                With all these conditions met simply reference those files in a SRC_URI statement in the append 
+                file.
+            </para>
+            <para>
+                For example, suppose you had a set of configuration options in a file called 
+                <filename>defonfig</filename>.  
+                If you put that file inside a directory named 
+                <filename class='directory'>/linux-yocto-stable_git</filename> and then added 
+                a SRC_URI statement such as the following to the append file, those configuration
+                options will be picked up and applied when the kernel is built.
                 <programlisting>
 SRC_URI += "file://defconfig"
                 </programlisting>
-                Once a BSP is committed, the Yocto kernel maintainer moves this configuration information
-                into the git tree so that the <filename>.bbappend</filename> file does not need to locate
-                its own configuration options.
-                Again, the initial configuration options using the SRC_URI are put into a 
-                directory named 
-                <filename class='directory'>meta-&lt;bsp_name&gt;/recipes/linux/linux-yocto-stable</filename>.
-            </para>
-            <para>
-                 You can find more information about creating a BSP that is based on an existing similar
-                 BSP by reading the "Creating a BSP Based on an Existing Similar BSP" section in the 
-                 "<ulink url="http://www.yoctoproject.org/community/documentation">Yocto Project
-                 Kernel Architecture and Use Manual</ulink>".
+            </para>
+            <para>
+                As mentioned earlier, you can group related configurations into multiple files and 
+                name them all in the SRC_URI statement as well.
+                For example, you could group separate configurations specifically for ethernet and graphics
+                into their own files and add those by using a SRC_URI statement like the 
+                following in your append file:
+                <programlisting>
+SRC_URI += "file://defconfig \
+            file://eth.cfg \
+            file://gfx.cfg"
+                </programlisting>
+            </para>
+            <para>
+                The FILESEXTRAPATHS variable is boilerplated here in order to make it easy to do that.
+                It basically allows those configuration files to be found by the build process.
+            </para>
+            <note><para>
+                Other methods exist to accomplish grouping and defining configuration options.
+                For example, you could directly add configuration options to the Yocto kernel 
+                <filename class='directory'>wrs_meta</filename> branch for your BSP.
+                The configuration options will likely end up in that location anyway if the BSP gets 
+                added to the Yocto Project. 
+                For information on how to add these configurations directly, see the 
+                "Yocto Project Kernel Architecture and Use Manual" on the 
+                <ulink url="http://yoctoproject.org/community/documentation">Yocto Project website
+                Documentation Page</ulink> 
+            </para>
+            <para>
+                In general, however, the Yocto Project maintainers take care of moving the SRC_URI-specified 
+                configuration options to the <filename class='directory'>wrs_meta</filename> branch.
+                Not only is it easier for BSP developers to not have to worry about putting those 
+                configurations in the branch, but having the manintainers do it allows them to apply 
+                'global' knowledge about the kinds of common configuration options multiple BSPs in 
+                the tree are typically using.  
+                This allows for promotion of common configurations into common features.
             </para></note>
             </section>
 
Signature · 1 line
1.7.0.4
#27 lore raw

PATCH 27/29 documentation/bsp-guide/bsp.xml: replaced the append file line in the template

In reply to Scott Rifenbark

Section 1.1 has the example filesystem layout. The last line of the example filesystem layout had linux-wrs. It has been changed to linux-yocto-stable.

---
 documentation/bsp-guide/bsp.xml |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)
documentation/bsp-guide/bsp.xml +1 -1
index ff8a481..7909bb5 100644
@@ -83,7 +83,7 @@ meta-&lt;bsp_name&gt;/conf/layer.conf
 meta-&lt;bsp_name&gt;/conf/machine/*.conf
 meta-&lt;bsp_name&gt;/recipes-bsp/*
 meta-&lt;bsp_name&gt;/recipes-graphics/*            
-meta-&lt;bsp_name&gt;/recipes-kernel/linux/linux-wrs_git.bbappend
+meta-&lt;bsp_name&gt;/recipes-kernel/linux/linux-yocto-stable.bbappend
                 </programlisting>
             </para>
 
Signature · 1 line
1.7.0.4
#28 lore raw

PATCH 28/29 documentation/bsp-guide/bsp.xml: Updated Linux Kernel Configuration section.

In reply to Scott Rifenbark

Another round of feedback from Tom Z applied.

---
 documentation/bsp-guide/bsp.xml |   17 +++++++++++------
 1 files changed, 11 insertions(+), 6 deletions(-)
documentation/bsp-guide/bsp.xml +11 -6
index 7909bb5..e2c9487 100644
@@ -315,7 +315,7 @@ meta-crownbay/recipes-graphics/xorg-xserver/xserver-xf86-emgd_1.7.99.2.bb
             <section id='bsp-filelayout-kernel'>
             <title>Linux Kernel Configuration</title>
             <programlisting>
-meta-&lt;bsp_name&gt;/recipes-kernel/linux/linux-wrs_git.bbappend
+meta-&lt;bsp_name&gt;/recipes-kernel/linux/linux-yocto-stable.bbappend
             </programlisting>
 
             <para>
@@ -330,21 +330,26 @@ meta-&lt;bsp_name&gt;/recipes-kernel/linux/linux-wrs_git.bbappend
                 directory.
             </para>
             <para>
-                Consider a BSP that uses the <filename>linux-yocto-stable_git.bb</filename> kernel, 
+                Supppose you use a BSP that uses the <filename>linux-yocto-stable_git.bb</filename> kernel, 
                 which is the preferred kernel to use for developing a new BSP using the Yocto Project.
+                In other words, you have selected the kernel in your 
+                <filename>&lt;bsp_name&gt;.conf</filename> file by adding the following statement:
+                <programlisting>
+PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto-stable"
+                </programlisting>
                 You would use the <filename>linux-yocto-stable_git.bbappend</filename> file to append 
                 specific BSP settings to the kernel, thus configuring the kernel for your particular BSP.
             </para>
             <para>
-                Consider an example for the existing "crownbay" BSP.
-                The append file used for the "crownbay" BSP is:
+                Now take a look at the existing "crownbay" BSP.
+                The append file used is:
                 <programlisting>
 meta-crownbay/recipes-kernel/linux/linux-yocto-stable_git.bbappend
                 </programlisting>
                 The file contains the following:
                 <programlisting>
 FILESEXTRAPATHS := "${THISDIR}/${PN}"
-COMPATIBLE_MACHINE_crownbay = "cronwbay"
+COMPATIBLE_MACHINE_crownbay = "crownbay"
 KMACHINE_crownbay = "crownbay"
                 </programlisting>
                 This append file adds "crownbay" as a compatible machine,
@@ -366,7 +371,7 @@ KMACHINE_crownbay = "crownbay"
                 For example, suppose you had a set of configuration options in a file called 
                 <filename>defonfig</filename>.  
                 If you put that file inside a directory named 
-                <filename class='directory'>/linux-yocto-stable_git</filename> and then added 
+                <filename class='directory'>/linux-yocto-stable</filename> and then added 
                 a SRC_URI statement such as the following to the append file, those configuration
                 options will be picked up and applied when the kernel is built.
                 <programlisting>
Signature · 1 line
1.7.0.4
#29 lore raw

PATCH 29/29 documentation/bsp-guide/bsp.xml: Spell checked the file.

In reply to Scott Rifenbark
---
 documentation/bsp-guide/bsp.xml |   10 +++++-----
 1 files changed, 5 insertions(+), 5 deletions(-)
documentation/bsp-guide/bsp.xml +5 -5
index e2c9487..f5fd217 100644
@@ -260,7 +260,7 @@ TARGET_CC_ARCH = "-m32 -march=core2 -msse3 -mtune=generic -mfpmath=sse"
                 files included with Poky itself.
             </para>
             <para>
-                Both the base package architecuture file and the tune file are optional for a Poky BSP layer.
+                Both the base package architecture file and the tune file are optional for a Poky BSP layer.
             </para>
             </section>
 
@@ -330,7 +330,7 @@ meta-&lt;bsp_name&gt;/recipes-kernel/linux/linux-yocto-stable.bbappend
                 directory.
             </para>
             <para>
-                Supppose you use a BSP that uses the <filename>linux-yocto-stable_git.bb</filename> kernel, 
+                Suppose you use a BSP that uses the <filename>linux-yocto-stable_git.bb</filename> kernel, 
                 which is the preferred kernel to use for developing a new BSP using the Yocto Project.
                 In other words, you have selected the kernel in your 
                 <filename>&lt;bsp_name&gt;.conf</filename> file by adding the following statement:
@@ -369,7 +369,7 @@ KMACHINE_crownbay = "crownbay"
             </para>
             <para>
                 For example, suppose you had a set of configuration options in a file called 
-                <filename>defonfig</filename>.  
+                <filename>defconfig</filename>.  
                 If you put that file inside a directory named 
                 <filename class='directory'>/linux-yocto-stable</filename> and then added 
                 a SRC_URI statement such as the following to the append file, those configuration
@@ -381,7 +381,7 @@ SRC_URI += "file://defconfig"
             <para>
                 As mentioned earlier, you can group related configurations into multiple files and 
                 name them all in the SRC_URI statement as well.
-                For example, you could group separate configurations specifically for ethernet and graphics
+                For example, you could group separate configurations specifically for Ethernet and graphics
                 into their own files and add those by using a SRC_URI statement like the 
                 following in your append file:
                 <programlisting>
@@ -409,7 +409,7 @@ SRC_URI += "file://defconfig \
                 In general, however, the Yocto Project maintainers take care of moving the SRC_URI-specified 
                 configuration options to the <filename class='directory'>wrs_meta</filename> branch.
                 Not only is it easier for BSP developers to not have to worry about putting those 
-                configurations in the branch, but having the manintainers do it allows them to apply 
+                configurations in the branch, but having the maintainers do it allows them to apply 
                 'global' knowledge about the kinds of common configuration options multiple BSPs in 
                 the tree are typically using.  
                 This allows for promotion of common configurations into common features.
Signature · 1 line
1.7.0.4
#30 lore raw
In reply to Scott Rifenbark
Quoted 10 lines · Scott Rifenbark

This group of commits represents the work done to the BSP Guide with Tom Z. and Saul W. I have updated the template to match a more generic standard that is based on the crownbay BSP that Tom has created. The rest of the work reflects re-writing the individual sections to match changes in the template. There were several iterations to the work between Tom and I.

Pull URL: git://git.pokylinux.org/poky-contrib.git
Branch: srifenbark/bsp-work
Browse: http://git.pokylinux.org/cgit.cgi/poky-contrib/log/?h=srifenbark/bsp-work

Scott,

Did you push your changes? The bsp-work branch does not seem to exist.

Sau!

Quoted 65 lines

Thanks,
Scott Rifenbark<[email protected]>
---

Scott Rifenbark (29):
documentation/bsp-guide/bsp.xml: Changed meta naming convention documentation/bsp-guide/bsp.xml: Added note qualifying BSP file
structure.

   documentation/bsp-guide/bsp.xml:  Fixed typo
   documentation/bsp-guide/bsp.xml:  Added information about /binary
   documentation/bsp-guide/bsp.xml:  Created better BSP example base
     names
   documentation/bsp-guide/bsp.xml:  Inserted text before the file
     structure example
   documentation/bsp-guide/bsp.xml:  Updated common form for file
     structure.
   documentation/bsp-work/bsp.xml:  Added crownbay BSP example to
     section 1.1.
   documentation/bsp-guide/bsp.xml:  Updated the introductary paragraph
     to the sections.
   documentation/bsp-guide/bsp.xml:  Added new "License Files" section.
   documentation/bsp-guide/bsp.xml:  Added the README section.
   documentation/bsp-guide/bsp.xml:  Updated the Pre-built User Binaries

section.
documenation/bsp-guide/bsp.xml: Updated the Layer Configuration File
section.
documentation/bsp-guide/bsp.xml: Updated the Hardware Configuration
Options section
documentation/bsp-guide/bsp.xml: Added a Miscellaneous Recipe Files
section
documentation/bsp-guide/bsp.xml: Removed the recipes-bsp/formfactor
directory from the common structure.
documentation/bsp-guide/bsp.xml: Added a Display Support Files
section.
documentation/bsp-guide/bsp.xml: Updated Linux Kernel Configuration
section.
documentation/bsp-guide/bsp.xml: Commented out three sections. documentation/bsp-guide/bsp.xml: Changed numbering scheme. documentation/bsp-guide/bsp.xml: Updated Layer Configuration File
Section
documentation/bsp-guild/bsp.xml: Updated Miscellaneous Recipe Files
section
documentation/bsp-guide/bsp.xml: Updated Display Support Files
section.
documentation/bsp-guide/bsp.xml: Updated Linux Kernel Configuration
section.
documentation/bsp-guide/bsp.xml: Added reference to Kernel
documentation.
documentation/bsp-guide/bsp.xml: Updated the Linux Kernel
Configuration section
documentation/bsp-guide/bsp.xml: replaced the append file line in
the template
documentation/bsp-guide/bsp.xml: Updated Linux Kernel Configuration
section.
documentation/bsp-guide/bsp.xml: Spell checked the file.

  documentation/bsp-guide/bsp.xml |  324 ++++++++++++++++++++++++++++++---------
  1 files changed, 250 insertions(+), 74 deletions(-)

_______________________________________________
poky mailing list
[email protected]
https://lists.yoctoproject.org/listinfo/poky

#31 lore raw
In reply to Scott Rifenbark
Quoted 6 lines · Scott Rifenbark

This group of commits represents the work done to the BSP Guide with Tom Z. and Saul W. I have updated the template to match a more generic standard that is based on the crownbay BSP that Tom has created. The rest of the work reflects re-writing the individual sections to match changes in the template. There were several iterations to the work between Tom and I.

Quoted 6 lines

Pull URL: git://git.pokylinux.org/poky-contrib.git
Branch: srifenbark/bsp-work
Browse: http://git.pokylinux.org/cgit.cgi/poky-contrib/log/?h=srifenbark/bsp-work

Thanks,
Scott Rifenbark <[email protected]>

Merged into master, thanks.

Richard