Difference between revisions of "Modify, rebuild and reload the Linux® kernel"

[quality revision] [quality revision]
m
m (Push the kernel modules into the board)
 

1 Overview[edit]

This stage explains how modify, rebuild and reload the Linux® kernel.
You will first be guided to install the Linux® kernel source code in the Developer Package directory. Then step by step you will execute procedures to modify, rebuild and reload the Linux® kernel.

2 Download the the Linux® kernel source code[edit]

The software package is provided AS IS, and by downloading it, you agree to be bound to the terms of the software license agreement (SLA). The detailed content licenses can be found here.

Warning white.png Warning
To download a package, it is recommended to be logged in to your "myst" account [1]. If, trying to download, you encounter a “403 error”, you could try to empty your browser cache to workaround the problem. We are working on the resolution of this problem.
We apologize for this inconvenience
2.1 For ecosystem release v2.1.0 More info.png[edit]
  • Download the STM32MP15-Ecosystem-v2.1.0 Developer Package Sources to the following directory:
    $HOME/STM32MPU_workspace/STM32MP15-Ecosystem-v2.1.0/Developer-Package
  • Uncompress the tarball file to get the Linux® kernel tarball, the ST patches and the ST configuration fragments
 cd $HOME/STM32MPU_workspace/STM32MP15-Ecosystem-v2.1.0/Developer-Package
 tar xvf en.SOURCES-kernel-stm32mp1-openstlinux-5-4-dunfell-mp1-20-11-12.tar.xz

2.2 For ecosystem release v2.0.0 More info.png[edit]
  • Download the STM32MP15-Ecosystem-v2.0.0 Developer Package Sources to the following directory:
    $HOME/STM32MPU_workspace/STM32MP15-Ecosystem-v2.0.0/Developer-Package
  • Uncompress the tarball file to get the Linux® kernel tarball, the ST patches and the ST configuration fragments
 cd $HOME/STM32MPU_workspace/STM32MP15-Ecosystem-v2.0.0/Developer-Package
 tar xvf en.SOURCES-kernel-stm32mp1-openstlinux-5-4-dunfell-mp1-20-06-24.tar.xz

3 Prepare the Linux® kernel source code[edit]

  • Extract the Linux® kernel source
For ecosystem release  v2.1.0 More info.png 
 cd stm32mp1-openstlinux-5-4-dunfell-mp1-20-11-12/sources/arm-ostl-linux-gnueabi/linux-stm32mp-5.4.56-r0
 tar xvf linux-5.4.56.tar.xz
For ecosystem release  v2.0.0 More info.png 
 cd stm32mp1-openstlinux-5.4-dunfell-mp1-20-06-24/sources/arm-ostl-linux-gnueabi/linux-stm32mp-5.4.31-r0
 tar xvf linux-5.4.31.tar.xz


  • Apply the ST patches
 cd linux-5.4.56 /* For ecosystem release  v2.1.0 More info.png  */ 
 cd linux-5.4.31 /* For ecosystem release  v2.0.0 More info.png  */
 for p in `ls -1 ../*.patch`; do patch -p1 < $p; done

  • Apply fragments
 make ARCH=arm multi_v7_defconfig "fragment*.config"
 for f in `ls -1 ../fragment*.config`; do scripts/kconfig/merge_config.sh -m -r .config $f; done
 yes '' | make ARCH=arm oldconfig

4 Build the Linux® kernel source code for the first time[edit]

Info white.png Information
The first time the kernel is build it could take several minutes.
  • Build kernel images (uImage and vmlinux) and device tree (dtbs)
 make ARCH=arm uImage vmlinux dtbs LOADADDR=0xC2000040

  • Build kernel module
 make ARCH=arm modules

  • Generate output build artifacts
 mkdir -p $PWD/install_artifact/
 make ARCH=arm INSTALL_MOD_PATH="$PWD/install_artifact" modules_install

