The RDK firmware upgrader, the RDK agent at the CPE device side with the goal to provide an efficient and safe way to upgrade Firmware on the Field boxes. The module has the capability to

• Ping cloud server to get new Firmware images
• Download the images to secure location
• Verify the signature of the downloaded firmware
• Flash the image onto the box using manufacture library APIs

The module supports the upgrade of multiple Firmware types to RDK unit (RDK Video and stream boxes.)

• PCI
• PDRI
• Remote Firmware
• Additional supports to deploy and updates security certificate bundles 

Repository

rdkcentral/rdkfwupdater

The module also does the latest firmware image verification of installed firmware on every boot cycle and during maintenance window time.

This framework is design and developed to download latest firmware from the SSR server by communication with XCONF server. When device boot up it communicate with XCONF server and get the firmware details as a response and then check either running/active firmware compare with XCONF response firmware. If the firmware is different then it proceeds for downloading new firmware and flashing to the device bank. The framework also supports to download and flash PDRI and peripheral firmware. If the firmware is same, then download won't start and firmware upgrader application exit. Same procedure is applicable during maintenance window time.

Here the firmware images are signed and deployed to SSR server during the build time and box will download the firmware from SSR server based on the XCONF response information available.

Sub Functionalities

This service provides the download location (URL) required for RDK download Manager for dynamic Apps/packages/certs/tools installation. This module is responsible to trigger RDM Application. The module will do the security evaluation of the downloaded packages and verify the signature to ensure the installation of packages. 

RDK Firmware Upgrader

The App or binary name as part of rootfs is "rdkvfwupgrader". This module having below components

rdkv_main: This is the main process name for the module which will use all the below sub-components to collect the required data for xconf communication, download the image types from the SSR end points and flashing to the memory.

Sub-components

deviceutils

This component is responsible to get all device information like build info, partner id, mac address etc.

Below are the Function use to get device information.

BuildRemoteInfo:  Formats the "periperalFirmwares" string for remote info part of xconf communication

getJsonRpc : This is the API use to get JSONRPC data. The first argument is http post data and second argument holds the downloaded data. As part of post data need to send curl header which contains content type and authorization token.

getInstalledBundleFileList: gets the list of bundles installed on a device

GetServURL - gets the correct XCONF URL based on device configuration.

GetTimezone: This function is use to get the timezone of the device.

GetAdditionalFwVerInfo: This function is use to get the PDRI image details from the device.

GetInstalledBundles: This function is use to extract the bundle installed in the device.

GetUTCTime: gets a formatted UTC device time.

GetCapabilities - gets the device capabilities.

GetPartnerId - gets the partner ID of the device.

GetTargetProposition - gets the TargetProposition of the device.

GetSerialNum - gets the serial number of the device.

GetExperience - gets the experience of the device.

GetAccountID - gets the account ID of the device.

GetModelNum - gets the model number of the device.

GetBuildType - gets the build type of the device in lowercase.

GetFirmwareVersion - gets the firmware version of the device.

GetEstbMac - gets the eSTB MAC address of the device.

GetRemoteInfo - gets the remote info of the device.

flash

This component is responsible to flash the image to the flash memory after download completed. The download framework download the configured images into secondary/memory location and then using the manufacture API utilities to flash and update the boot loader parameters

iarmInterface

This component provides an API interface to use IARM-related calls. The application uses init_event_handler() function to initialize and register IARM Event. IARM Event is used to receive the event from other modules. Here maintenance manager sends an event when the device mode changes. There are 2 modes foreground and background. If the mode is foreground the firmware download happens at limited speed which is called throttle mode and if the mode is background then the download happens at full speed which is un-throttle mode.

eventManager: This is used to send IARM broadcast events to other modules. This application sends firmware download status to maintenance manager and system manager.

All the firmware download state macro is defined as part of iarmInterface.h file

Broadcast Event For Maintenance Manager:

Broadcast Event For System Service

jsonprocess

This component is responsible for processing the xconf response and parse the json file. Then create a data structure to use further.

The firmware upgrader queries Xconf to check whether any upgrade is available for this device. The API is used to communicate with the Xconf and below are its typical parameters. The device details are fetched using the APIs as part of the deviceutils component.

The response from Xconf is processed as part of the jsonparser Component. This is a typical response from the Xconf. 

