RDKV4.0 Firmware Upgrade - User Manual - 2020 - M3

1.1. Introduction

     This document describes the firmware update of RPI board using FirmwareControl plugin.Plugin can be enabled via controller UI once image is booted. Based on the request given to board, tarred firmware image is downloaded to RPI board from the given HTTP server and the image is updated accordingly.

1.2. Environment Setup

 The build procedure is as follows:

•  repo init -u https://code.rdkcentral.com/r/manifests -m rdkv-asp-nosrc.xml -b thunder-next
•  repo sync -j4 --no-clone-bundle
•  source meta-cmf-raspberrypi/setup-environment (select option raspberrypi-rdk-hybrid-thunder.conf)
•  bitbake rdk-generic-hybrid-thunder-image

1.2.1. Flashing the image

   Image is flashed to SD card before inserting to RPI board.   

Command to flash the image

    Generated image has to be flashed to an SD card using this command in local PC:

$ sudo dd if=<path to ImageName.rpi-sdimg> of=<path to SD card space> bs=4M

The SD card is then inserted to the Raspberry Pi board and booted to check for containers created.

The Raspberry Pi board is connected to the PC via a USB to serial converter and the logs can be checked in console or can be connected via HDMI cable to a TV and logs will be shown in the terminal

1.3. Test Setup

        For testing Firmware Control plugin , we need HTTP server that hosts the tarred image.

1.3.1.1. Setting up a HTTP server:

    For setting up a HTTP server we can use Apache 2.0 or lighttpd. Below are the steps for HTTP server using Apache 2 

•  Install Apache2 package
  •      sudo apt update
  •     sudo apt install apache2
•    Check the firewall application profiles
  •     sudo ufw app list
•    Modify firewall rules to allow Apache2
  •       sudo ufw allow 'Apache'   
• Verify the status
  • sudo ufw status
• Verify Apache2 service is running using systemd command
  • sudo systemctl status apache2

• Server can be connected using http request, http://<ip of device> (ex: http://192.168.2.8)

• Configuration files for Apache2 can be found in /etc/apache2/.

• We should place tar file to document root folder for accessing it. Check document root folder mentioned in conf file. This can be found in path /etc/apache2/sites-available/. 

  
  

  Ex: vim /etc/apache2/sites-available/000-default.conf <VirtualHost *:80> ServerAdmin webmaster@localhost DocumentRoot /var/www/html ErrorLog ${APACHE_LOG_DIR}/error.log CustomLog ${APACHE_LOG_DIR}/access.log combined </VirtualHost>

  
  
  

1.3.1.2. Enabling the FirmwareControl Plugin:

   FirmwareControl plugin is enabled or disabled via Controller UI. Controller UI is launched using browser via http://<board ip>

   Ex: http://192.168.2.20

Upon booting the image, firmwareControl plugin will be disabled

Plugin needs to be enabled before proceeding with firmware update.

1.3.1.3. RPi - Board :

• Flash the image supported with FirmwareControl plugin feature in the RPI board and verify the 2 partitions(ex. mmcblk0p1, mmcblk0p2) present under dev folder (use command fdisk -l)
• By default image tar file will be downloaded to /var/lib/ and the timeout value for downloading the image tar file is 600000. This can be changed in /etc/WPEFramework/plugins/FirmwareControl.json file. If value is modified, we have to restart wepframework, else changes will not be reflected.

• cat /etc/WPEFramework/plugins/FirmwareControl.json { "locator":"libWPEFrameworkFirmwareControl.so", "classname":"FirmwareControl", "autostart":false, "configuration":{ "download":"/var/lib", "waittime":600000 } }root@raspberrypi-rdk-hybrid-thunder:~#

• Execute curl request for firmware update

  Eg: curl --data-binary '{"jsonrpc": "2.0", "id": 1234567890, "method": "FirmwareControl.1.upgrade","params": { "name": "mediaclient.tar.gz", "location": "http://192.168.2.118/", "type": "CDL", "progressinterval": 10, "hmac": "21dd673fad68fbfd418e7bd9f0f16cb359c5743b4724c9af7347278e3183f2e4" } }' -H 'content-type:text/plain;' http://192.168.2.103/jsonrpc).

•  In the curl request , hmac is the sha256sum of the image tar file. This is generated using sha256sum command.

•   During first time execution, firmware update request creates two more partitions in memory(mmcblk0p3, mmcblk0p4) and auto reboots to update partition table. This happens only on the first request, further requests will not result in board reboot before firmware update.
• Once device boots up verify there are 4 partitions in /dev (ex. mmcblk0p1, mmcblk0p2, mmcblk0p3, mmcblk0p4) (use command fdisk -l to verify) .
• Enable FirmwareControl plugin in Metrological UI
• Execute curl request for firmware update for second time.
• Image tar file will be downloaded to a file in /var/lib folder as ImageTemp. Verify image is downloaded to /var/lib
• Reboot RPI board once firmware update process is completed manually using reboot -f command.
• Once board boots up verify the current image version ( cat /version.txt)
•  Verify the version of booted image which shows the downloaded image version

1.3.2. Conclusion

Please find the summary on firmware upgrade explained above

1.3.3. Limitations: 

•  Auto reboot after firmware update is not happening currently. User has to reboot manually after completion of firmware update.
•  RPI board will reboot before firmware update only for the first request for updating memory partition table, and user has to give request command once again for firmware update. This occurs only for the first request after board boot up.

1.4. TroubleShooting 

• Verify /var/lib has enough free space to accommodate the image tar file before initiating the download. This can be done using df -h command.