blob: e8da8c7452ac4b2644ad9e0354d9b652015bf234 [file] [log] [blame]
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001# Handle U-Boot config for a machine
2#
3# The format to specify it, in the machine, is:
4#
5# UBOOT_CONFIG ??= <default>
Patrick Williamsc0f7c042017-02-23 20:41:17 -06006# UBOOT_CONFIG[foo] = "config,images,binary"
Patrick Williamsc124f4f2015-09-15 14:41:29 -05007#
8# or
9#
10# UBOOT_MACHINE = "config"
11#
12# Copyright 2013, 2014 (C) O.S. Systems Software LTDA.
13
Andrew Geisslerd159c7f2021-09-02 21:05:58 -050014def removesuffix(s, suffix):
15 if suffix and s.endswith(suffix):
16 return s[:-len(suffix)]
17 return s
18
Andrew Geissler3b8a17c2021-04-15 15:55:55 -050019# 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"
Patrick Williamsc0f7c042017-02-23 20:41:17 -060022UBOOT_BINARY ?= "u-boot.${UBOOT_SUFFIX}"
Andrew Geissler3b8a17c2021-04-15 15:55:55 -050023UBOOT_BINARYNAME ?= "${@os.path.splitext(d.getVar("UBOOT_BINARY"))[0]}"
Andrew Geisslerd159c7f2021-09-02 21:05:58 -050024UBOOT_IMAGE ?= "${UBOOT_BINARYNAME}-${MACHINE}-${PV}-${PR}.${UBOOT_SUFFIX}"
25UBOOT_SYMLINK ?= "${UBOOT_BINARYNAME}-${MACHINE}.${UBOOT_SUFFIX}"
Andrew Geissler3b8a17c2021-04-15 15:55:55 -050026UBOOT_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.
Andrew Geisslerd159c7f2021-09-02 21:05:58 -050041SPL_SUFFIX ?= ""
Andrew Geissler3b8a17c2021-04-15 15:55:55 -050042SPL_BINARY ?= ""
Andrew Geisslerd159c7f2021-09-02 21:05:58 -050043SPL_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}"
Andrew Geissler3b8a17c2021-04-15 15:55:55 -050048
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 ?= ""
Andrew Geisslereff27472021-10-29 15:35:00 -050056UBOOT_ENV_SRC_SUFFIX ?= "cmd"
57UBOOT_ENV_SRC ?= "${UBOOT_ENV}.${UBOOT_ENV_SRC_SUFFIX}"
Andrew Geissler3b8a17c2021-04-15 15:55:55 -050058UBOOT_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 ?= ""
Patrick Williamsc0f7c042017-02-23 20:41:17 -060083
Andrew Geissler09036742021-06-25 14:25:14 -050084# Options to deploy the u-boot device tree
85UBOOT_DTB ?= ""
86UBOOT_DTB_BINARY ??= ""
87
Patrick Williamsc124f4f2015-09-15 14:41:29 -050088python () {
Brad Bishop6e60e8b2018-02-01 10:27:11 -050089 ubootmachine = d.getVar("UBOOT_MACHINE")
Patrick Williamsc124f4f2015-09-15 14:41:29 -050090 ubootconfigflags = d.getVarFlags('UBOOT_CONFIG')
Brad Bishop6e60e8b2018-02-01 10:27:11 -050091 ubootbinary = d.getVar('UBOOT_BINARY')
92 ubootbinaries = d.getVar('UBOOT_BINARIES')
Patrick Williamsc124f4f2015-09-15 14:41:29 -050093 # The "doc" varflag is special, we don't want to see it here
94 ubootconfigflags.pop('doc', None)
Brad Bishopd7bf8c12018-02-25 22:55:05 -050095 ubootconfig = (d.getVar('UBOOT_CONFIG') or "").split()
Patrick Williamsc124f4f2015-09-15 14:41:29 -050096
Brad Bishopd7bf8c12018-02-25 22:55:05 -050097 if not ubootmachine and not ubootconfig:
Brad Bishop6e60e8b2018-02-01 10:27:11 -050098 PN = d.getVar("PN")
99 FILE = os.path.basename(d.getVar("FILE"))
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500100 bb.debug(1, "To build %s, see %s for instructions on \
101 setting up your machine config" % (PN, FILE))
Brad Bishop316dfdd2018-06-25 12:45:53 -0400102 raise bb.parse.SkipRecipe("Either UBOOT_MACHINE or UBOOT_CONFIG must be set in the %s machine configuration." % d.getVar("MACHINE"))
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500103
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500104 if ubootmachine and ubootconfig:
Brad Bishop316dfdd2018-06-25 12:45:53 -0400105 raise bb.parse.SkipRecipe("You cannot use UBOOT_MACHINE and UBOOT_CONFIG at the same time.")
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500106
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600107 if ubootconfigflags and ubootbinaries:
Brad Bishop316dfdd2018-06-25 12:45:53 -0400108 raise bb.parse.SkipRecipe("You cannot use UBOOT_BINARIES as it is internal to uboot_config.bbclass.")
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600109
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500110 if len(ubootconfig) > 0:
111 for config in ubootconfig:
112 for f, v in ubootconfigflags.items():
113 if config == f:
114 items = v.split(',')
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600115 if items[0] and len(items) > 3:
Brad Bishop316dfdd2018-06-25 12:45:53 -0400116 raise bb.parse.SkipRecipe('Only config,images,binary can be specified!')
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500117 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])
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600122 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)
Patrick Williamsdb4c27e2022-08-05 08:10:29 -0500128 return
129 raise bb.parse.SkipRecipe("The selected UBOOT_CONFIG key %s has no match in %s." % (ubootconfig, ubootconfigflags.keys()))
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500130}