{
"firmwareDownloadProtocol":"http",
"firmwareFilename":"lib32-application-test-image-RPI4-raspberrypi4-64-rdke-feature-RDKECOREMW-863-OTA.wic.tar.gz",
"firmwareLocation":"https://tools.rdkcentral.com:8443/images/",
"firmwareVersion":"lib32-application-test-image-RPI4-raspberrypi4-64-rdke-feature-RDKECOREMW-863-OTA.wic.tar.gz",
"mandatoryUpdate":false,
"rebootImmediately":false
}

1. firmwareDownloadProtocol : This field represents the protocol. Rdkvfwupgrader support only http protocol.
2. firmwareFilename: This filed use for PCI image details.
3. firmwareLocation: This field provides URL endpoint to download image.
4. firmwareVersion: This field provides the firmware version with out adding signed or unsigned details.
5. rebootImmediatly: This field is used for critical updates. If this is true then the device will reboot immediately after PCI flash happens to flash memory. If this is false then reboot will happen during reboot window time.
6. additionalFwVerInfo: This field is used for PDRI image details.
7. remCtrl: This field is used for peripheral firmware details.
8. cloudDelayDownload: This field is use for make the download start with some delay.
9. dlCertBundle: This filed is used for to get certificate bundle details.

The key parameters of this json response are populated as part of this datastructure.

typedef struct xconf_response {    
	char cloudFWFile[64];
	char cloudFWLocation[CLD_URL_MAX_LEN];
	char ipv6cloudFWLocation[CLD_URL_MAX_LEN];
	char cloudFWVersion[64];
	char cloudDelayDownload[8];
	char cloudProto[6];
	char cloudImmediateRebootFlag[12];
	char peripheralFirmwares[256];
 	char dlCertBundle[64];
	char cloudPDRIVersion[64];
	char rdmCatalogueVersion[512];
} XCONFRES;

rfcInterface

This component provided rfc api to use for getting rfc value and setting rfc value.

This component is responsible for reading the rfc value and writing the rfc value. Below are the rfc used in this module.

1. RFC_THROTTLE: This is used to enable the throttle download feature. Using this feature we can control the download speed. RFC_TOPSPEED value is used to decide the speed of the download. This feature is used for a better experience for the user while watching videos.
2. RFC_INCR_CDL: This is used to enable the incremental/chunk download. Using this feature we can resume the download if the download is failed due to slow internet(curl error code 18) and max time out (curl error code 28). Using this feature we can save the network usage data and quick firmware upgrade.
3. RFC_DIRECT_CDN: This is use for enable direct cdn feature. If this feature is enable image download happen using signing url provided by xconf server.

dwnlUtils

This a share library and provide all the download api using curl interface.

parsejson

This is a share library and provide all the json parser api using cjson.

utils

This is a share library and provide all the device specific information by reading device configure file or using some api. 

RDK Firmware Upgrader Capability

1. Communicate with XCONF server and get the response.
2. Processing of XCONF response and extract the firmware image details.
3. Download and flash PCI image from the SSR server to device flash memory.
4. Download and flash PDRI image from the SSR server to device flash memory.
5. Download and flash peripheral image from the SSR server to device flash memory.
6. retry download if download fail other than image not found on server error.
7. Trigger RDM Application.
8. Download cert bundle.
9. Support state red recovery download if the download is fail due to invalid certificate.
10. Support incremental download. This feature needs to be enable using "Device.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.IncrementalCDL.Enable" RFC
11. Support Throttle download based on download speed mentioned. This feature needs to be enable using "Device.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.SWDLSpLimit.Enable" RFC

Low Level Design Flow From Start To End

1. This module is trigger by Maintenance Manager. And the trigger time is during boot up and maintenance window time and App trigger.
2. In case of non-RDKE swupdate.service or maintenance manager is calling "swupdate_utils.sh". Then swupdate_utils.sh will call "rdkvfwupgrader" if the RDK Firmware RFC is true else script based download will start. 
3. In case of RDK-E maintenance manager is calling rdkvfwupdater using system call.
4. Once the rdkvfwupgrader start it gets all device info like MAC, partner id, current running image, pdri image, peripheral image etc and create XCONF query request. Below is the sample XCONF query request.

   eStbMac=D8:3A:DD:0A:43:71&firmwareVersion=lib32-middleware-test-image-RPI4-20251118074027&env=dev&model=RPI4&manufacturer=RaspberryPi&partnerId=community&activationInProgress=false&osClass=Not Available&accountId=1234&serial=10000000e33bf0d4&localtime=Wed Nov 26 13:44:09 UTC 2025&dlCertBundle=&rdmCatalogueVersion=&timezone=Asia/Calcutta&capabilities=rebootDecoupled&capabilities=RCDL&capabilities=supportsFullHttpUrl

