Personal tools

Yocto Customizing the Linux kernel

From Variscite Wiki

Jump to: navigation, search


DART-MX8M - Customizing the Linux kernel



After customizing the kernel by following the below instructions, you can either bitbake your complete image (e.g. fsl-image-gui) and the updated kernel will be used, or you can bitbake the kernel alone by running "bitbake virtual/kernel" (see the Build Yocto from source code page for the initial Yocto setup and for more info on using bitbake).

1 Configuring the kernel

The default kernel configuration file used by Yocto is part of the kernel source tree and is located at:

arch/arm64/configs/imx8_var_defconfig


To configure the kernel using Yocto:

  • Follow steps 1-3 of the Yocto Build Release page.
  • Follow the first part of step 4 of the same page, to source the setup-environment script (stop after that - don't build any image). E.g.:
$ cd ~/var-fsl-yocto
$ MACHINE=imx8m-var-dart DISTRO=fsl-imx-xwayland . var-setup-release.sh -b build_xwayland
  • Run menuconfig and configure the kernel:
$ bitbake -c menuconfig virtual/kernel

When finished, save and exit.

The .config file is saved to ~/var-fsl-yocto/build_xwayland/tmp/work/imx8m_var_dart-poky-linux/linux-variscite/4.14.78-r0/build/.config

  • At this point, you can continue following the rest of step 4 of the Yocto Build Release page to build your image with the newly configured kernel, or just build the kernel by running "bitbake virtual/kernel", or, you can follow the next steps to use this configuration permanently.


To save the configuration in a defconfig format:

$ bitbake -c savedefconfig virtual/kernel

The defconfig file is saved to ~/var-fsl-yocto/build_xwayland/tmp/work/imx8m_var_dart-poky-linux/linux-variscite/4.14.78-r0/build/defconfig

To make the kernel recipe use this configuration permanently, you can do either of the following:

  • Use any of the three methods described in the Making changes in the source code section below to overwrite the default configuration file in the source tree, arch/arm64/configs/imx8_var_defconfig, and replace it with the above defconfig.
  • Make the kernel recipe use the defconfig from outside of the source tree:

Copy your defconfig:

$ cd ~/var-fsl-yocto/sources/meta-variscite-imx/recipes-kernel/linux/
$ mkdir -p files
$ cp ~/var-fsl-yocto/build_xwayland/tmp/work/imx8m_var_dart-poky-linux/linux-variscite/4.14.78-r0/build/defconfig  files/my_defconfig

Create a linux-variscite_4.14.78.bbappend file:

$ gedit linux-variscite_4.14.78.bbappend

and append the following to it:

SRC_URI += "file://my_defconfig"
KERNEL_DEFCONFIG_imx8m-var-dart = "${WORKDIR}/my_defconfig"

2 Making changes in the source code

Choose one of the following three methods to customize the Linux kernel and build it using Yocto:

2.1 Add your own patches on top of our source code

Using this method Yocto will take the source code from our default remote repository, and apply your patches to it before building it:

Setup Yocto:

  • Follow steps 1-3 of the Yocto Build Release page.
  • Follow the first part of step 4 of the same page, to source the setup-environment script (stop after that - don't build any image). E.g.:
$ cd ~/var-fsl-yocto
$ MACHINE=imx8m-var-dart DISTRO=fsl-imx-xwayland . var-setup-release.sh -b build_xwayland


Get the source code:

$ bitbake -c unpack virtual/kernel
$ mkdir -p ../local_repos/linux-imx
$ cp -a tmp/work-shared/imx8m-var-dart/kernel-source/. ../local_repos/linux-imx
$ cd ../local_repos/linux-imx
$ git reset --hard
$ git clean -fdx


Make your changes in the source code and create a patch:
You can use either diff or patch file types.
For example:

$ cd ~/var-fsl-yocto/local_repos/linux-imx
$ gedit arch/arm64/boot/dts/freescale/fsl-imx8m-var-dart-common.dtsi
edit and save

$ git diff > my_device_tree_changes.diff


Update the recipes to use your patch:
Copy your patch:

$ cd ~/var-fsl-yocto/sources/meta-variscite-imx/recipes-kernel/linux/
$ mkdir -p files
$ cp ~/var-fsl-yocto/local_repos/linux-imx/my_device_tree_changes.diff  files/

Create a linux-variscite_4.14.78.bbappend file:

$ gedit linux-variscite_4.14.78.bbappend

and append the following line to it:

SRC_URI += "file://my_device_tree_changes.diff"

2.2 Use a local repository

Using this method Yocto will take the kernel source from a local repository instead of our remote ones on github:

Setup Yocto:

  • Follow steps 1-3 of the Yocto Build Release page.
  • Follow the first part of step 4 of the same page, to source the setup-environment script (stop after that - don't build any image). E.g.:
$ cd ~/var-fsl-yocto
$ MACHINE=imx8m-var-dart DISTRO=fsl-imx-xwayland . var-setup-release.sh -b build_xwayland


Get the source code:

$ bitbake -c unpack virtual/kernel
$ mkdir -p ../local_repos/linux-imx
$ cp -a tmp/work-shared/imx8m-var-dart/kernel-source/. ../local_repos/linux-imx
$ cd ../local_repos/linux-imx
$ git reset --hard
$ git clean -fdx


Make your changes in the source code and commit them:
After making changes in the source code you need to commit them.
For example:

$ cd ~/var-fsl-yocto/local_repos/linux-imx
$ gedit arch/arm64/boot/dts/freescale/fsl-imx8m-var-dart-common.dtsi
edit and save

$ git commit -a -m "my device tree changes"
To list all of the commits:
$ git log
Get the latest commit id:
$ git rev-parse HEAD


Update the recipes to use the local repository instead of the default one:

$ cd ~/var-fsl-yocto/sources/meta-variscite-imx/recipes-kernel/linux/

Create a linux-variscite_4.14.78.bbappend file:

$ gedit linux-variscite_4.14.78.bbappend

and append the following lines to it (see the previous section for listing the commits or getting the latest commit id):

KERNEL_SRC = "git://${BSPDIR}/local_repos/linux-imx;protocol=file"
SRCBRANCH = "imx_4.14.78_1.0.0_ga_var01" (or your own created branch)
SRCREV = "The commit id you'd like to use"


For the SRCREV value you can also use "${AUTOREV}" during development to get the latest commit of the branch
(If you do so, make sure to run "bitbake -c cleansstate virtual/kernel" before rebuilding the kernel)

2.3 Use your own remote repository on github

Using this method Yocto will take the source code from your own remote repository on github:

Create your own github account and upload your proprietary kernel to a new repository:
For example, you can fork our repository to your own account by visiting the following link and clicking on "Fork" at the top right of the screen.
Alternatively, you can clone our repository to your local machine, and push it later to your own account.

https://github.com/varigit/linux-imx/tree/imx_4.14.78_1.0.0_ga_var01


Update the recipes to use your remote repository instead of the default one:

$ cd ~/var-fsl-yocto/sources/meta-variscite-imx/recipes-kernel/linux/

Create a linux-variscite_4.14.78.bbappend file:

$ gedit linux-variscite_4.14.78.bbappend

and append the following lines to it (see the previous section for listing the commits or getting the latest commit id):

KERNEL_SRC = "git://github.com/your_account/linux-imx.git;protocol=git"
SRCBRANCH = "imx_4.14.78_1.0.0_ga_var01" (or your own created branch)
SRCREV = "The commit id you'd like to use"


For the SRCREV value you can also use "${AUTOREV}" during development to get the latest commit of the branch
(If you do so, make sure to run "bitbake -c cleansstate virtual/kernel" before rebuilding the kernel)