5 Deploy the Linux® kernel on the board[edit]

5.1 Push the Linux® kernel into the board[edit]

 scp arch/arm/boot/uImage root@<board ip address>:/boot

5.2 Push the devicetree into the board[edit]

 scp arch/arm/boot/dts/stm32mp157*.dtb root@<board ip address>:/boot

5.3 Push the kernel modules into the board[edit]

  • Remove the link created inside the install_artifact/lib/modules/<kernel version> directory
For ecosystem release  v2.1.0 More info.png :
 rm install_artifact/lib/modules/5.4.56/build install_artifact/lib/modules/5.4.56/source 
For ecosystem release  v2.0.0 More info.png :
 rm install_artifact/lib/modules/5.4.31/build install_artifact/lib/modules/5.4.31/source

  • Optionally, strip kernel modules (to reduce the size of each kernel modules)
 find install_artifact/ -name "*.ko" | xargs $STRIP --strip-debug --remove-section=.comment --remove-section=.note --preserve-dates

  • Copy Kernel modules
 scp -r install_artifact/lib/modules/* root@<ip of board>:/lib/modules

  • Using the Linux console, re-generate the list of module dependencies (modules.dep) and the list of symbols provided by modules (modules.symbols)
 /sbin/depmod -a

  • Synchronize data on disk with memory
 sync

5.4 Reboot the board[edit]

 reboot

6 Modifying a built-in Linux kernel device driver[edit]

This simple example adds unconditional log information when the display driver is probed.

  • Using the Linux console, check that there is no log information when the display driver is probed
 dmesg | grep -i stm_drm_platform_probe


  • Go to the Linux® kernel source directory
For ecosystem release  v2.1.0 More info.png :
 cd $HOME/STM32MPU_workspace/STM32MP15-Ecosystem-v2.1.0/Developer-Package/stm32mp1-openstlinux-5-4-dunfell-mp1-20-11-12/sources/arm-ostl-linux-gnueabi/linux-stm32mp-5.4.56-r0/linux-5.4.56
For ecosystem release  v2.0.0 More info.png :
 cd $HOME/STM32MPU_workspace/STM32MP15-Ecosystem-v2.0.0/Developer-Package/stm32mp1-openstlinux-5.4-dunfell-mp1-20-06-24/sources/arm-ostl-linux-gnueabi/linux-stm32mp-5.4.31-r0/linux-5.4.31


  • Edit the ./drivers/gpu/drm/stm/drv.c source file
  • Add a log information in the stm_drm_platform_probe function as follow
static int stm_drm_platform_probe(struct platform_device *pdev)
{
	struct device *dev = &pdev->dev;
	struct drm_device *ddev;
	int ret;
	[...]

	DRM_INFO("Simple example - %s\n", __func__);

	return 0;
	[...]
}

  • Save the file
  • Rebuitd the Linux® kernel
 make uImage LOADADDR=0xC2000040

  • Update the Linux kernel image into board
 scp arch/arm/boot/uImage root@<board ip address>:/boot

  • Reboot the board
 reboot

  • Check that there is now log information when the display driver is probed
 dmesg | grep -i stm_drm_platform_probe
[    2.764080] [drm] Simple example - stm_drm_platform_probe


==Overview==
This stage explains how modify, rebuild and reload the Linux® kernel.<br>

You will first be guided to install the Linux® kernel source code in the Developer Package directory. Then step by step you will execute procedures to modify, rebuild and reload the Linux® kernel.

==Download the the Linux® kernel source code==
{{SoftwareLicenseAgreement | distribution=OpenSTLinux | chapter=Kernel partitions:}}

======For {{EcosystemRelease | revision=2.1.0.0}}======}}======
* Download the [{{EcosystemRelease/Package | revision=2.1.0 | package=Linux kernel package | request=url}}/{{EcosystemRelease/Package | revision=2.1.0 | package=Linux kernel package | request=name}} STM32MP15-Ecosystem-v2.1.0 Developer Package Sources] to the following directory:<br> '''$HOME/STM32MPU_workspace/STM32MP15-Ecosystem-v2.1.0/Developer-Package'''
* Uncompress the tarball file to get the Linux® kernel tarball, the ST patches and the ST configuration fragments
 {{PC$}} cd $HOME/STM32MPU_workspace/STM32MP15-Ecosystem-v2.1.0/Developer-Package
 {{PC$}} tar xvf {{EcosystemRelease/Package | revision=2.1.0 | package=Linux kernel package | request=name}}
<div class="mw-collapsible mw-collapsed">

======For {{EcosystemRelease | revision=2.0.0}}======<div class="mw-collapsible-content">
* Download the [{{EcosystemRelease/Package | revision=2.0.0 | package=Linux kernel package | request=url}}/{{EcosystemRelease/Package | revision=2.0.0 | package=Linux kernel package | request=name}} STM32MP15-Ecosystem-v2.0.0 Developer Package Sources] to the following directory:<br> '''$HOME/STM32MPU_workspace/STM32MP15-Ecosystem-v2.0.0/Developer-Package'''
* Uncompress the tarball file to get the Linux® kernel tarball, the ST patches and the ST configuration fragments
 {{PC$}} cd $HOME/STM32MPU_workspace/STM32MP15-Ecosystem-v2.0.0/Developer-Package
 {{PC$}} tar xvf {{EcosystemRelease/Package | revision=2.0.0 | package=Linux kernel package | request=name}}
</div>

==Prepare the Linux® kernel source code==
* Extract the Linux® kernel source
 For {{EcosystemRelease | revision=2.1.0.0}}
 {{PC$}} }}
 {{PC$}} cd {{EcosystemRelease/Package | revision=2.1.0 | package=Linux kernel package | request=path}}
 {{PC$}} tar xvf {{EcosystemRelease/Package | revision=2.1.0 | package=Linux kernel source | request=name}}
 For {{EcosystemRelease | revision=2.0.0}}<span class="mw-collapsible mw-collapsed">

 {{PC$}} cd {{EcosystemRelease/Package | revision=2.0.0 | package=Linux kernel package | request=path}}
 {{PC$}} tar xvf {{EcosystemRelease/Package | revision=2.0.0 | package=Linux kernel source | request=name}}
</span>

* Apply the ST patches
 {{PC$}} cd {{EcosystemRelease/Package | revision=2.1.0.0 |  | package=Linux kernel source | request=path}} /* '''For {{EcosystemRelease | revision=2.1.0 }} '''*/ 
 {{PC$}} cd {{EcosystemRelease/Package | revision=2.0.0 | package=Linux kernel source | request=path}} /* '''For {{EcosystemRelease | revision=2.0.0 }} '''*/
 {{PC$}} for p in `ls -1 ../*.patch`; do patch -p1 < $p; done