5. Once the query request is formed then this module send the request to XCONF server and get the response. This response is in json format.

   { "firmwareDownloadProtocol":"http", "firmwareFilename":"lib32-application-test-image-RPI4-raspberrypi4-64-rdke-feature-RDKECOREMW-863-OTA.wic.tar.gz", "firmwareLocation":"https://tools.rdkcentral.com:8443/images/", "firmwareVersion":"lib32-application-test-image-RPI4-raspberrypi4-64-rdke-feature-RDKECOREMW-863-OTA.wic.tar.gz", "mandatoryUpdate":false, "rebootImmediately":false }

6. Once the XCONF response received then it processes the response and add to the data structure for future use.
7. Then this module does the image validation if image is invalid then this module is exit with error message.
8. Once the image validation pass then it goes for PCI download. If the download fail then it has 3 times retry before make download status fail. If the download completed successfully then this image is flashed to the flash memory. Before image download start this module will check if any chunk of the image already present if it present then download start from where it left last time.
9. If the download is failed due to certificate validation error, then state red recovery download will trigger. This is a kind of recovery server which is use static certificate to download image.
10. If no failure during download and download completed successfully then this image is flashed to flash memory. Before flashing the image sign verification happen.
11. Same above step 7 to 10 repeat for PDRI image and peripheral image.
12. Once the download completed the status of the download is send to maintenance manager and some other service using IARM event.

Firmware Download Trigger Sequence Diagram in RDK-V Device:

Below Sequence diagram is for device where maintenance manager is running

Sequence Diagram RDKE

@startuml
title Reference
legend
  |<back:Green>   | Libraries       |
  |<back:Yellow>  | Cloud Endpoints |
  |<back:Grey>    | Daemon          |
end legend
@enduml

@startuml
participant mm
participant rdkvfwupdater
participant iarm
participant rfc
participant utilslib #Green
participant downloadlib #Green
participant xconfserver #Yellow
participant parsinglib #Green
participant ssrserver #Yellow
participant flashapp

mm -> rdkvfwupdater : trigger
rdkvfwupdater -> rdkvfwupdater : initial validation
alt validation success
    rdkvfwupdater -> utilslib : get device details
    utilslib --> rdkvfwupdater : device details
    rdkvfwupdater -> rfc : get rfc data
    rfc --> rdkvfwupdater : rfc data
    rdkvfwupdater -> downloadlib : connect to xconf server
    downloadlib -> xconfserver : request
    alt xconf response success
        xconfserver --> downloadlib : success response
        downloadlib --> rdkvfwupdater : success response
        rdkvfwupdater -> parsinglib : parse json data
        alt parsing success
            parsinglib --> rdkvfwupdater : success response
            rdkvfwupdater -> rdkvfwupdater : process json data
            alt new image different
                rdkvfwupdater -> downloadlib : download image
                downloadlib -> ssrserver : request
                ssrserver --> downloadlib : server status
                alt server status 0
                    downloadlib --> rdkvfwupdater : success response
                    rdkvfwupdater -> flashapp : flash image
                    flashapp --> rdkvfwupdater : flash status
                    rdkvfwupdater -> iarm : success status
                    iarm --> mm : success status
                else server status 18 or 28
                    downloadlib --> rdkvfwupdater : chunkdownload
                    rdkvfwupdater -> flashapp : flash image
                    flashapp --> rdkvfwupdater : flash status
                    rdkvfwupdater -> iarm : success status
                    iarm --> mm : success status
                else server status 58
                    rdkvfwupdater -> rdkvfwupdater : recovery download
                else other server status
                    downloadlib --> rdkvfwupdater : retry download
                    rdkvfwupdater -> iarm : fail status
                    iarm --> mm : fail status
                end
            else same image
                rdkvfwupdater -> iarm : success status
                iarm --> mm : success status
            end
        else parsing fail
            rdkvfwupdater -> iarm : fail status
            iarm --> mm : fail status
        end
    else xconf response fail
        xconfserver --> downloadlib : fail response
        downloadlib --> rdkvfwupdater : fail response
        rdkvfwupdater -> iarm : fail status
        iarm --> mm : fail status
    end
