====== Deployment Yocto ======

===== Images Yocto =====

<WRAP round info>
  - All images are intended for the usage on a <nowiki>@stk_name@</nowiki>
  - The symlinks point to the files of the last build
</WRAP>

{{section>.:..:..:data#images_yocto&noheader}}

----
===== Create SD Card with BSP Image =====
Use an SD card to install a new firmware. \\
The following commands write the image from the host system to the SD card:

<code bash>
$ cd <BSP project>/platform-<platform_name>/images
$ sudo dd if=@bsp_image_name@-<build Timestamp>.rootfs.wic of=/dev/sdc bs=1M conv=fsync #Assuming the SD card is assigned to /dev/sdc
</code>


<WRAP round tip>You have to use the raw device of the SD card not a partition!</WRAP>
The command dmesg can be used to identify the SD card:
  - execute dmesg (sd card not plugged in)
  - insert SD Card and wait a few seconds
  - Run dmesg again
<code bash>
 dmesg 
 #plug in SD Card into socket
 dmesg 
</code>
\\
----
===== Updating existing firmware over ethernet =====
\\
To update bootloader / kernel / devicetree in a running system you have to copy the images in your tftp directory and upload them to the eMMC or SD Card.\\ 

Please see [[en:general_information:tftp|How to setup TFTP Server]]

<WRAP round tip> The variables can be saved with the command **saveenv** to keep the values even after a reboot
</WRAP>

1. Boot from eMMC or SD and stop autoboot in U-Boot\\
<code>Hit any key to stop autoboot:  0
=></code>\\

2. Set U-Boot variable //mmcdev//  according to the drive you want to write to
<code>=> setenv mmcdev <Nr.></code> 

{{section>.:..:..:data#device_assignment&noheader}}
\\
3. Connect device via ethernet on @eth_prime@ to a tftp server supplying the image\\

4. Prepare network interface:
++++ Set network settings manually |

Provide the correct network configuration in U-Boot: 
  * => setenv autoload no
  * => setenv serverip <serverip> (e.g.: setenv serverip 192.168.100.110) 
  * => setenv ipaddr <ipaddr> (e.g.: setenv ipaddr 192.168.100.111)
  * => setenv netmask <netmask> (e.g.: setenv netmask 255.255.255.0)

++++

++++ Set network settings using DHCP |
If a DHCP server is available in the network, the interface can be configured by the server:
  * => setenv autoload no
  * => setenv serverip <serverip> (e.g.: setenv serverip 192.168.100.110)
  * => dhcp (get IP from server)
++++
\\
5. Provide U-Boot the file name of the desired image on the tftp server: 
  * For U-Boot update: => setenv uboot <filename>\\
  * For Device Tree update: => setenv fdt_file <filename>\\
  * For Kernel update: => setenv image <filename>\\
6. Perform Update: 
  * U-Boot update: => run update_uboot\\
  * Device Tree update: => run update_fdt\\
  * Kernel update: => run update_kernel\\

----
===== Copy Firmware from SD card to eMMC using U-Boot =====

  * Write Image to SD card (use dd command under linux or Win32diskImager under Windows)
  * Set Starterkit to boot from SD, please see [[en:arm:@mod_name_code@:@mb_name_code@:dip_switches|DIP Switch Settings]]
  * Interrupt the boot process to get to the U-Boot prompt 
  * Use the following commands to copy the SD card to eMMMC

<WRAP round important>
You have to set the number of blocks according to the image size to read entire data that is stored on the SD card and write the same number of blocks to the eMMC.\\
**Formula to calulate the number of blocks**\\
Size of SD card image in bytes / 512. Convert the result to a hex value.\\
Since the data is stored in the SDRAM on the module the size of the image must not exeed the size of the SDRAM.
</WRAP>
{{section>.:..:..:data#yocto_specific_command_update_emmc&noheader}}
\\
2. Save environment with the saveenv command (optional):
<code>
=> saveenv
</code>
\\
3. run the following command to start the update procedure:
<code>
=> run install_firmware
</code>
----

===== Using NFS boot =====

== Prerequisites ==

  * [[en:nfs|How to setup the NFS Server on your Host Computer]] 
  * [[en:tftp|How to setup the TFTP Server on your Host Computer]]

<nowiki>
To boot the @mod_name@ from network you need a working bootloader in eMMC/SD-card or SPI-NOR (placement option on @mod_name@ ) which is able to get the kernel image over tftp and to provide the kernel with commandline settings for NFS.
The dtb-file and kernel image have to be provided via tftp and the rootfs via nfs.
</nowiki>
== Configuration of U-Boot Environment ==

The bootloader environment needs to be modified to work with your tftp-server and your nfs-server.\\
\\
 1. Prepare network interface:

++++ Set network settings manually |

Provide the correct network configuration in U-Boot: 
  * => setenv autoload no
  * => setenv serverip <serverip> (e.g.: setenv serverip 192.168.100.110) 
  * => setenv ipaddr <ipaddr> (e.g.: setenv ipaddr 192.168.100.111)
  * => setenv netmask <netmask> (e.g.: setenv netmask 255.255.255.0)

++++

++++ Set network settings using DHCP |
If a DHCP server is available in the network, the interface can be configured by the server:
  * => setenv autoload no
  * => setenv serverip <serverip> (e.g.: setenv serverip 192.168.100.110)
  * => dhcp (get IP from server)
++++

 2. set the Uboot variables for TFTP and NFS:
  * setenv rootpath <rootpath> <wrap important>(NFS directory has to set in /etc/exports on the Computer that runs the NFS server first)</wrap>
  * setenv fdt_file <fdt_file> (name of devicetree file to be downloaded from the tftp server)
  * setenv image <image> (name of the Linux kernel image to be downloaded from the tftp server)
 3. Run the uboot script to boot from nfs:
  
{{section>.:..:..:data##uboot_command_to_start_netboot&noheader}}