* Apply fragments
 {{PC$}} make ARCH=arm multi_v7_defconfig "fragment*.config"
 {{PC$}} for f in `ls -1 ../fragment*.config`; do scripts/kconfig/merge_config.sh -m -r .config $f; done
 {{PC$}} yes <nowiki>''</nowiki> | make ARCH=arm oldconfig

==Build the Linux® kernel source code for the first time==
{{Info|The first time the kernel is build it could take several minutes.}}
* Build kernel images (uImage and vmlinux) and device tree (dtbs)
 {{PC$}} make ARCH=arm uImage vmlinux dtbs LOADADDR=0xC2000040
* Build kernel module
 {{PC$}} make ARCH=arm modules
* Generate output build artifacts
 {{PC$}} mkdir -p $PWD/install_artifact/
 {{PC$}} make ARCH=arm INSTALL_MOD_PATH="$PWD/install_artifact" modules_install

==Deploy the Linux® kernel on the board==
===Push the Linux® kernel into the board===
 {{PC$}} scp arch/arm/boot/uImage root@<board ip address>:/boot

===Push the devicetree into the board===
 {{PC$}} scp arch/arm/boot/dts/stm32mp157*.dtb root@<board ip address>:/boot

===Push the kernel modules into the board===
* Remove the link created inside the '''install_artifact/lib/modules/<kernel version>''' directory
 For {{EcosystemRelease | revision=2.1.0.0}}:
 {{PC$}} rm install_artifact/lib/modules/5.4.56/build install_artifact/lib/modules/5.4.56/source 
 For {{EcosystemRelease | revision=2.0.0}}:
 {{PC$}} rm install_artifact/lib/modules/5.4.31/build install_artifact/lib/modules/5.4.31/source