else validation fail
    rdkvfwupdater -> iarm : error status
    iarm --> mm : error status
end
@enduml

1. In above Sequence Diagram Maintenance Manager is parg of rdkservices module. Which is responsible for all the device maintenance activity.
2. rdkvfwupdater is a binary having iarm, rfc and flash app in a single monolithic image.
3. download lib, utils lib and jason parser all 3 are part of common-utilities component. This module will provide all 3 shared library which can link to other module. 

New Refactor Design[WORK IN PROGRESS]

@startuml
participant mm
participant rdkvfwupdater
participant iarmlib #Green
participant rfclib #Green
participant jsonlib #Green
participant upgradelib #Green
participant utilslib #Green
participant downloadlib #Green
participant xconfserver #Yellow
participant parsinglib #Green
participant ssrserver #Yellow
participant flashapp

mm -> rdkvfwupdater : trigger
rdkvfwupdater -> rdkvfwupdater : initial validation
alt validation success
    rdkvfwupdater -> utilslib : get device details
    utilslib --> rdkvfwupdater : device details
    rdkvfwupdater -> rfclib : get rfc data
    rfclib --> rdkvfwupdater : rfc data
    rdkvfwupdater -> jsonlib : create json request
    jsonlib -> parsinglib : generic JSON parse/construct
    parsinglib --> jsonlib : result
    jsonlib --> rdkvfwupdater : json payload
    rdkvfwupdater -> upgradelib : request xconf connection
    upgradelib -> downloadlib : connect to xconf server
    downloadlib -> xconfserver : request
    alt xconf response success
        xconfserver --> downloadlib : success response
        downloadlib --> upgradelib : success response
        upgradelib --> rdkvfwupdater : success response
        rdkvfwupdater -> jsonlib : parse json data
        jsonlib -> parsinglib : generic JSON parse/construct
        parsinglib --> jsonlib : result
        alt parsing success
            jsonlib --> rdkvfwupdater : success response
            rdkvfwupdater -> rdkvfwupdater : process json data
            alt new image different
                rdkvfwupdater -> upgradelib : download image
                upgradelib -> downloadlib : download image
                downloadlib -> ssrserver : request
                ssrserver --> downloadlib : server status
                alt server status 0
                    downloadlib --> upgradelib : success response
                    upgradelib --> rdkvfwupdater : success response
                    rdkvfwupdater -> flashapp : flash image
                    flashapp --> rdkvfwupdater : flash status
                    rdkvfwupdater -> iarmlib : success status
                    iarmlib --> mm : success status
                else server status 18 or 28
                    downloadlib --> upgradelib : chunkdownload
                    upgradelib --> rdkvfwupdater : chunkdownload
                    rdkvfwupdater -> flashapp : flash image
                    flashapp --> rdkvfwupdater : flash status
                    rdkvfwupdater -> iarmlib : success status
                    iarmlib --> mm : success status
                else server status 58
                    rdkvfwupdater -> rdkvfwupdater : recovery download
                else other server status
                    downloadlib --> upgradelib : retry download
                    upgradelib --> rdkvfwupdater : retry download
                    rdkvfwupdater -> iarmlib : fail status
                    iarmlib --> mm : fail status
                end
            else same image
                rdkvfwupdater -> iarmlib : success status
                iarmlib --> mm : success status
            end
        else parsing fail
            rdkvfwupdater -> iarmlib : fail status
            iarmlib --> mm : fail status
        end
    else xconf response fail
        xconfserver --> downloadlib : fail response
        downloadlib --> upgradelib : fail response
        upgradelib --> rdkvfwupdater : fail response
        rdkvfwupdater -> iarmlib : fail status
        iarmlib --> mm : fail status
    end
else validation fail
    rdkvfwupdater -> iarmlib : error status
    iarmlib --> mm : error status
end
@enduml