diff options
Diffstat (limited to 'documentation/ref-manual/ref-classes.xml')
-rw-r--r-- | documentation/ref-manual/ref-classes.xml | 83 |
1 files changed, 82 insertions, 1 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index f9bbddd724..1dcd5fdd03 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml | |||
@@ -1,6 +1,7 @@ | |||
1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | 1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" | 2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" |
3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > | 3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > |
4 | <!--SPDX-License-Identifier: CC-BY-2.0-UK--> | ||
4 | 5 | ||
5 | <chapter id='ref-classes'> | 6 | <chapter id='ref-classes'> |
6 | <title>Classes</title> | 7 | <title>Classes</title> |
@@ -1742,6 +1743,12 @@ This check was removed for YP 2.3 release | |||
1742 | </note> | 1743 | </note> |
1743 | </para></listitem> | 1744 | </para></listitem> |
1744 | --> | 1745 | --> |
1746 | <listitem><para><emphasis><filename>unlisted-pkg-lics:</filename></emphasis> | ||
1747 | Checks that all declared licenses applying for a package are also | ||
1748 | declared on the recipe level (i.e. any license in | ||
1749 | <filename>LICENSE_*</filename> should appear in | ||
1750 | <link linkend='var-LICENSE'><filename>LICENSE</filename></link>). | ||
1751 | </para></listitem> | ||
1745 | <listitem><para><emphasis><filename>useless-rpaths:</filename></emphasis> | 1752 | <listitem><para><emphasis><filename>useless-rpaths:</filename></emphasis> |
1746 | Checks for dynamic library load paths (rpaths) in the binaries that | 1753 | Checks for dynamic library load paths (rpaths) in the binaries that |
1747 | by default on a standard system are searched by the linker (e.g. | 1754 | by default on a standard system are searched by the linker (e.g. |
@@ -1873,8 +1880,82 @@ This check was removed for YP 2.3 release | |||
1873 | 1880 | ||
1874 | <para> | 1881 | <para> |
1875 | The <filename>kernel-fitimage</filename> class provides support to | 1882 | The <filename>kernel-fitimage</filename> class provides support to |
1876 | pack zImages. | 1883 | pack a kernel Image, device trees and a RAM disk into a single |
1884 | FIT image. In theory, a FIT image can support any number of kernels, | ||
1885 | RAM disks and device-trees. | ||
1886 | However, <filename>kernel-fitimage</filename> currently only supports | ||
1887 | limited usescases: just one kernel image, an optional RAM disk, and | ||
1888 | any number of device tree. | ||
1889 | </para> | ||
1890 | |||
1891 | <para> | ||
1892 | To create a FIT image, it is required that | ||
1893 | <filename><link linkend='var-KERNEL_CLASSES'>KERNEL_CLASSES</link></filename> | ||
1894 | is set to "kernel-fitimage" and | ||
1895 | <filename><link linkend='var-KERNEL_IMAGETYPE'>KERNEL_IMAGETYPE</link></filename> | ||
1896 | is set to "fitImage". | ||
1897 | </para> | ||
1898 | |||
1899 | <para> | ||
1900 | The options for the device tree compiler passed to mkimage -D feature | ||
1901 | when creating the FIT image are specified using the | ||
1902 | <filename><link linkend='var-UBOOT_MKIMAGE_DTCOPTS'>UBOOT_MKIMAGE_DTCOPTS</link></filename> | ||
1903 | variable. | ||
1904 | </para> | ||
1905 | |||
1906 | <para> | ||
1907 | Only a single kernel can be added to the FIT image created by | ||
1908 | <filename>kernel-fitimage</filename> and the kernel image in FIT is | ||
1909 | mandatory. | ||
1910 | The address where the kernel image is to be loaded by U-boot is | ||
1911 | specified by | ||
1912 | <filename><link linkend='var-UBOOT_LOADADDRESS'>UBOOT_LOADADDRESS</link></filename> | ||
1913 | and the entrypoint by | ||
1914 | <filename><link linkend='var-UBOOT_ENTRYPOINT'>UBOOT_ENTRYPOINT</link></filename>. | ||
1915 | </para> | ||
1916 | |||
1917 | <para> | ||
1918 | Multiple device trees can be added to the FIT image created by | ||
1919 | <filename>kernel-fitimage</filename> and the device tree is optional. | ||
1920 | The address where the device tree is to be loaded by U-boot is | ||
1921 | specified by | ||
1922 | <filename><link linkend='var-UBOOT_DTBO_LOADADDRESS'>UBOOT_DTBO_LOADADDRESS</link></filename> | ||
1923 | for device tree overlays and by | ||
1924 | <filename><link linkend='var-UBOOT_DTB_LOADADDRESS'>UBOOT_DTB_LOADADDRESS</link></filename> | ||
1925 | for device tree binaries. | ||
1926 | </para> | ||
1927 | |||
1928 | <para> | ||
1929 | Only a single RAM disk can be added to the FIT image created by | ||
1930 | <filename>kernel-fitimage</filename> and the RAM disk in FIT is | ||
1931 | optional. | ||
1932 | The address where the RAM disk image is to be loaded by U-boot | ||
1933 | is specified by | ||
1934 | <filename><link linkend='var-UBOOT_RD_LOADADDRESS'>UBOOT_RD_LOADADDRESS</link></filename> | ||
1935 | and the entrypoint by | ||
1936 | <filename><link linkend='var-UBOOT_RD_ENTRYPOINT'>UBOOT_RD_ENTRYPOINT</link></filename>. | ||
1937 | The ramdisk is added to FIT image when | ||
1938 | <filename><link linkend='var-INITRAMFS_IMAGE'>INITRAMFS_IMAGE</link></filename> | ||
1939 | is specified. | ||
1940 | </para> | ||
1941 | |||
1942 | <para> | ||
1943 | The FIT image generated by <filename>kernel-fitimage</filename> class | ||
1944 | is signed when the variables | ||
1945 | <filename><link linkend='var-UBOOT_SIGN_ENABLE'>UBOOT_SIGN_ENABLE</link></filename>, | ||
1946 | <filename><link linkend='var-UBOOT_MKIMAGE_DTCOPTS'>UBOOT_MKIMAGE_DTCOPTS</link></filename>, | ||
1947 | <filename><link linkend='var-UBOOT_SIGN_KEYDIR'>UBOOT_SIGN_KEYDIR</link></filename> | ||
1948 | and | ||
1949 | <filename><link linkend='var-UBOOT_SIGN_KEYNAME'>UBOOT_SIGN_KEYNAME</link></filename> | ||
1950 | are set appropriately. | ||
1951 | The default values used for | ||
1952 | <filename><link linkend='var-FIT_HASH_ALG'>FIT_HASH_ALG</link></filename> | ||
1953 | and | ||
1954 | <filename><link linkend='var-FIT_SIGN_ALG'>FIT_SIGN_ALG</link></filename> | ||
1955 | in <filename>kernel-fitimage</filename> are "sha256" and "rsa2048" | ||
1956 | respectively. | ||
1877 | </para> | 1957 | </para> |
1958 | |||
1878 | </section> | 1959 | </section> |
1879 | 1960 | ||
1880 | <section id='ref-classes-kernel-grub'> | 1961 | <section id='ref-classes-kernel-grub'> |