* Optionally, strip kernel modules (to reduce the size of each kernel modules)
 {{PC$}} find install_artifact/ -name "*.ko" | xargs $STRIP --strip-debug --remove-section=.comment --remove-section=.note --preserve-dates
* Copy Kernel modules
 {{PC$}} scp -r install_artifact/lib/modules/* root@<ip of board>:/lib/modules
* Using the Linux console, re-generate the list of module dependencies (modules.dep) and the list of symbols provided by modules (modules.symbols)
 {{Board$}} /sbin/depmod -a
* Synchronize data on disk with memory
 {{Board$}} sync

===Reboot the board===
 {{Board$}} reboot

==Modifying a built-in Linux kernel device driver==
This simple example adds unconditional log information when the display driver is probed.<br><br>


* Using the Linux console, check that there is no log information when the display driver is probed
 {{Board$}} dmesg | grep -i stm_drm_platform_probe
 {{Board$}}

* Go to the Linux® kernel source directory
 For {{EcosystemRelease | revision=2.1.0.0}}:}}:
 {{PC$}} cd $HOME/STM32MPU_workspace/STM32MP15-Ecosystem-v2.1.0/Developer-Package/{{EcosystemRelease/Package | revision=2.1.0 | package=Linux kernel package | request=path}}/{{EcosystemRelease/Package | revision=2.1.0 | package=Linux kernel source | request=path}}
 For {{EcosystemRelease | revision=2.0.0}}:<span class="mw-collapsible mw-collapsed">

 {{PC$}} cd $HOME/STM32MPU_workspace/STM32MP15-Ecosystem-v2.0.0/Developer-Package/{{EcosystemRelease/Package | revision=2.0.0 | package=Linux kernel package | request=path}}/{{EcosystemRelease/Package | revision=2.0.0 | package=Linux kernel source | request=path}}
</span>

* Edit the ''./drivers/gpu/drm/stm/drv.c'' source file
* Add a log information in the ''stm_drm_platform_probe'' function as follow
 static int stm_drm_platform_probe(struct platform_device *pdev)
 {
 	struct device *dev = &pdev->dev;
 	struct drm_device *ddev;
 	int ret;
 	[...]

 	{{Highlight|DRM_INFO("Simple example - %s\n", __func__);}}

 	return 0;
 	[...]
 }
* Save the file
* Rebuitd the Linux® kernel
 {{PC$}} make uImage LOADADDR=0xC2000040
* Update the Linux kernel image into board
 {{PC$}} scp arch/arm/boot/uImage root@<board ip address>:/boot
* Reboot the board
 {{Board$}} reboot
* Check that there is now log information when the display driver is probed
 {{Board$}} dmesg | grep -i stm_drm_platform_probe
 [    2.764080] [drm] Simple example - stm_drm_platform_probe
<noinclude>

{{NoIndex}}
__NOTOC__
[[Category:Sub-articles]]
{{PublicationRequestId | Auto}}</noinclude>
(3 intermediate revisions by the same user not shown)
Line 6: Line 6:
 
{{SoftwareLicenseAgreement | distribution=OpenSTLinux | chapter=Kernel partitions:}}
 
{{SoftwareLicenseAgreement | distribution=OpenSTLinux | chapter=Kernel partitions:}}
   
  +
======For {{EcosystemRelease | revision=2.1.0}}======
  +
* Download the [{{EcosystemRelease/Package | revision=2.1.0 | package=Linux kernel package | request=url}}/{{EcosystemRelease/Package | revision=2.1.0 | package=Linux kernel package | request=name}} STM32MP15-Ecosystem-v2.1.0 Developer Package Sources] to the following directory:<br> '''$HOME/STM32MPU_workspace/STM32MP15-Ecosystem-v2.1.0/Developer-Package'''
  +
* Uncompress the tarball file to get the Linux® kernel tarball, the ST patches and the ST configuration fragments
  +
{{PC$}} cd $HOME/STM32MPU_workspace/STM32MP15-Ecosystem-v2.1.0/Developer-Package
  +
{{PC$}} tar xvf {{EcosystemRelease/Package | revision=2.1.0 | package=Linux kernel package | request=name}}
  +
  +
<div class="mw-collapsible mw-collapsed">
 
======For {{EcosystemRelease | revision=2.0.0}}======
 
======For {{EcosystemRelease | revision=2.0.0}}======
  +
<div class="mw-collapsible-content">
 
* Download the [{{EcosystemRelease/Package | revision=2.0.0 | package=Linux kernel package | request=url}}/{{EcosystemRelease/Package | revision=2.0.0 | package=Linux kernel package | request=name}} STM32MP15-Ecosystem-v2.0.0 Developer Package Sources] to the following directory:<br> '''$HOME/STM32MPU_workspace/STM32MP15-Ecosystem-v2.0.0/Developer-Package'''
 
* Download the [{{EcosystemRelease/Package | revision=2.0.0 | package=Linux kernel package | request=url}}/{{EcosystemRelease/Package | revision=2.0.0 | package=Linux kernel package | request=name}} STM32MP15-Ecosystem-v2.0.0 Developer Package Sources] to the following directory:<br> '''$HOME/STM32MPU_workspace/STM32MP15-Ecosystem-v2.0.0/Developer-Package'''
 
* Uncompress the tarball file to get the Linux® kernel tarball, the ST patches and the ST configuration fragments
 
* Uncompress the tarball file to get the Linux® kernel tarball, the ST patches and the ST configuration fragments
 
  {{PC$}} cd $HOME/STM32MPU_workspace/STM32MP15-Ecosystem-v2.0.0/Developer-Package
 
  {{PC$}} cd $HOME/STM32MPU_workspace/STM32MP15-Ecosystem-v2.0.0/Developer-Package
 
  {{PC$}} tar xvf {{EcosystemRelease/Package | revision=2.0.0 | package=Linux kernel package | request=name}}
 
  {{PC$}} tar xvf {{EcosystemRelease/Package | revision=2.0.0 | package=Linux kernel package | request=name}}
  +
</div>
   
 
==Prepare the Linux® kernel source code==
 
==Prepare the Linux® kernel source code==
 
* Extract the Linux® kernel source
 
* Extract the Linux® kernel source
  For {{EcosystemRelease | revision=2.0.0}}
+
For {{EcosystemRelease | revision=2.1.0}}
  +
{{PC$}} cd {{EcosystemRelease/Package | revision=2.1.0 | package=Linux kernel package | request=path}}
  +
{{PC$}} tar xvf {{EcosystemRelease/Package | revision=2.1.0 | package=Linux kernel source | request=name}}
  +
  For {{EcosystemRelease | revision=2.0.0}}<span class="mw-collapsible mw-collapsed">
 
  {{PC$}} cd {{EcosystemRelease/Package | revision=2.0.0 | package=Linux kernel package | request=path}}
 
  {{PC$}} cd {{EcosystemRelease/Package | revision=2.0.0 | package=Linux kernel package | request=path}}
 
  {{PC$}} tar xvf {{EcosystemRelease/Package | revision=2.0.0 | package=Linux kernel source | request=name}}
 
  {{PC$}} tar xvf {{EcosystemRelease/Package | revision=2.0.0 | package=Linux kernel source | request=name}}
   
+
  </span>
  +
 
 
* Apply the ST patches
 
* Apply the ST patches
  +
{{PC$}} cd {{EcosystemRelease/Package | revision=2.1.0 | package=Linux kernel source | request=path}} /* '''For {{EcosystemRelease | revision=2.1.0 }} '''*/
 
  {{PC$}} cd {{EcosystemRelease/Package | revision=2.0.0 | package=Linux kernel source | request=path}} /* '''For {{EcosystemRelease | revision=2.0.0 }} '''*/
 
  {{PC$}} cd {{EcosystemRelease/Package | revision=2.0.0 | package=Linux kernel source | request=path}} /* '''For {{EcosystemRelease | revision=2.0.0 }} '''*/
 
  {{PC$}} for p in `ls -1 ../*.patch`; do patch -p1 < $p; done
 
  {{PC$}} for p in `ls -1 ../*.patch`; do patch -p1 < $p; done
