xref: /OK3568_Linux_fs/yocto/poky/meta/classes/uboot-config.bbclass (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1# Handle U-Boot config for a machine
2#
3# The format to specify it, in the machine, is:
4#
5# UBOOT_CONFIG ??= <default>
6# UBOOT_CONFIG[foo] = "config,images,binary"
7#
8# or
9#
10# UBOOT_MACHINE = "config"
11#
12# Copyright 2013, 2014 (C) O.S. Systems Software LTDA.
13
14def removesuffix(s, suffix):
15    if suffix and s.endswith(suffix):
16        return s[:-len(suffix)]
17    return s
18
19# Some versions of u-boot use .bin and others use .img.  By default use .bin
20# but enable individual recipes to change this value.
21UBOOT_SUFFIX ??= "bin"
22UBOOT_BINARY ?= "u-boot.${UBOOT_SUFFIX}"
23UBOOT_BINARYNAME ?= "${@os.path.splitext(d.getVar("UBOOT_BINARY"))[0]}"
24UBOOT_IMAGE ?= "${UBOOT_BINARYNAME}-${MACHINE}-${PV}-${PR}.${UBOOT_SUFFIX}"
25UBOOT_SYMLINK ?= "${UBOOT_BINARYNAME}-${MACHINE}.${UBOOT_SUFFIX}"
26UBOOT_MAKE_TARGET ?= "all"
27
28# Output the ELF generated. Some platforms can use the ELF file and directly
29# load it (JTAG booting, QEMU) additionally the ELF can be used for debugging
30# purposes.
31UBOOT_ELF ?= ""
32UBOOT_ELF_SUFFIX ?= "elf"
33UBOOT_ELF_IMAGE ?= "u-boot-${MACHINE}-${PV}-${PR}.${UBOOT_ELF_SUFFIX}"
34UBOOT_ELF_BINARY ?= "u-boot.${UBOOT_ELF_SUFFIX}"
35UBOOT_ELF_SYMLINK ?= "u-boot-${MACHINE}.${UBOOT_ELF_SUFFIX}"
36
37# Some versions of u-boot build an SPL (Second Program Loader) image that
38# should be packaged along with the u-boot binary as well as placed in the
39# deploy directory.  For those versions they can set the following variables
40# to allow packaging the SPL.
41SPL_SUFFIX ?= ""
42SPL_BINARY ?= ""
43SPL_DELIMITER  ?= "${@'.' if d.getVar("SPL_SUFFIX") else ''}"
44SPL_BINARYFILE ?= "${@os.path.basename(d.getVar("SPL_BINARY"))}"
45SPL_BINARYNAME ?= "${@removesuffix(d.getVar("SPL_BINARYFILE"), "." + d.getVar("SPL_SUFFIX"))}"
46SPL_IMAGE ?= "${SPL_BINARYNAME}-${MACHINE}-${PV}-${PR}${SPL_DELIMITER}${SPL_SUFFIX}"
47SPL_SYMLINK ?= "${SPL_BINARYNAME}-${MACHINE}${SPL_DELIMITER}${SPL_SUFFIX}"
48
49# Additional environment variables or a script can be installed alongside
50# u-boot to be used automatically on boot.  This file, typically 'uEnv.txt'
51# or 'boot.scr', should be packaged along with u-boot as well as placed in the
52# deploy directory.  Machine configurations needing one of these files should
53# include it in the SRC_URI and set the UBOOT_ENV parameter.
54UBOOT_ENV_SUFFIX ?= "txt"
55UBOOT_ENV ?= ""
56UBOOT_ENV_SRC_SUFFIX ?= "cmd"
57UBOOT_ENV_SRC ?= "${UBOOT_ENV}.${UBOOT_ENV_SRC_SUFFIX}"
58UBOOT_ENV_BINARY ?= "${UBOOT_ENV}.${UBOOT_ENV_SUFFIX}"
59UBOOT_ENV_IMAGE ?= "${UBOOT_ENV}-${MACHINE}-${PV}-${PR}.${UBOOT_ENV_SUFFIX}"
60UBOOT_ENV_SYMLINK ?= "${UBOOT_ENV}-${MACHINE}.${UBOOT_ENV_SUFFIX}"
61
62# Default name of u-boot initial env, but enable individual recipes to change
63# this value.
64UBOOT_INITIAL_ENV ?= "${PN}-initial-env"
65
66# U-Boot EXTLINUX variables. U-Boot searches for /boot/extlinux/extlinux.conf
67# to find EXTLINUX conf file.
68UBOOT_EXTLINUX_INSTALL_DIR ?= "/boot/extlinux"
69UBOOT_EXTLINUX_CONF_NAME ?= "extlinux.conf"
70UBOOT_EXTLINUX_SYMLINK ?= "${UBOOT_EXTLINUX_CONF_NAME}-${MACHINE}-${PR}"
71
72# Options for the device tree compiler passed to mkimage '-D' feature:
73UBOOT_MKIMAGE_DTCOPTS ??= ""
74SPL_MKIMAGE_DTCOPTS ??= ""
75
76# mkimage command
77UBOOT_MKIMAGE ?= "uboot-mkimage"
78UBOOT_MKIMAGE_SIGN ?= "${UBOOT_MKIMAGE}"
79
80# Arguments passed to mkimage for signing
81UBOOT_MKIMAGE_SIGN_ARGS ?= ""
82SPL_MKIMAGE_SIGN_ARGS ?= ""
83
84# Options to deploy the u-boot device tree
85UBOOT_DTB ?= ""
86UBOOT_DTB_BINARY ??= ""
87
88python () {
89    ubootmachine = d.getVar("UBOOT_MACHINE")
90    ubootconfigflags = d.getVarFlags('UBOOT_CONFIG')
91    ubootbinary = d.getVar('UBOOT_BINARY')
92    ubootbinaries = d.getVar('UBOOT_BINARIES')
93    # The "doc" varflag is special, we don't want to see it here
94    ubootconfigflags.pop('doc', None)
95    ubootconfig = (d.getVar('UBOOT_CONFIG') or "").split()
96
97    if not ubootmachine and not ubootconfig:
98        PN = d.getVar("PN")
99        FILE = os.path.basename(d.getVar("FILE"))
100        bb.debug(1, "To build %s, see %s for instructions on \
101                 setting up your machine config" % (PN, FILE))
102        raise bb.parse.SkipRecipe("Either UBOOT_MACHINE or UBOOT_CONFIG must be set in the %s machine configuration." % d.getVar("MACHINE"))
103
104    if ubootmachine and ubootconfig:
105        raise bb.parse.SkipRecipe("You cannot use UBOOT_MACHINE and UBOOT_CONFIG at the same time.")
106
107    if ubootconfigflags and ubootbinaries:
108        raise bb.parse.SkipRecipe("You cannot use UBOOT_BINARIES as it is internal to uboot_config.bbclass.")
109
110    if len(ubootconfig) > 0:
111        for config in ubootconfig:
112            for f, v in ubootconfigflags.items():
113                if config == f:
114                    items = v.split(',')
115                    if items[0] and len(items) > 3:
116                        raise bb.parse.SkipRecipe('Only config,images,binary can be specified!')
117                    d.appendVar('UBOOT_MACHINE', ' ' + items[0])
118                    # IMAGE_FSTYPES appending
119                    if len(items) > 1 and items[1]:
120                        bb.debug(1, "Appending '%s' to IMAGE_FSTYPES." % items[1])
121                        d.appendVar('IMAGE_FSTYPES', ' ' + items[1])
122                    if len(items) > 2 and items[2]:
123                        bb.debug(1, "Appending '%s' to UBOOT_BINARIES." % items[2])
124                        d.appendVar('UBOOT_BINARIES', ' ' + items[2])
125                    else:
126                        bb.debug(1, "Appending '%s' to UBOOT_BINARIES." % ubootbinary)
127                        d.appendVar('UBOOT_BINARIES', ' ' + ubootbinary)
128                    break
129}
130