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

===== BSP Binaries =====

<callout type="primary" icon="true">
  - All binaries are intended for the usage on a <nowiki><label stk_name>STK_NAME</label></nowiki>
  - The symlinks point to the files of the last build
</callout>

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

===== Yocto Partitions =====

{{section>.:..:..:..:partitions#<label mod_name_partition>MOD_NAME_PARTITION</label>&noheader}}


----
===== Create SD Card with BSP Image =====
The Image can be simply written to the SD Card by using the dd shell command in Linux:

<code bash>
$ cd <path to your image>
$ sudo dd if=<label bsp_image_name>BSP_IMAGE_NAME</label>-<build Timestamp>.rootfs.wic of=/dev/sdc bs=1M conv=fsync #Assuming the SD card is assigned to /dev/sdc
</code>

<alert type="warning" icon="fa fa-warning">The image must be written to the RAW device of the SD Card (e.g. /dev/sdc) and not into a partition (e.g. /dev/sdc1) !</alert>

 To identify the SD card in Linux the shell command dmesg can be used:
  - Open a new terminal 
  - Execute the following command without plugged SD Card <code bash> $ dmesg | tail -n 15</code> 
  - Insert SD Card and wait a few seconds
  - Run the command from step two again
<code bash>
$ dmesg | tail -n 15 
 #plug in SD Card into the reader
$ dmesg | tail -n 15 
</code>
\\
----
===== Updating existing firmware over ethernet =====
\\
A good approach to update the firmare components U-Boot,Linux kernel and devicetree in a running system it to load them from a tftp server. \\ 
This process requires a running TFTP server, please see the following page [[en:general_information:tftp|how to setup TFTP Server]].
After setting up the TFTP server, the binaries to be updated must be copied into the TFTP directory. 

==== Update Process ==== 

1. Setup the Starterkit to boot from eMMC or SD \\  
2. Connect the kit to the network with TFTP server supplying the binaries via ethernet on connector <label eth_prime>ETH_PRIME</label> \\
3. Power up the system and interrupt the boot process in U-Boot\\
<code>
Hit any key to stop autoboot:  0
=>
</code>
3. Setup the ethernet interface:
++++ Set network settings manually |

Provide the correct network configuration in U-Boot: 
  * => setenv autoload no
  * => setenv serverip <serverip> (IP address of your TFTP server 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> (IP address of your TFTP server e.g.: setenv serverip 192.168.100.110)
  * => dhcp (get IP from server)
++++
\\
4. Set U-Boot variable **mmcdev** according to the drive you want to write to.
<code>=> setenv mmcdev <device_number></code> 
{{section>.:..:..:data#device_assignment&noheader}}

5. Set the file name of the binary to update in U-Boot : 
  * For U-Boot update: => setenv uboot <filename>\\  e.g. <label uboot_default>UBOOT_DEFAULT</label>
  * For devicetree update: => setenv fdt_file <filename>\\  e.g. <label fdt_default>FDT_DEFAULT</label>
  * For Linux kernel update: => setenv image <filename>\\ e.g. <label kernel_default>KERNEL_DEFAULT</label>
6. Perform Update by running the update command: 
  * U-Boot update: <code>=> run <label update_uboot_cmd>UPDATE_UBOOT_CMD</label></code> \\
  * Device Tree update:<code>=> run <label update_dtb_cmd>UPDATE_FDT_CMD</label></code>\\
  * Kernel update:<code>=> run <label update_kernel_cmd>UPDATE_KERNEL_CMD</label></code>\\

<callout type="info" icon="true">
The variables can be saved with the command **saveenv** to keep the values permanently.
</callout>

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

  * Write Image to SD card (use dd command under Linux or Win32diskImager under Windows)
<alert type="warning" icon="fa fa-warning">The image on the SD card must not be booted, otherwise the initial run once services have already been started.</alert>
  * Set Starterkit to boot from SD, please see [[en:<label mod_arch>MOD_ARCH</label>:<label mod_name_code>MOD_NAME_CODE</label>:<label mb_name_code>MB_NAME_CODE</label>: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
<callout type="primary" icon="true">
The following commands are based on the default [[.:deployment_yocto#yocto_partitions|eMMC/SD image partitioning]].
</callout>
{{section>.:..:..:data#yocto_specific_command_update_emmc&noheader}}
\\
2. Save environment U-boot environment (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 <label mod_name>ModuleName</label> from network you need a working bootloader in eMMC/SD-card or SPI-NOR (placement option on <label mod_name>ModuleName</label> ) 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 hi>(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}}