Line 46: Line 60:
 
===Push the kernel modules into the board===
 
===Push the kernel modules into the board===
 
* Remove the link created inside the '''install_artifact/lib/modules/<kernel version>''' directory
 
* Remove the link created inside the '''install_artifact/lib/modules/<kernel version>''' directory
  +
For {{EcosystemRelease | revision=2.1.0}}:
  +
{{PC$}} rm install_artifact/lib/modules/5.4.56/build install_artifact/lib/modules/5.4.56/source
 
  For {{EcosystemRelease | revision=2.0.0}}:
 
  For {{EcosystemRelease | revision=2.0.0}}:
 
  {{PC$}} rm install_artifact/lib/modules/5.4.31/build install_artifact/lib/modules/5.4.31/source
 
  {{PC$}} rm install_artifact/lib/modules/5.4.31/build install_artifact/lib/modules/5.4.31/source
Line 70: Line 86:
   
 
* Go to the Linux® kernel source directory
 
* Go to the Linux® kernel source directory
  For {{EcosystemRelease | revision=2.0.0}}:
+
For {{EcosystemRelease | revision=2.1.0}}:
  +
{{PC$}} cd $HOME/STM32MPU_workspace/STM32MP15-Ecosystem-v2.1.0/Developer-Package/{{EcosystemRelease/Package | revision=2.1.0 | package=Linux kernel package | request=path}}/{{EcosystemRelease/Package | revision=2.1.0 | package=Linux kernel source | request=path}}
  +
  For {{EcosystemRelease | revision=2.0.0}}:<span class="mw-collapsible mw-collapsed">
 
  {{PC$}} cd $HOME/STM32MPU_workspace/STM32MP15-Ecosystem-v2.0.0/Developer-Package/{{EcosystemRelease/Package | revision=2.0.0 | package=Linux kernel package | request=path}}/{{EcosystemRelease/Package | revision=2.0.0 | package=Linux kernel source | request=path}}
 
  {{PC$}} cd $HOME/STM32MPU_workspace/STM32MP15-Ecosystem-v2.0.0/Developer-Package/{{EcosystemRelease/Package | revision=2.0.0 | package=Linux kernel package | request=path}}/{{EcosystemRelease/Package | revision=2.0.0 | package=Linux kernel source | request=path}}
   
+
  </span>
  +
 
 
* Edit the ''./drivers/gpu/drm/stm/drv.c'' source file
 
* Edit the ''./drivers/gpu/drm/stm/drv.c'' source file
 
* Add a log information in the ''stm_drm_platform_probe'' function as follow
 
* Add a log information in the ''stm_drm_platform_probe'' function as follow