xref: /OK3568_Linux_fs/yocto/poky/meta/classes/baremetal-image.bbclass (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1# Baremetal image class
2#
3# This class is meant to be inherited by recipes for baremetal/RTOS applications
4# It contains code that would be used by all of them, every recipe just needs to
5# override certain variables.
6#
7# For scalability purposes, code within this class focuses on the "image" wiring
8# to satisfy the OpenEmbedded image creation and testing infrastructure.
9#
10# See meta-skeleton for a working example.
11
12
13# Toolchain should be baremetal or newlib based.
14# TCLIBC="baremetal" or TCLIBC="newlib"
15COMPATIBLE_HOST:libc-musl:class-target = "null"
16COMPATIBLE_HOST:libc-glibc:class-target = "null"
17
18
19inherit rootfs-postcommands
20
21# Set some defaults, but these should be overriden by each recipe if required
22IMGDEPLOYDIR ?= "${WORKDIR}/deploy-${PN}-image-complete"
23BAREMETAL_BINNAME ?= "hello_baremetal_${MACHINE}"
24IMAGE_LINK_NAME ?= "baremetal-helloworld-image-${MACHINE}"
25IMAGE_NAME_SUFFIX ?= ""
26
27do_rootfs[dirs] = "${IMGDEPLOYDIR} ${DEPLOY_DIR_IMAGE}"
28
29do_image(){
30    install ${D}/${base_libdir}/firmware/${BAREMETAL_BINNAME}.bin ${IMGDEPLOYDIR}/${IMAGE_LINK_NAME}.bin
31    install ${D}/${base_libdir}/firmware/${BAREMETAL_BINNAME}.elf ${IMGDEPLOYDIR}/${IMAGE_LINK_NAME}.elf
32}
33
34do_image_complete(){
35    :
36}
37
38python do_rootfs(){
39    from oe.utils import execute_pre_post_process
40    from pathlib import Path
41
42    # Write empty manifest file to satisfy test infrastructure
43    deploy_dir = d.getVar('IMGDEPLOYDIR')
44    link_name = d.getVar('IMAGE_LINK_NAME')
45    manifest_name = d.getVar('IMAGE_MANIFEST')
46
47    Path(manifest_name).touch()
48    if os.path.exists(manifest_name) and link_name:
49        manifest_link = deploy_dir + "/" + link_name + ".manifest"
50        if manifest_link != manifest_name:
51            if os.path.lexists(manifest_link):
52                os.remove(manifest_link)
53            os.symlink(os.path.basename(manifest_name), manifest_link)
54    # A lot of postprocess commands assume the existence of rootfs/etc
55    sysconfdir = d.getVar("IMAGE_ROOTFS") + d.getVar('sysconfdir')
56    bb.utils.mkdirhier(sysconfdir)
57
58    execute_pre_post_process(d, d.getVar('ROOTFS_POSTPROCESS_COMMAND'))
59}
60
61
62# Assure binaries, manifest and qemubootconf are populated on DEPLOY_DIR_IMAGE
63do_image_complete[dirs] = "${TOPDIR}"
64SSTATETASKS += "do_image_complete"
65SSTATE_SKIP_CREATION:task-image-complete = '1'
66do_image_complete[sstate-inputdirs] = "${IMGDEPLOYDIR}"
67do_image_complete[sstate-outputdirs] = "${DEPLOY_DIR_IMAGE}"
68do_image_complete[stamp-extra-info] = "${MACHINE_ARCH}"
69addtask do_image_complete after do_image before do_build
70
71python do_image_complete_setscene () {
72    sstate_setscene(d)
73}
74addtask do_image_complete_setscene
75
76# QEMU generic Baremetal/RTOS parameters
77QB_DEFAULT_KERNEL ?= "${IMAGE_LINK_NAME}.bin"
78QB_MEM ?= "-m 256"
79QB_DEFAULT_FSTYPE ?= "bin"
80QB_DTB ?= ""
81QB_OPT_APPEND:append = " -nographic"
82
83# RISC-V tunes set the BIOS, unset, and instruct QEMU to
84# ignore the BIOS and boot from -kernel
85QB_DEFAULT_BIOS:qemuriscv64 = ""
86QB_DEFAULT_BIOS:qemuriscv32 = ""
87QB_OPT_APPEND:append:qemuriscv64 = " -bios none"
88QB_OPT_APPEND:append:qemuriscv32 = " -bios none"
89
90
91# Use the medium-any code model for the RISC-V 64 bit implementation,
92# since medlow can only access addresses below 0x80000000 and RAM
93# starts at 0x80000000 on RISC-V 64
94# Keep RISC-V 32 using -mcmodel=medlow (symbols lie between -2GB:2GB)
95CFLAGS:append:qemuriscv64 = " -mcmodel=medany"
96
97
98## Emulate image.bbclass
99# Handle inherits of any of the image classes we need
100IMAGE_CLASSES ??= ""
101IMGCLASSES = " ${IMAGE_CLASSES}"
102inherit ${IMGCLASSES}
103# Set defaults to satisfy IMAGE_FEATURES check
104IMAGE_FEATURES ?= ""
105IMAGE_FEATURES[type] = "list"
106IMAGE_FEATURES[validitems] += ""
107
108
109# This next part is necessary to trick the build system into thinking
110# its building an image recipe so it generates the qemuboot.conf
111addtask do_rootfs before do_image after do_install
112addtask do_image after do_rootfs before do_image_complete
113addtask do_image_complete after do_image before do_build
114inherit qemuboot
115
116# Based on image.bbclass to make sure we build qemu
117python(){
118    # do_addto_recipe_sysroot doesnt exist for all recipes, but we need it to have
119    # /usr/bin on recipe-sysroot (qemu) populated
120    # The do_addto_recipe_sysroot dependency is coming from EXTRA_IMAGDEPENDS now,
121    # we just need to add the logic to add its dependency to do_image.
122    def extraimage_getdepends(task):
123        deps = ""
124        for dep in (d.getVar('EXTRA_IMAGEDEPENDS') or "").split():
125        # Make sure we only add it for qemu
126            if 'qemu' in dep:
127                if ":" in dep:
128                    deps += " %s " % (dep)
129                else:
130                    deps += " %s:%s" % (dep, task)
131        return deps
132    d.appendVarFlag('do_image', 'depends', extraimage_getdepends('do_populate_sysroot'))
133}
134