diff options
Diffstat (limited to 'distribution/yocto-basic')
| -rw-r--r-- | distribution/yocto-basic/pres_yocto-basic.tex | 356 |
1 files changed, 263 insertions, 93 deletions
diff --git a/distribution/yocto-basic/pres_yocto-basic.tex b/distribution/yocto-basic/pres_yocto-basic.tex index eddd940..715cd9c 100644 --- a/distribution/yocto-basic/pres_yocto-basic.tex +++ b/distribution/yocto-basic/pres_yocto-basic.tex @@ -4,23 +4,89 @@ \maketitle \begin{frame} -\frametitle{Bitbake Overview} +\frametitle{Agenda} \begin{itemize} -\item Classes +\item Workflow +\item Variable asssignments \item Recipes -\item Layers \item Append files +\item Classes \item Tasks \item Machines -\item Build configuration +\item Configuration +\item Commands and Debug methods \item Boundary Sabrelite Imagebuild \item TI Beaglebone Black Imagebuild -\item Commands and Debug methods \end{itemize} \end{frame} +\subsection{Workflow} +\begin{frame}[fragile] +\includegraphics[width=\textwidth]{images/yocto-workflow} +\end{frame} + \begin{frame} -\frametitle{Variable assignments} +\frametitle{classes} +\begin{itemize} +\item denoted by the .bbclass extension +\pause +\item base.bbclass is automatically included by all other classes and recipes. +\pause +\item common tasks and there execution order is defined in base.bbclass +\pause +\item tasks can be added, overridden, extended or used by other classes +\end{itemize} +\end{frame} + +\begin{frame} +\frametitle{recipes} +\begin{itemize} +\item a .bb file inherits classes and populates them with data +\pause +\item bitbake is used to schedule the tasks defined in a recipe +\end{itemize} +\end{frame} + +\begin{frame} +\frametitle{layers} +\begin{itemize} +\item a folder containing recipes, configs and classes +\pause +\item used to isolate different types of customizations from each other +\pause +\item e.g. own layer for machine specific stuff, one for own applications +\pause +\item extend, add, replace or modify recipes +\pause +\item add or replace class files +\pause +\item 'conf/layer.conf' is used to define the recipe location(s) +\pause +\item are added and ordered via BBLAYERS variable in build/conf/bblayers.conf +\end{itemize} +\end{frame} + +\begin{frame} +\frametitle{layers \#2} +layers should be grouped by functionality +\begin{itemize} +\item custom toolchains (compilers, debuggers, profiling tools) +\pause +\item distribution specifications (i.e. meta-yocto) +\pause +\item BSP/machine settings (i.e. meta-yocto-bsp) +\pause +\item functional areas (selinux, networking, etc) +\pause +\item project specific changes +\pause +\item a layer is typically organized as a git repository +\end{itemize} +\end{frame} + +\subsection{Variable assignments} +\begin{frame} +\frametitle{available operators} \begin{itemize} \item = \item ?= @@ -32,10 +98,11 @@ \end{frame} \begin{frame}[fragile] -\frametitle{Variable assignment with =} +\frametitle{variable assignment with =} \begin{verbatim} VAR = "value" \end{verbatim} +\pause \begin{itemize} \item normal assignment \item values need to be surrounded by double quotes @@ -48,6 +115,7 @@ VAR = "value" VAR ?= "1" VAR ?= "2" \end{verbatim} +\pause \begin{itemize} \item VAR is set to "1" in this example \item if there are multiple assignments using ?= the first one is used @@ -60,6 +128,7 @@ VAR ?= "2" VAR ??= "1" VAR ??= "2" \end{verbatim} +\pause \begin{itemize} \item VAR is set to "2" in this example \item if there are multiple assignments using ??= the last one is used @@ -75,6 +144,7 @@ VAR_A ?= "34" VAR_B ?= "12" VAR_B ??= "34" \end{verbatim} +\pause \begin{itemize} \item VAR\_A contains "34" \item VAR\_B contains "12" @@ -90,6 +160,7 @@ VAR = "56" VAR ?= "78" VAR ??= "78" \end{verbatim} +\pause \begin{itemize} \item VAR contains "56" \end{itemize} @@ -105,6 +176,7 @@ VAR_C := "C:${VAR_A}" VAR_A = "33" echo ${VAR_A} ${VAR_B} ${VAR_C} \end{verbatim} +\pause \begin{itemize} \item 33 B:33 C:22 \item the content of VAR\_C is expanded immediately on assignment @@ -120,6 +192,7 @@ VAR_A += "34" VAR_B = "56" VAR_B =+ "78" \end{verbatim} +\pause \begin{itemize} \item VAR\_A contains "12 34" \item VAR\_B contains "78 56" @@ -135,6 +208,7 @@ VAR_A .= "34" VAR_B = "56" VAR_B =. "78" \end{verbatim} +\pause \begin{itemize} \item VAR\_A contains "1234" \item VAR\_B contains "7856" @@ -154,73 +228,26 @@ FOO="456" \end{verbatim} \end{frame} +\subsection{Recipes} \begin{frame} -\frametitle{Classes} -\begin{itemize} -\item denoted by the .bbclass extension -\item base.bbclass is automatically included by all other classes and recipes. -\item common tasks and there execution order is defined in base.bbclass -\item tasks can be added, overridden, extended or used by other classes -\end{itemize} -\end{frame} - -\begin{frame} -\frametitle{Recipes} -\begin{itemize} -\item a .bb file inherits classes and populates them with data -\item bitbake is used to schedule the tasks defined in a recipe -\end{itemize} -\end{frame} - -\begin{frame} -\frametitle{Layers} -\begin{itemize} -\item used to isolate different types of customizations from each other -\item e.g. own layer for machine specific stuff, one for own applications -\item .bbappend files are used to modify recipes from another layer -\item 'conf/layer.conf' is used to define the recipe location(s) -\end{itemize} -\end{frame} - -\begin{frame} -\frametitle{Layers} -Layers are a way to manage extensions, and customizations to the system. - -Layers -\begin{itemize} -\item extend, add, replace or modify recipes -\item add or replace bbclass files -\item add or modify configuration settings -\item are added and ordered via BBLAYERS variable in build/conf/bblayers.conf -\end{itemize} -\end{frame} - -\begin{frame} -\frametitle{Layers} -Best Practice: Layers should be grouped by functionality -\begin{itemize} -\item Custom Toolchains (compilers, debuggers, profiling tools) -\item Distribution specifications (i.e. meta-yocto) -\item BSP/Machine settings (i.e. meta-yocto-bsp) -\item Functional areas (selinux, networking, etc) -\item Project specific changes -\end{itemize} -\end{frame} - -\begin{frame} -\frametitle{typical recipe progressing} +\frametitle{typical progressing} \begin{enumerate} \item fetch source files +\pause \item extract sources +\pause \item patch sources +\pause \item configure sources +\pause \item compilation +\pause \item packaging \end{enumerate} \end{frame} \begin{frame}[fragile] -\frametitle{recipe skeleton} +\frametitle{skeleton} \begin{verbatim} SUMMARY = "short description of the package (1 line)" DESCRIPTION = "a long version of the description of the package" @@ -242,16 +269,23 @@ inherit autotools \end{frame} \begin{frame} -\frametitle{recipe syntax} +\frametitle{syntax} a recipe normaly consists of a human readable description of the project and references to the open-source project and: +\pause \begin{description} \item[LIC*] reference to the used licenses +\pause \item[SRC\_URI] list of source files (local or remote) +\pause \item[PV] package-version (retrived from filename name\_version.bb) +\pause \item[PN] package-name (retrived from filename name\_version.bb) +\pause \item[P] ${PN}-${PV} +\pause \item[S] The location in the Build Directory where unpacked recipe source code resides. +\pause \item[inherit] use a class (or multiple classes) \end{description} \end{frame} @@ -261,17 +295,22 @@ references to the open-source project and: list of source licenses for the recipe: \begin{itemize} \item do not use spaces within individual license names +\pause \item use spaces between license names +\pause \item separate license names using | (pipe) when there is a choice between licenses +\pause \item separate license names using \& (AND) if parts of the code are licensed with different licenses +\pause \item for standard licenses, use the names of the files in meta/files/common-licenses/ or the SPDXLICENSEMAP \footnote{aps commonly used license names to their SPDX counterparts found in meta/files/common-licenses/. For the default SPDXLICENSEMAP mappings, see the meta/conf/licenses.conf file} flag names defined in meta/conf/licenses.conf +\pause \item use "CLOSED" for closed source software (LIC\_FILES\_CHKSUM is not needed to be defined then) \end{itemize} @@ -280,6 +319,8 @@ list of source licenses for the recipe: \begin{frame} \frametitle{LIC\_FILE\_CHKSUM variable} Checksums of the license text in the recipe source code. +\pause +\vspace{2em} This variable tracks changes in license text of the source code files. @@ -292,10 +333,12 @@ which gives the developer an opportunity to review any license change. \begin{verbatim} SRC_URI = "<protocol>://<host>/<path>;<OptionA=xxx>;<OptionB=xxx>" \end{verbatim} +\pause multiple urls can be set in a SRC\_URI variable: \begin{verbatim} SRC_URI = "<url1>;name=url1 <url2>;name=url2" \end{verbatim} +\pause for each url a md5 and sha256 checksum needs to be added: \begin{verbatim} SRC_URI[url1.md5sum] = xxx @@ -303,6 +346,7 @@ SRC_URI[url1.sha256sum] = yyy SRC_URI[url2.md5sum] = zzz SRC_URI[url2.sha256sum] = xyz \end{verbatim} +\pause To get these checksums don't specify them and run a build and copy them from the error message. (Don't use md5sum or sha256sum on the commandline; they produce a different checksum.) @@ -312,12 +356,17 @@ produce a different checksum.) \frametitle{local SRC\_URI (file://)} The path is relative to the FILESPATH variable. To modify the FILESPATH use FILESEXTRAPATH. +\pause +\vspace{2em} + Additional files are searched in subdirectories of the directory in which the recipe file (.bb) or append file (.bbappend) resides: \begin{description} \item[\${BPN}] base recipe name without any special suffix or version numbers. +\pause \item[\${BP} - \${BPN}-\${PV}] base recipe name and version but without any special package name suffix. +\pause \item[files] files within a directory, which is named files and is also alongside the recipe or append file. \end{description} \end{frame} @@ -326,8 +375,10 @@ recipe file (.bb) or append file (.bbappend) resides: \frametitle{the BPN variable} \begin{itemize} \item bare name of the recipe +\pause \item version of PN but without suffixes specified in SPECIAL\_PKGSUFFIX (-common, -native, -cross) +\pause \item version of PN but without prefixes specified in MLPREFIX (lib64-, lib32-) \end{itemize} \end{frame} @@ -336,16 +387,27 @@ recipe file (.bb) or append file (.bbappend) resides: \frametitle{remote SRC\_URI} \begin{description} \item[bzr://]Bazaar revision control repository +\pause \item[git://]Git revision control repository +\pause \item[osc://]OSC (OpenSUSE Build service) revision control repository +\pause \item[ccrc://]ClearCase repository +\pause \item[http://]Internet using http +\pause \item[https://]Internet using https +\pause \item[ftp://]Internet using ftp +\pause \item[cvs://]CVS revision control repository +\pause \item[hg://]Mercurial (hg) revision control repository +\pause \item[p4://]Perforce (p4) revision control repository +\pause \item[ssh://]secure shell +\pause \item[svn://]Subversion (svn) revision control repository \end{description} \end{frame} @@ -355,10 +417,13 @@ recipe file (.bb) or append file (.bbappend) resides: standard options \begin{description} \item[apply=no] apply patch or not; default is yes +\pause \item[striplevel=0] striplevel to use when applying a patch; default is 1 +\pause \item[patchdir=\${S}/foo] directory in which the patch should be applied; default is \${S} \end{description} + \end{frame} \begin{frame} \frametitle{SRC\_URI patch options \#2} @@ -368,13 +433,17 @@ specific options \footnote{The date of the source code used to build the package. This variable applies only if the source was fetched from a Source Code Manager (SCM)} is equal to or greater than mindate +\pause \item[maxdate] apply patch only if SRCDATE is not later than maxdate +\pause \item[minrev] apply the patch only if SRCREV \footnote{The revision of the source code used to build the package. This variable applies to Subversion, Git, Mercurial and Bazaar only} is equal to or greater than minrev \item[maxrev] apply patch only if SRCREV is not later than maxrev +\pause \item[rev] apply patch only if SRCREV is equal to rev +\pause \item[notrev] apply patch only if SRCREV is not equal to rev \end{description} \end{frame} @@ -383,12 +452,14 @@ specific options \frametitle{SRC\_URI options} \begin{description} \item[unpack=no] controls if an archive is unpacked; default is yes +\pause \item[subdir=bla] places the file (or extracts its contents) into the specified subdirectory of WORKDIR \footnote{${TMPDIR}/work/${MULTIMACH\_TARGET\_SYS}/${PN}/${EXTENDPE}${PV}-${PR}; eg. poky/build/tmp/work/qemux86-poky-linux/foo/1.3.0-r0} \item[name=mydl] name to be used for association with SRC\_URI checksums when you have more than one file specified in SRC\_URI +\pause \item[downloadfilename=my.tar.gz] the filename used when storing the downloaded file \end{description} \end{frame} @@ -416,44 +487,78 @@ predefined classes are: \end{itemize} \end{frame} +\subsection{Append files} \begin{frame} -\frametitle{Append files} -a append file must be named after the base package: +\frametitle{basics} +\begin{itemize} + \item are typically used to modify or extend the functionality of the base + recipe +\pause + \item it's recommended by the Yocto project to use bbappend files instead + of copying and modyfiing a recipe in an own layer +\end{itemize} +\end{frame} +\begin{frame}[fragile] +\frametitle{naming} +an append file must be named after the base package: +\begin{verbatim} <base-pn>\_<base-pv>.bbappend - +\end{verbatim} +\pause <base-pv> can be replaced by \% to match all versions. +\end{frame} -They are typically used to modify or extend the functionality of the base -recipe. +\subsection{Classes} +\begin{frame} +\frametitle{basics} +\begin{itemize} + \item python can be used to write functions +\pause + \item there should be no need to write a own class +\end{itemize} +\end{frame} -It's recommended by the Yocto project to use bbappend files instead of copying -and modyfiing a recipe in an own layer. +\subsection{Tasks} +\begin{frame} +\frametitle{basics} +\begin{itemize} + \item are defined and ordered in classes + \item can be overriden by classes and recipes \end{frame} \begin{frame} - \frametitle{Tasks - download \& patch} + \frametitle{download \& patch} \begin{description} \item [do\_checkuri] validates the SRC\_URI value +\pause \item [do\_checkuriall] validates the SRC\_URI value for all recipes required to build a target" +\pause \item [do\_fetch] fetches the source code +\pause \item [do\_fetchall] fetches all remote sources required to build a target +\pause \item [do\_unpack] unpacks the source code into a working directory +\pause \item [do\_patch] locates patch files and applies them to the source code \end{description} \end{frame} \begin{frame} - \frametitle{Tasks - configue \& compile} + \frametitle{configue \& compile} \begin{description} \item [do\_configure] configures the source by enabling and disabling any build-time and configuration options for the software being built +\pause \item [do\_configure\_ptest\_base] configures the runtime test suite included in the software being built +\pause \item [do\_compile] compiles the source in the compilation directory +\pause \item [do\_install] copies files from the compilation directory to a holding area +\pause \item [do\_populate\_sysroot] copies a subset of files installed by do\_install into the sysroot in order to make them available to other recipes @@ -461,157 +566,212 @@ and modyfiing a recipe in an own layer. \end{frame} \begin{frame} -\frametitle{Tasks - packaging} +\frametitle{packaging} \begin{description} \item [do\_packagedata] creates package metadata used by the build system to generate the final packages +\pause \item [do\_package] analyzes the content of the holding area and splits it into subsets based on available packages and files +\pause \item [do\_package\_write] creates the actual packages and places them in the Package Feed area +\pause \item [do\_package\_write\_deb] creates the actual DEB packages and places them in the Package Feed area +\pause \item [do\_package\_write\_ipk] creates the actual IPK packages and places them in the Package Feed area +\pause \item [do\_package\_write\_rpm] creates the actual RPM packages and places them in the Package Feed area +\pause \item [do\_package\_write\_tar] creates tar archives for packages and places them in the Package Feed area +\pause \item [do\_package\_index] creates or updates the index in the Package Feed area \end{description} \end{frame} \begin{frame} - \frametitle{Tasks - deploy} + \frametitle{deploy} \begin{description} \item [do\_rootfs] creates the root filesystem (file and directory structure) for an image +\pause \item [do\_vmdkimg] creates a .vmdk image for use with VMware and compatible virtual machine hosts" +\pause \item [do\_deploy] writes deployable output files to the deploy directory +\pause \item [do\_populate\_sdk] creates the file and directory structure for an installable SDK \end{description} \end{frame} \begin{frame} -\frametitle{Tasks - cleanup} +\frametitle{cleanup} \begin{description} \item [do\_clean] removes all output files for a target +\pause \item [do\_cleanall] removes all output files, shared state cache, and downloaded source files for a target +\pause \item [do\_cleanstate] removes all output files and shared state cache for a target +\pause \item [do\_rm\_work] removes work files after the build system has finished with them +\pause \item [do\_rm\_work\_all] top-level task for removing work files after the build system has finished with them \end{description} \end{frame} \begin{frame} -\frametitle{Tasks - kernel} +\frametitle{kernel} \begin{description} \item [do\_kernel\_checkout] checks out source/meta branches for a linux-yocto style kernel +\pause \item [do\_validate\_branches] ensures that the source/meta branches are on the locations specified by their SRCREV values for a linux-yocto style kernel" +\pause \item [do\_kernel\_configme] assembles the kernel configuration for a linux-yocto style kernel +\pause \item [do\_menuconfig] runs 'make menuconfig' for the kernel +\pause \item [do\_diffconfig] compares the old and new config files after running do\_menuconfig for the kernel +\pause \item [do\_savedefconfig] creates a minimal Linux kernel configuration file +\pause \item [do\_kernel\_configcheck] validates the kernel configuration for a linux-yocto style kernel +\pause \item [do\_sizecheck] checks the size of the kernel image against KERNEL\_IMAGE\_MAXSIZE (if set) +\end{description} +\end{frame} + +\begin{frame} +\frametitle{kernel} +\begin{description} \item [do\_compile\_kernelmodules] compiles loadable modules for the Linux kernel +\pause \item [do\_strip] strips unneeded sections out of the Linux kernel image +\pause \item [do\_kernel\_link\_vmlinux] creates a symbolic link in arch/\$arch/boot for vmlinux kernel images +\pause \item [do\_bundle\_initramfs] combines an initial ramdisk image and kernel together to form a single image \end{description} \end{frame} \begin{frame} -\frametitle{Tasks - tests} +\frametitle{tests} \begin{description} \item [do\_compile\_ptest\_base] compiles the runtime test suite included in the software being built +\pause \item [do\_install\_ptest\_base] copies the runtime test suite files from the compilation directory to a holding area +\pause \item [do\_testimage] boots an image and performs runtime tests within the image +\pause \item [do\_testimage\_auto] boots an image and performs runtime tests within the image immediately after it has been built \end{description} \end{frame} \begin{frame} -\frametitle{Tasks - licenses} +\frametitle{licenses} \begin{description} \item [do\_populate\_lic] writes license information for the recipe that is collected later when the image is constructed +\pause \item [do\_spdx] a build stage that takes the source code and scans it on a remote FOSSOLOGY server in order to produce an SPDX document \end{description} \end{frame} \begin{frame} -\frametitle{Tasks - special stuff} +\frametitle{special stuff} \begin{description} \item [do\_uboot\_mkimage] creates a uImage file from the kernel for the U-Boot bootloader +\pause \item [do\_generate\_qt\_config\_file] writes a qt.conf file for building a Qt-based application +\pause \item [do\_devshell] starts a shell with the environment set up for development/debugging +\pause \item [do\_listtasks] lists all defined tasks for a target \end{description} \end{frame} - +\subsection{Machines} \begin{frame} -\frametitle{Machines} -machine configs are stored in the layers: conf/machine/* - -Settings can be splitted in different include *.inc files. E.g. one include for -CPU that is used by the SoC inc file, that is used by the Board .conf file. +\frametitle{basics} +a machine config is used to describe a board +\begin{itemize} + \item machine configs are stored in the layers: conf/machine/* +\pause + \item settings can be splitted in different include *.inc files +\pause + \item e.g. one include for CPU that is used by the SoC inc file, +that is used by the Board .conf file +\pause + \item the include files can be stored in different layers +\end{itemize} \end{frame} \begin{frame} - \frametitle{machine.conf - u-boot \& kernel} + \frametitle{u-boot \& kernel} \begin{description} \item [UBOOT\_MACHINE] value passed on the make command line when building a U-Boot image +\pause \item [UBOOT\_MAKE\_TARGET] target called in the Makefile +\pause \item [UBOOT\_ENTRYPOINT] entry point for the U-Boot image +\pause \item [PREFERRED\_PROVIDER\_virtual/kernel] default kernel +\pause \item [KERNEL\_DEVICETREE] default devicetree +\pause \item [KERNEL\_IMAGETYPE] type of kernel to build for a device, defaults to 'zImage' \end{description} \end{frame} \begin{frame} - \frametitle{machine.conf - hardware} + \frametitle{hardware} \begin{description} \item[SOC\_FAMILY] groups together machines based upon the same family of SOC (System On Chip) +\pause \item [MACHINEOVERRIDES] lists overrides specific to the current machine. By default, this list includes the value of MACHINE. This can be used in recipes; e.g. MACHINEOVERRIDES =. "mymachine" and in the recipe SRC\_URI\_append\_mymachine = "file://mymachine-quirk.patch" +\pause \item [MACHINE\_FEATURES] list of hardware features the MACHINE supports + \footnote{acpi, alsa, apm, bluetooth, ext2, irda, keyboard, pci, pcmcia, + screen, serial, touchscreen, usbgadget, usbhost, wifi} +\pause \item [MACHINE\_EXTRA\_RRECOMMENDS] list of machine-specific packages to install as part of the image being built that are not essential for booting the machine. The image being built has no build dependencies on the packages in this list. +\pause \item [SERIAL\_CONSOLE] speed and device for the serial port used to attach the serial console. This variable is given to the kernel as the 'console' parameter. After booting occurs, getty is started on that port so remote @@ -620,43 +780,53 @@ CPU that is used by the SoC inc file, that is used by the Board .conf file. \end{frame} \begin{frame} -\frametitle{machine.conf - compiler settings} +\frametitle{compiler settings} \begin{description} \item [DEFAULTTUNE] e.g. armv6hf or cortexa8hf-neon, x86-64, \dots +\pause \item [TUNE\_FEATURES] e.g. "armv7a vfp neon" +\pause \item [TUNEVALID] Descriptions, stored as flags, of valid tuning features +\pause \item [TUNECONFLICTS] list of conflicting features for a given feature \end{description} \end{frame} \begin{frame} -\frametitle{machine.conf - software} +\frametitle{software} \begin{description} \item [PREFERRED\_VERSION\_xserver-xorg] compatible xserver version +\pause \item [PREFERRED\_PROVIDER\_virtual/kernel] recommended kernel +\pause \item [IMAGE\_FSTYPES] formats for the rootfs, e.g. "ext3 tar.bz2" +\pause \item [IMAGE\_CLASSES] list of classes that all images should inherit, default is image\_types \end{description} \end{frame} +\subsection{Configuration} \begin{frame} -\frametitle{Configuration} +\frametitle{basics} bla \end{frame} +\subsection{Commands \& Debugging} \begin{frame} -\frametitle{using meta-fsl} +\frametitle{commands and debug methods} bla \end{frame} +\subsection{Freescale} \begin{frame} -\frametitle{using meta-ti} +\frametitle{using meta-fsl} bla \end{frame} +\subsection{TI} \begin{frame} -\frametitle{commands and debug methods} +\frametitle{using meta-ti} bla \end{frame} |