new configuration templates based on fragments

This is the application of the process proposed here:
https://lists.linuxfoundation.org/pipermail/automotive-discussions/2016-June/002232.html

Bug-AGL: SPEC-180

Change-Id: I5a7015fa810547a9ecf4fb096367323af3cdc670
Signed-off-by: Stephane Desneux <stephane.desneux@iot.bzh>

6 files changed, 418 insertions, 0 deletions

diff --git a/templates/base/00_local.conf.agl.inc b/templates/base/00_local.conf.agl.inc
new file mode 100644
index 000000000..b0ed06be4
--- /dev/null
+++ b/templates/base/00_local.conf.agl.inc
@@ -0,0 +1,18 @@
+# AGL global configuration options
+#---------------------------------
+
+# Set DISTRO for AGL
+DISTRO = "poky-agl"
+
+# AGL includes all kernel modules here for ease-of-use during development.
+# Comment this out to be able to select the kernel modules yourself.
+IMAGE_INSTALL_append = " kernel-modules"
+
+# Likewise as we included all kernel modules by default in the filesystem,
+# we do not need a separate tarball stored.
+# Comment this out to receive the separate modules tarball again.
+MODULE_TARBALL_DEPLOY ?= "0"
+
+# Comment out below if want to use QtWebkit
+PACKAGECONFIG_remove_pn-qtquick1 = "webkit"
+
diff --git a/templates/base/01_setup_EULAfunc.sh b/templates/base/01_setup_EULAfunc.sh
new file mode 100644
index 000000000..7b1ca870d
--- /dev/null
+++ b/templates/base/01_setup_EULAfunc.sh
@@ -0,0 +1,83 @@
+find_and_ack_eula() {
+    # Handle EULA , if needed. This is a generic method to handle BSPs
+    # that might (or not) come with a EULA. If a machine has a EULA, we
+    # assume that its corresponding layers has conf/EULA/$MACHINE file
+    # with the EULA text, which we will display to the user and request
+    # for acceptance. If accepted, the variable ACCEPT_EULA_$MACHINE is
+    # set to 1 in local.conf, which can later be used by the BSP.
+    # If the env variable EULA_$MACHINE is set it is used by default,
+    # without prompting the user.
+    # FIXME: there is a potential issue if the same $MACHINE is set in more than one layer.. but we should assert that earlier
+    EULA=$(find $1 -print | grep "conf/eula/$MACHINE" | grep -v scripts | grep -v openembedded-core || true)
+    if [ -n "$EULA" ]; then
+        # remove '-' since we are constructing a bash variable name here
+        EULA_MACHINE="EULA_$(echo $MACHINE | sed 's/-//g')"
+        # NOTE: indirect reference / dynamic variable
+        if [ -n "${!EULA_MACHINE}" ]; then
+            # the EULA_$MACHINE variable is set in the environment, so we just configure
+            # ACCEPT_EULA_$MACHINE in local.conf
+            EULA_ACCEPT=${!EULA_MACHINE}
+        else
+            # so we need to ask user if he/she accepts the EULA:
+            cat <<EOF
+The BSP for $MACHINE depends on packages and firmware which are covered by an 
+End User License Agreement (EULA). To have the right to use these binaries
+in your images, you need to read and accept the following...
+
+The firmware package can contains several types
+of firmware (depending on BSP):
+
+* bootloaders: the first stage bootloaders are proprietary for this
+  board, they are included in this firmware package.
+* firmware for the power management 'companion' core: on QCOM SoC some
+  power management features are implemented in a companion core , called
+  RPM, and not on the main CPU.
+* firmware for GPU, WLAN, DSP/GPS and video codecs. These firmware are
+  used by their respective linux drivers (DRM, wlan, v4l2, .. ) and are
+  loaded on-demand by the main CPU onto the various cores on the SoC.
+EOF
+
+            echo
+            REPLY=
+            while [ -z "$REPLY" ]; do
+                echo -n "Do you read the EULA ? (y/n) "
+                read REPLY
+                case "$REPLY" in
+                    y|Y)
+                        READ_EULA=1
+                        ;;
+                    n|N)
+                        READ_EULA=0
+                        ;;
+                    *)
+                        REPLY=
+                        ;;
+                esac
+            done
+
+            if [ "$READ_EULA" == 1 ]; then
+                more -d ${EULA}
+                echo
+                REPLY=
+                while [ -z "$REPLY" ]; do
+                    echo -n "Do you accept the EULA you just read? (y/n) "
+                    read REPLY
+                    case "$REPLY" in
+                        y|Y)
+                            echo "EULA has been accepted."
+                            EULA_ACCEPT=1
+                            ;;
+                        n|N)
+                            echo "EULA has not been accepted."
+                            ;;
+                        *)
+                            REPLY=
+                            ;;
+                    esac
+                done
+            fi
+        fi
+    fi
+}
+
+EULA_ACCEPT=0
diff --git a/templates/base/99_setup_EULAconf.sh b/templates/base/99_setup_EULAconf.sh
new file mode 100644
index 000000000..fe65f4ea6
--- /dev/null
+++ b/templates/base/99_setup_EULAconf.sh
@@ -0,0 +1,10 @@
+case "$EULA_ACCEPT" in
+	1)
+		echo "" >> $BUILDDIR/conf/local.conf
+		echo "# EULA" >> $BUILDDIR/conf/local.conf
+		echo "ACCEPT_EULA_$MACHINE = \"1\"" >> $BUILDDIR/conf/local.conf
+		;;
+	*)
+		;;
+esac
+
diff --git a/templates/base/bblayers.conf.sample b/templates/base/bblayers.conf.sample
new file mode 100644
index 000000000..313a58208
--- /dev/null
+++ b/templates/base/bblayers.conf.sample
@@ -0,0 +1,55 @@
+# LAYER_CONF_VERSION is increased each time build/conf/bblayers.conf
+# changes incompatibly
+LCONF_VERSION = "6"
+
+BBPATH = "${TOPDIR}"
+BBFILES ?= ""
+
+# Convenience variables usable in various configuration fragments
+#----------------------------------
+BCONFDIR := "${@os.path.abspath(os.path.dirname(d.getVar('FILE', True)))}"
+METADIR  := "${@os.path.abspath('##OEROOT##/..')}"
+
+# These are the core OE + YP Layers
+#----------------------------------
+YOCTO_LAYERS = " \
+  ${METADIR}/poky/meta \
+  ${METADIR}/poky/meta-yocto \
+  ${METADIR}/poky/meta-yocto-bsp \
+  "
+
+# These are the AGL CORE Layers that make up the basis
+# - they create a minimal bootable filesystem
+#   with some automotive tools/libraries
+#-----------------------------------------------------
+AGL_CORE_LAYERS = " \
+  ${METADIR}/meta-agl/meta-ivi-common \
+  ${METADIR}/meta-agl/meta-agl \
+  ${METADIR}/meta-agl/meta-agl-bsp \
+  "
+
+# These are the direct dependencies of the AGL CORE Layers
+#---------------------------------------------------------
+AGL_CORE_DEPENDENCY_LAYERS = " \
+  ${METADIR}/meta-openembedded/meta-oe \
+  ${METADIR}/meta-openembedded/meta-multimedia \
+  ${METADIR}/meta-openembedded/meta-efl \
+  ${METADIR}/meta-openembedded/meta-networking \
+  ${METADIR}/meta-openembedded/meta-python \
+  "
+
+####################
+# Combine the layers
+BBLAYERS ?= " \
+  ${AGL_CORE_DEPENDENCY_LAYERS} \
+  ${AGL_CORE_LAYERS} \
+  ${YOCTO_LAYERS} \
+  "
+
+BBLAYERS_NON_REMOVABLE ?= " \
+  ${METADIR}/poky/meta \
+  ${METADIR}/poky/meta-yocto \
+  ${METADIR}//meta-agl/meta-agl \
+  "
+
+
diff --git a/templates/base/conf-notes.txt b/templates/base/conf-notes.txt
new file mode 100644
index 000000000..d4ca1bce2
--- /dev/null
+++ b/templates/base/conf-notes.txt
@@ -0,0 +1,13 @@
+Common targets are:
+  - meta-agl:          (core system)
+    agl-image-ivi
+    agl-image-ivi-crosssdk
+    agl-image-ivi-qa
+    agl-image-minimal
+    agl-image-minimal-qa
+    agl-image-weston
+
+  - meta-agl-demo:     (demo with UI)
+    agl-demo-platform  (* default demo target)
+    agl-demo-platform-qa
+    agl-demo-platform-crosssdk
diff --git a/templates/base/local.conf.sample b/templates/base/local.conf.sample
new file mode 100644
index 000000000..72c16b25d
--- /dev/null
+++ b/templates/base/local.conf.sample
@@ -0,0 +1,239 @@
+#
+# This file is your local configuration file and is where all local user settings
+# are placed. The comments in this file give some guide to the options a new user
+# to the system might want to change but pretty much any configuration option can
+# be set in this file. More adventurous users can look at local.conf.extended 
+# which contains other examples of configuration which can be placed in this file
+# but new users likely won't need any of them initially.
+#
+# Lines starting with the '#' character are commented out and in some cases the 
+# default values are provided as comments to show people example syntax. Enabling
+# the option is a question of removing the # character and making any change to the
+# variable as required.
+
+#
+# Machine Selection
+#
+# You need to select a specific machine to target the build with. There are a selection
+# of emulated machines available which can boot and run in the QEMU emulator:
+#
+#MACHINE ?= "qemuarm"
+#MACHINE ?= "qemuarm64"
+#MACHINE ?= "qemumips"
+#MACHINE ?= "qemuppc"
+#MACHINE ?= "qemux86"
+#MACHINE ?= "qemux86-64"
+#
+# There are also the following hardware board target machines included for 
+# demonstration purposes:
+#
+#MACHINE ?= "beaglebone"
+#MACHINE ?= "genericx86"
+#MACHINE ?= "genericx86-64"
+#MACHINE ?= "mpc8315e-rdb"
+#MACHINE ?= "edgerouter"
+#
+# This sets the default machine to be qemux86 if no other machine is selected:
+MACHINE ??= "qemux86"
+
+#
+# Where to place downloads
+#
+# During a first build the system will download many different source code tarballs
+# from various upstream projects. This can take a while, particularly if your network
+# connection is slow. These are all stored in DL_DIR. When wiping and rebuilding you
+# can preserve this directory to speed up this part of subsequent builds. This directory
+# is safe to share between multiple builds on the same machine too.
+#
+# The default is a downloads directory under TOPDIR which is the build directory.
+#
+#DL_DIR ?= "${TOPDIR}/downloads"
+
+#
+# Where to place shared-state files
+#
+# BitBake has the capability to accelerate builds based on previously built output.
+# This is done using "shared state" files which can be thought of as cache objects
+# and this option determines where those files are placed.
+#
+# You can wipe out TMPDIR leaving this directory intact and the build would regenerate
+# from these files if no changes were made to the configuration. If changes were made
+# to the configuration, only shared state files where the state was still valid would
+# be used (done using checksums).
+#
+# The default is a sstate-cache directory under TOPDIR.
+#
+#SSTATE_DIR ?= "${TOPDIR}/sstate-cache"
+
+#
+# Where to place the build output
+#
+# This option specifies where the bulk of the building work should be done and
+# where BitBake should place its temporary files and output. Keep in mind that
+# this includes the extraction and compilation of many applications and the toolchain
+# which can use Gigabytes of hard disk space.
+#
+# The default is a tmp directory under TOPDIR.
+#
+#TMPDIR = "${TOPDIR}/tmp"
+
+#
+# Default policy config
+#
+# The distribution setting controls which policy settings are used as defaults.
+# The default value is fine for general Yocto project use, at least initially.
+# Ultimately when creating custom policy, people will likely end up subclassing 
+# these defaults.
+#
+DISTRO ?= "poky"
+# As an example of a subclass there is a "bleeding" edge policy configuration
+# where many versions are set to the absolute latest code from the upstream 
+# source control systems. This is just mentioned here as an example, its not
+# useful to most new users.
+# DISTRO ?= "poky-bleeding"
+
+#
+# Package Management configuration
+#
+# This variable lists which packaging formats to enable. Multiple package backends 
+# can be enabled at once and the first item listed in the variable will be used 
+# to generate the root filesystems.
+# Options are:
+#  - 'package_deb' for debian style deb files
+#  - 'package_ipk' for ipk files are used by opkg (a debian style embedded package manager)
+#  - 'package_rpm' for rpm style packages
+# E.g.: PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk"
+# We default to rpm:
+PACKAGE_CLASSES ?= "package_rpm"
+
+#
+# SDK/ADT target architecture
+#
+# This variable specifies the architecture to build SDK/ADT items for and means
+# you can build the SDK packages for architectures other than the machine you are 
+# running the build on (i.e. building i686 packages on an x86_64 host).
+# Supported values are i686 and x86_64
+#SDKMACHINE ?= "i686"
+
+#
+# Extra image configuration defaults
+#
+# The EXTRA_IMAGE_FEATURES variable allows extra packages to be added to the generated 
+# images. Some of these options are added to certain image types automatically. The
+# variable can contain the following options:
+#  "dbg-pkgs"       - add -dbg packages for all installed packages
+#                     (adds symbol information for debugging/profiling)
+#  "dev-pkgs"       - add -dev packages for all installed packages
+#                     (useful if you want to develop against libs in the image)
+#  "ptest-pkgs"     - add -ptest packages for all ptest-enabled packages
+#                     (useful if you want to run the package test suites)
+#  "tools-sdk"      - add development tools (gcc, make, pkgconfig etc.)
+#  "tools-debug"    - add debugging tools (gdb, strace)
+#  "eclipse-debug"  - add Eclipse remote debugging support
+#  "tools-profile"  - add profiling tools (oprofile, exmap, lttng, valgrind)
+#  "tools-testapps" - add useful testing tools (ts_print, aplay, arecord etc.)
+#  "debug-tweaks"   - make an image suitable for development
+#                     e.g. ssh root access has a blank password
+# There are other application targets that can be used here too, see
+# meta/classes/image.bbclass and meta/classes/core-image.bbclass for more details.
+# We default to enabling the debugging tweaks.
+EXTRA_IMAGE_FEATURES = "debug-tweaks"
+
+#
+# Additional image features
+#
+# The following is a list of additional classes to use when building images which
+# enable extra features. Some available options which can be included in this variable 
+# are:
+#   - 'buildstats' collect build statistics
+#   - 'image-mklibs' to reduce shared library files size for an image
+#   - 'image-prelink' in order to prelink the filesystem image
+#   - 'image-swab' to perform host system intrusion detection
+# NOTE: if listing mklibs & prelink both, then make sure mklibs is before prelink
+# NOTE: mklibs also needs to be explicitly enabled for a given image, see local.conf.extended
+# NOTE: image-prelink is currently broken due to problems with the prelinker.  It is advised
+# that you do NOT run the prelinker at this time. 
+USER_CLASSES ?= "buildstats image-mklibs"
+
+#
+# Runtime testing of images
+#
+# The build system can test booting virtual machine images under qemu (an emulator)
+# after any root filesystems are created and run tests against those images. To
+# enable this uncomment this line. See classes/testimage(-auto).bbclass for
+# further details.
+#TEST_IMAGE = "1"
+#
+# Interactive shell configuration
+#
+# Under certain circumstances the system may need input from you and to do this it 
+# can launch an interactive shell. It needs to do this since the build is 
+# multithreaded and needs to be able to handle the case where more than one parallel
+# process may require the user's attention. The default is iterate over the available
+# terminal types to find one that works.
+#
+# Examples of the occasions this may happen are when resolving patches which cannot
+# be applied, to use the devshell or the kernel menuconfig
+#
+# Supported values are auto, gnome, xfce, rxvt, screen, konsole (KDE 3.x only), none
+# Note: currently, Konsole support only works for KDE 3.x due to the way
+# newer Konsole versions behave
+#OE_TERMINAL = "auto"
+# By default disable interactive patch resolution (tasks will just fail instead):
+PATCHRESOLVE = "noop"
+
+#
+# Disk Space Monitoring during the build
+#
+# Monitor the disk space during the build. If there is less that 1GB of space or less
+# than 100K inodes in any key build location (TMPDIR, DL_DIR, SSTATE_DIR), gracefully
+# shutdown the build. If there is less that 100MB or 1K inodes, perform a hard abort
+# of the build. The reason for this is that running completely out of space can corrupt
+# files and damages the build in ways which may not be easily recoverable.
+# It's necesary to monitor /tmp, if there is no space left the build will fail
+# with very exotic errors.
+BB_DISKMON_DIRS = "\
+    STOPTASKS,${TMPDIR},1G,100K \
+    STOPTASKS,${DL_DIR},1G,100K \
+    STOPTASKS,${SSTATE_DIR},1G,100K \
+    STOPTASKS,/tmp,100M,100K \
+    ABORT,${TMPDIR},100M,1K \
+    ABORT,${DL_DIR},100M,1K \
+    ABORT,${SSTATE_DIR},100M,1K \
+    ABORT,/tmp,10M,1K"
+
+#
+# Shared-state files from other locations
+#
+# As mentioned above, shared state files are prebuilt cache data objects which can 
+# used to accelerate build time. This variable can be used to configure the system
+# to search other mirror locations for these objects before it builds the data itself.
+#
+# This can be a filesystem directory, or a remote url such as http or ftp. These
+# would contain the sstate-cache results from previous builds (possibly from other 
+# machines). This variable works like fetcher MIRRORS/PREMIRRORS and points to the 
+# cache locations to check for the shared objects.
+# NOTE: if the mirror uses the same structure as SSTATE_DIR, you need to add PATH
+# at the end as shown in the examples below. This will be substituted with the
+# correct path within the directory structure.
+#SSTATE_MIRRORS ?= "\
+#file://.* http://someserver.tld/share/sstate/PATH;downloadfilename=PATH \n \
+#file://.* file:///some/local/dir/sstate/PATH"
+
+
+#
+# Qemu configuration
+#
+# By default qemu will build with a builtin VNC server where graphical output can be
+# seen. The two lines below enable the SDL backend too. By default libsdl-native will
+# be built, if you want to use your host's libSDL instead of the minimal libsdl built
+# by libsdl-native then uncomment the ASSUME_PROVIDED line below.
+PACKAGECONFIG_append_pn-qemu-native = " sdl"
+PACKAGECONFIG_append_pn-nativesdk-qemu = " sdl"
+#ASSUME_PROVIDED += "libsdl-native"
+
+
+# CONF_VERSION is increased each time build/conf/ changes incompatibly and is used to
+# track the version of this file when it was generated. This can safely be ignored if
+# this doesn't mean anything to you.
+CONF_VERSION = "1"