From b2aeaa88d56c20d55f209162059fe02283f111de Mon Sep 17 00:00:00 2001 From: Kristi Rifenbark Date: Thu, 7 Dec 2017 16:05:12 -0800 Subject: bsp-guide: Cleaned up Saul's notes This section needs input from engineering. It is incomplete, but as best as it can be for now. (From yocto-docs rev: 1212f1eeebd23cb11c63889f3ee602e761450967) Signed-off-by: Kristi Rifenbark Signed-off-by: Richard Purdie --- documentation/bsp-guide/bsp.xml | 94 ++++++++++++++++++++++++++++------------- 1 file changed, 65 insertions(+), 29 deletions(-) (limited to 'documentation/bsp-guide/bsp.xml') diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml index 21672b43ce..6f2aa384b2 100644 --- a/documentation/bsp-guide/bsp.xml +++ b/documentation/bsp-guide/bsp.xml @@ -151,7 +151,7 @@ to work with BSP layers. Once you have the host set up, you can create the layer as described in the - "Creating a new BSP Layer Using the yocto-bsp Script" + "Creating a new BSP Layer Using the yocto-bsp Script" section. For structural information on BSPs, see the @@ -866,7 +866,7 @@ For an example that shows how to create a new layer using the tools, see the - "Creating a New BSP Layer Using the yocto-bsp Script" + "Creating a New BSP Layer Using the yocto-bsp Script" section. @@ -901,7 +901,7 @@ Create Your Own BSP Layer Using the - yocto-bsp + yocto-bsp script: Layers are ideal for isolating and storing work for a given piece of hardware. @@ -912,7 +912,7 @@ compliant with the Yocto Project is to use the yocto-bsp script. For information about that script, see the - "Creating a New BSP Layer Using the yocto-bsp Script" + "Creating a New BSP Layer Using the yocto-bsp Script" section. Another example that illustrates a layer @@ -1608,21 +1608,20 @@ -
- Creating a new BSP Layer Using the yocto-bsp Script +
+ Creating a new BSP Layer Using the <filename>bitbake-layers</filename> Script - - [SOMETHING ABOUT CREATING A GENERAL LAYER USING bitbake-layers SCRIPT] - The [MODIFICATION NAME] sub-command creates a new - BSP layer for any architecture - supported by the Yocto Project, as well as QEMU versions of the same. - The default mode of the script's operation is to prompt you for - information needed to generate the BSP layer. + + I have put in information that will be the basis of this section, + but it is missing a lot at this point. + This whole section needs reviewed and filled in with proper + information. - For the current set of BSPs, the [SCRIPT] prompts you for various - important parameters such as: + [INTRODUCE THE PROCEDURE AND LINK BACK TO BSP layer. + IF THERE IS A LAUNDRY LIST OF ITEMS THAT NEED DEFINITION OR GET SET + UP AS A RESULT OF THIS PROCEDURE, LIST THEM HERE.] [PAREMETER 1] [PARAMETER 2] @@ -1635,11 +1634,49 @@ - [ASSUMING STEP ONE IS RUNNING bitbake-layers TO CREATE GENERIC LAYER - INTRO] - For instructions on how to create a general layer using the - bitbake-layers script see the - "Creating a General Layer Using the bitbake-layers Script" - section. + The following procedure creates a BSP layer: + + + Create General Layer: + Use the bitbake-layers script with the + create-layer subcommand to create a + new general layer. + For instructions on how to create a general layer using the + bitbake-layers script, see the + "Creating a General Layer Using the bitbake-layers Script" + section in the Yocto Project Development Tasks Manual. + + + Create a Machine Configuration File: + Create a conf/machine/>machine<.conf + file. + See meta-yocto-bsp/conf/machine for sample + >machine.conf< files. + Other samples exist from other vendors such as + meta-intel, meta-ti, + and meta-freescale that have more specific machine + and tuning examples. + + + Create a Kernel Recipe: + Create a kernel recipe in recipes-kernel/linux + either using a linux-yocto kernel with a .bbappend + file or a new custom kernel recipe file (i.e. .bb + file). + The BSP layers mentioned in the previous step also contain different + kernel examples. + You can start with the linux-yocto or use a custom kernel. + See the + "Modifying an Existing Recipe" + section in the Yocto Project Linux Kernel Development Manual + for information on how to create a custom kernel. + + + + + + [THERE IS MORE INFORMATION THAT NEEDS TO BE FILLED IN HERE. THIS NEEDS TO + BE PROVIDED BY ENGINEERS.] @@ -1654,7 +1691,7 @@ and can easily be followed without requiring actual hardware. - + - Following is the complete example: + Following is a complete example: -[INSERT EXAMPLE] + [INSERT EXAMPLE - NEED EXAMPLE] - Take a closer look at the example now: - [UPDATE EXAMPLE STRUCTURE BASED ON NEW INSTRUCTIONS] + @@ -1724,10 +1762,8 @@ /usr/local/src/yocto/meta-myarm \ " - [YOCTO-KERNEL WILL BE REMOVED - THIS NEEDS UPDATED WITH NEW INFO] Adding the layer to this file allows the build system to build the BSP and - the yocto-kernel tool to be able to find the layer and - other Metadata it needs on which to operate. + find the layer along with other Metadata it needs.
@@ -1736,7 +1772,7 @@ Assuming you have created a BSP Layer using - + yocto-bsp and you added it to your BBLAYERS variable in the bblayers.conf file, you can now use -- cgit v1.2.3-54-g00ecf