summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKristi Rifenbark <kristi.rifenbark@gmail.com>2017-12-07 16:05:12 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-12-09 14:29:08 +0000
commitb2aeaa88d56c20d55f209162059fe02283f111de (patch)
tree520f9593d1d4517655b535064bc05990008b6b2e
parentd07585addc6761f37ed306a84261aa76ded1e421 (diff)
downloadpoky-b2aeaa88d56c20d55f209162059fe02283f111de.tar.gz
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 <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/bsp-guide/bsp.xml94
1 files changed, 65 insertions, 29 deletions
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 @@
151 to work with BSP layers. 151 to work with BSP layers.
152 Once you have the host set up, you can create the layer 152 Once you have the host set up, you can create the layer
153 as described in the 153 as described in the
154 "<link linkend='creating-a-new-bsp-layer-using-the-yocto-bsp-script'>Creating a new BSP Layer Using the yocto-bsp Script</link>" 154 "<link linkend='creating-a-new-bsp-layer-using-the-bitbake-layers-script'>Creating a new BSP Layer Using the yocto-bsp Script</link>"
155 section. 155 section.
156 <note> 156 <note>
157 For structural information on BSPs, see the 157 For structural information on BSPs, see the
@@ -866,7 +866,7 @@
866 <para> 866 <para>
867 For an example that shows how to create a new layer using 867 For an example that shows how to create a new layer using
868 the tools, see the 868 the tools, see the
869 "<link linkend='creating-a-new-bsp-layer-using-the-yocto-bsp-script'>Creating a New BSP Layer Using the yocto-bsp Script</link>" 869 "<link linkend='creating-a-new-bsp-layer-using-the-bitbake-layers-script'>Creating a New BSP Layer Using the yocto-bsp Script</link>"
870 section. 870 section.
871 </para> 871 </para>
872 872
@@ -901,7 +901,7 @@
901 </para></listitem> 901 </para></listitem>
902 <listitem><para> 902 <listitem><para>
903 <emphasis>Create Your Own BSP Layer Using the 903 <emphasis>Create Your Own BSP Layer Using the
904 <link linkend='creating-a-new-bsp-layer-using-the-yocto-bsp-script'><filename>yocto-bsp</filename></link> 904 <link linkend='creating-a-new-bsp-layer-using-the-bitbake-layers-script'><filename>yocto-bsp</filename></link>
905 script:</emphasis> 905 script:</emphasis>
906 Layers are ideal for isolating and storing work for a 906 Layers are ideal for isolating and storing work for a
907 given piece of hardware. 907 given piece of hardware.
@@ -912,7 +912,7 @@
912 compliant with the Yocto Project is to use the 912 compliant with the Yocto Project is to use the
913 <filename>yocto-bsp</filename> script. 913 <filename>yocto-bsp</filename> script.
914 For information about that script, see the 914 For information about that script, see the
915 "<link linkend='creating-a-new-bsp-layer-using-the-yocto-bsp-script'>Creating a New BSP Layer Using the yocto-bsp Script</link>" 915 "<link linkend='creating-a-new-bsp-layer-using-the-bitbake-layers-script'>Creating a New BSP Layer Using the yocto-bsp Script</link>"
916 section.</para> 916 section.</para>
917 917
918 <para>Another example that illustrates a layer 918 <para>Another example that illustrates a layer
@@ -1608,21 +1608,20 @@
1608 </section> 1608 </section>
1609 1609
1610 1610
1611 <section id='creating-a-new-bsp-layer-using-the-yocto-bsp-script'> 1611 <section id='creating-a-new-bsp-layer-using-the-bitbake-layers-script'>
1612 <title>Creating a new BSP Layer Using the yocto-bsp Script</title> 1612 <title>Creating a new BSP Layer Using the <filename>bitbake-layers</filename> Script</title>
1613 1613
1614 <para> 1614 <para role='writernotes'>
1615 [SOMETHING ABOUT CREATING A GENERAL LAYER USING bitbake-layers SCRIPT] 1615 I have put in information that will be the basis of this section,
1616 The [MODIFICATION NAME] sub-command creates a new 1616 but it is missing a lot at this point.
1617 <link linkend='bsp-layers'>BSP layer</link> for any architecture 1617 This whole section needs reviewed and filled in with proper
1618 supported by the Yocto Project, as well as QEMU versions of the same. 1618 information.
1619 The default mode of the script's operation is to prompt you for
1620 information needed to generate the BSP layer.
1621 </para> 1619 </para>
1622 1620
1623 <para> 1621 <para>
1624 For the current set of BSPs, the [SCRIPT] prompts you for various 1622 [INTRODUCE THE PROCEDURE AND LINK BACK TO <link linkend='bsp-layers'>BSP layer</link>.
1625 important parameters such as: 1623 IF THERE IS A LAUNDRY LIST OF ITEMS THAT NEED DEFINITION OR GET SET
1624 UP AS A RESULT OF THIS PROCEDURE, LIST THEM HERE.]
1626 <itemizedlist> 1625 <itemizedlist>
1627 <listitem><para>[PAREMETER 1]</para></listitem> 1626 <listitem><para>[PAREMETER 1]</para></listitem>
1628 <listitem><para>[PARAMETER 2]</para></listitem> 1627 <listitem><para>[PARAMETER 2]</para></listitem>
@@ -1635,11 +1634,49 @@
1635 </para> 1634 </para>
1636 1635
1637 <para> 1636 <para>
1638 [ASSUMING STEP ONE IS RUNNING bitbake-layers TO CREATE GENERIC LAYER - INTRO] 1637 The following procedure creates a BSP layer:
1639 For instructions on how to create a general layer using the 1638 <itemizedlist>
1640 <filename>bitbake-layers</filename> script see the 1639 <listitem><para>
1641 "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-general-layer-using-the-bitbake-layers-script'>Creating a General Layer Using the <filename>bitbake-layers</filename> Script</ulink>" 1640 <emphasis>Create General Layer:</emphasis>
1642 section. 1641 Use the <filename>bitbake-layers</filename> script with the
1642 <filename>create-layer</filename> subcommand to create a
1643 new general layer.
1644 For instructions on how to create a general layer using the
1645 <filename>bitbake-layers</filename> script, see the
1646 "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-general-layer-using-the-bitbake-layers-script'>Creating a General Layer Using the <filename>bitbake-layers</filename> Script</ulink>"
1647 section in the Yocto Project Development Tasks Manual.
1648 </para></listitem>
1649 <listitem><para>
1650 <emphasis>Create a Machine Configuration File:</emphasis>
1651 Create a <filename>conf/machine/&gt;machine&lt;.conf</filename>
1652 file.
1653 See <filename>meta-yocto-bsp/conf/machine</filename> for sample
1654 <filename>&gt;machine.conf&lt;</filename> files.
1655 Other samples exist from other vendors such as
1656 <filename>meta-intel</filename>, <filename>meta-ti</filename>,
1657 and <filename>meta-freescale</filename> that have more specific machine
1658 and tuning examples.
1659 </para></listitem>
1660 <listitem><para>
1661 <emphasis>Create a Kernel Recipe:</emphasis>
1662 Create a kernel recipe in <filename>recipes-kernel/linux</filename>
1663 either using a linux-yocto kernel with a <filename>.bbappend</filename>
1664 file or a new custom kernel recipe file (i.e. <filename>.bb</filename>
1665 file).
1666 The BSP layers mentioned in the previous step also contain different
1667 kernel examples.
1668 You can start with the linux-yocto or use a custom kernel.
1669 See the
1670 "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#modifying-an-existing-recipe'>Modifying an Existing Recipe</ulink>"
1671 section in the Yocto Project Linux Kernel Development Manual
1672 for information on how to create a custom kernel.
1673 </para></listitem>
1674 </itemizedlist>
1675 </para>
1676
1677 <para role='writernotes'>
1678 [THERE IS MORE INFORMATION THAT NEEDS TO BE FILLED IN HERE. THIS NEEDS TO
1679 BE PROVIDED BY ENGINEERS.]
1643 </para> 1680 </para>
1644 1681
1645 <para> 1682 <para>
@@ -1654,7 +1691,7 @@
1654 and can easily be followed without requiring actual hardware. 1691 and can easily be followed without requiring actual hardware.
1655 </para> 1692 </para>
1656 1693
1657 <para> 1694<!-- <para>
1658 [ASSUMING SIMLILAR ACTION OCCURS]As the [SUBCOMMAND] command runs, default values for 1695 [ASSUMING SIMLILAR ACTION OCCURS]As the [SUBCOMMAND] command runs, default values for
1659 the prompts appear in brackets. 1696 the prompts appear in brackets.
1660 Pressing enter without supplying anything on the command line or pressing enter 1697 Pressing enter without supplying anything on the command line or pressing enter
@@ -1665,14 +1702,14 @@
1665 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink> 1702 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>
1666 setup script. 1703 setup script.
1667 </para> 1704 </para>
1705-->
1668 1706
1669 <para> 1707 <para>
1670 Following is the complete example: 1708 Following is a complete example:
1671 <literallayout class='monospaced'> 1709 <literallayout class='monospaced'>
1672[INSERT EXAMPLE] 1710 [INSERT EXAMPLE - NEED EXAMPLE]
1673 </literallayout> 1711 </literallayout>
1674 Take a closer look at the example now: 1712<!--
1675 [UPDATE EXAMPLE STRUCTURE BASED ON NEW INSTRUCTIONS]
1676 <orderedlist> 1713 <orderedlist>
1677 <listitem><para>For the QEMU architecture, 1714 <listitem><para>For the QEMU architecture,
1678 the script first prompts you for which emulated architecture to use. 1715 the script first prompts you for which emulated architecture to use.
@@ -1710,6 +1747,7 @@
1710 (i.e. <filename>poky/build</filename>). 1747 (i.e. <filename>poky/build</filename>).
1711 </para></listitem> 1748 </para></listitem>
1712 </orderedlist> 1749 </orderedlist>
1750-->
1713 </para> 1751 </para>
1714 1752
1715 <para> 1753 <para>
@@ -1724,10 +1762,8 @@
1724 /usr/local/src/yocto/meta-myarm \ 1762 /usr/local/src/yocto/meta-myarm \
1725 " 1763 "
1726 </literallayout> 1764 </literallayout>
1727 [YOCTO-KERNEL WILL BE REMOVED - THIS NEEDS UPDATED WITH NEW INFO]
1728 Adding the layer to this file allows the build system to build the BSP and 1765 Adding the layer to this file allows the build system to build the BSP and
1729 the <filename>yocto-kernel</filename> tool to be able to find the layer and 1766 find the layer along with other Metadata it needs.
1730 other Metadata it needs on which to operate.
1731 </para> 1767 </para>
1732 </section> 1768 </section>
1733 1769
@@ -1736,7 +1772,7 @@
1736 1772
1737 <para> 1773 <para>
1738 Assuming you have created a <link linkend='bsp-layers'>BSP Layer</link> using 1774 Assuming you have created a <link linkend='bsp-layers'>BSP Layer</link> using
1739 <link linkend='creating-a-new-bsp-layer-using-the-yocto-bsp-script'> 1775 <link linkend='creating-a-new-bsp-layer-using-the-bitbake-layers-script'>
1740 <filename>yocto-bsp</filename></link> and you added it to your 1776 <filename>yocto-bsp</filename></link> and you added it to your
1741 <ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'><filename>BBLAYERS</filename></ulink> 1777 <ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'><filename>BBLAYERS</filename></ulink>
1742 variable in the <filename>bblayers.conf</filename> file, you can now use 1778 variable in the <filename>bblayers.conf</filename> file, you can now use