...

Table of Contents

Introduction

          The scope of this document is to capture the details for This page describes  the  bring-up the of RdkWanManager on Raspberry-pi platform using  rdk-next branch. This
document also captures Also, we captured  list of the issues that are faced during bring up and resolution for the same. 

RPI Build Steps 

Please refer the below link for host environment set-up & flashing procedure for yocto build ,

Dunfell :

RPI 3B/3B+ Model Reference Platform

Morty:

RDK-B Raspberrypi - Host SetUp and Build Instructions#BRaspberrypi-HostSetUpandBuildInstructions-YoctoBuildSteps

Repo Steps

To build, follow below instructions

Components

The following components are newly introduced for Porting of  RdkWanManager in RPI Target Platform ,

•  RdkWanManager 
• JSON RPC

The following  are the dependent components & meta-layers which are modified, 

• Utopia 
• PandM 
• LogAgent
• CcspCommonLibrary 
• meta-rdk-broadband 
• meta-cmf-broadband 
• CcspEthAgent
• JSON ETHSW
• rdk_logger
• meta-cmf-raspberrypi

RPI Build Steps 

Please refer the below link for host environment set-up & flashing procedure for yocto build ,

Dunfell :

RPI 3B/3B+ Model Reference Platform

Morty:

RDK-B Raspberrypi - Host SetUp and Build Instructions#BRaspberrypi-HostSetUpandBuildInstructions-YoctoBuildSteps

Repo Steps

To  build, follow below instructions

$ mkdir <workspace dir>

$ cd <workspace dir>
$ repo init -u https://code.rdkcentral.com/r/manifests -b dunfell -m rdkb-extsrc.xml 
$ repo sync -j`nproc` --no-clone-bundle

...

$ mkdir <workspace dir>
$ cd 

<workspace dir>
$ repo 

init 

-u https://code.rdkcentral.com/r/manifests -b rdk-next -m rdkb-extsrc.xml
$ repo sync -j`nproc` --no-clone-bundle

WanManager Bug Fixes

$ rdkb/components/opensource/ccsp/CcspEthAgent refs/changes/98/58898/2 && git cherry-pick FETCH_HEAD

$ cd ~/rdkb/components/generic/json-rpcopensource/ccsp/CcspEthAgent
$ git fetch https://code.rdkcentral.com/r/rdkb/components/opensource/genericccsp/json-rpcCcspEthAgent refs/changes/9198/5889158898/12 && git cherry-pick FETCH_HEAD

$ cd ~/rdkrdkb/components/generic/rdk_loggerjson-rpc
$ git fetch https://code.rdkcentral.com/r/rdkrdkb/components/generic/rdk_logger json-rpc refs/changes/91/58891/1 && git cherry-pick FETCH_HEAD

$ cd ~/rdk/components/generic/rdk_logger
$ git fetch https://code.rdkcentral.com/r/rdk/components/generic/rdk_logger refs/changes/85/58885/1 && git cherry-pick FETCH_HEAD

$ cd ~/rdkb/components/opensource/ccsp/CcspPandM
$ git fetch https://code.rdkcentral.com/r/rdkb/components/opensource/ccsp/CcspPandM refs/changes/51/58951/1 && git cherry-pick FETCH_HEAD

$ cd ~/meta-cmf-broadband
$ git fetch https://code.rdkcentral.com/r/rdk/components/generic/rdk-oe/meta-cmf-broadband refs/changes/65/58865/2 && git cherry-pick FETCH_HEAD

$ cd ~/meta-cmf-raspberrypi
$ git fetch https://code.rdkcentral.com/r/rdk/components/generic/rdk-oe/meta-cmf-raspberrypi refs/changes/26/59026/2 && git cherry-pick FETCH_HEAD

Note :Note : The above bug fixes changes are temporary given as instructions. This is not required once the change is gets merged into the appropriate repo.

Distro Features

We are using the following distro features to enable rdkb wanmanager . Please add the following distro features into OEM machine configuration file,

• rdkb_wan_manager : Used to enable RDK WanManager and json hal

Please open the below rpi machine configuration file and add the following line in that file .

...

 $ vi ~/meta-cmf-raspberrypi/conf/machine/raspberrypi-rdk-broadband.conf

DISTRO_FEATURES_append = "  rdkb_wan_manager"

Build steps

$ MACHINE=raspberrypi-rdk-broadband source meta-cmf-raspberrypi/setup-environment
$ bitbake rdk-generic-broadband-image

We will get the following rdk-wanmanager compilation errors While bitbaking the target image,

../../../git/source/WanManager/wanmgr_interface_sm.c:720:62: error: macro "LOG_CONSOLE" passed 3 arguments, but takes just 0
         LOG_CONSOLE("%s Wan_init_complete:%d\n",buffer,uptime);
                                                              ^
../../../git/source/WanManager/wanmgr_interface_sm.c:720:9: error: 'LOG_CONSOLE' undeclared (first use in this function)
         LOG_CONSOLE("%s Wan_init_complete:%d\n",buffer,uptime);
         ^~~~~~~~~~~

Also , we need to disable the GwProvapp-EthWan component in ccsp packagegroup . For that, please open the below file and add the following line in that file ,

...

$ vi ~/meta-cmf-raspberrypi/recipes-core/packagegroups/packagegroup-rdk-ccsp-broadband.bbappend

GWPROVAPP = ""

Note :  The above distro changes are temporary given as instructions. This is not required once the change is gets merged into the appropriate repo.

...

$ MACHINE= cd ~/build-raspberrypi-rdk-broadband source meta-cmf-raspberrypi/setup-environment
$ bitbake rdk-generic-broadband-image

We will get the following rdk-wanmanager compilation errors While bitbaking the target image,

../../../git/source/WanManager/wanmgr_interface_sm.c:720:62: error: macro "LOG_CONSOLE" passed 3 arguments, but takes just 0
         LOG_CONSOLE("%s Wan_init_complete:%d\n",buffer,uptime);
                                                              ^
../../../git/source/WanManager/wanmgr_interface_sm.c:720:9: error: 'LOG_CONSOLE' undeclared (first use in this function)
         LOG_CONSOLE("%s Wan_init_complete:%d\n",buffer,uptime);
         ^~~~~~~~~~~

/tmp/work/cortexa7t2hf-neon-vfpv4-rdk-linux-gnueabi/rdk-wanmanager/1.99+gitAUTOINC+b6db33d891-r0/git/source
$ git fetch https://code.rdkcentral.com/r/rdkb/components/opensource/ccsp/RdkWanManager refs/changes/00/58500/2 && git cherry-pick FETCH_HEAD

$ bitbake rdk-wanmanager -c compile -f
$ bitbake  rdk-generic-broadband-image

Note: The above bug fixes changes are temporary given as instructions. This is not required once the change is gets merged into the appropriate repo.

Control Flow

Following diagram depicts the flow of control among the components,

• Eth Hal will configure interface and monitor the link. CcspEthAgent will subscribe for ‘EthInterfaceStatus’ event so that it can receive the notification form Vendor Software (i.e. Eth Hal)
  whenever physical link event change.
• CcspEthAgent will pass the link change event to Wan Manager,
                     It will set the value for Wan Manger DM ‘Device.X_RDK_WanManager.CPEInterface.1.Wan.LinkStatus’  

Approach

Integration Approach

Manifest Changes

<project name="

$ cd ~/build-raspberrypi-rdk-broadband/tmp/work/cortexa7t2hf-neon-vfpv4-rdk-linux-gnueabi/rdk-wanmanager/1.99+gitAUTOINC+b6db33d891-r0/git/source
$ git fetch https://code.rdkcentral.com/r/rdkb/components/opensource/ccsp/RdkWanManager refs/changes/00/58500/2 && git cherry-pick FETCH_HEAD

$ bitbake rdk-wanmanager -c compile -f
$ bitbake  rdk-generic-broadband-image

Note: The above bug fixes changes are temporary given as instructions. This is not required once the change is gets merged into the appropriate repo.

Components

The following components are newly introduced for Porting of  RdkWanManager in RPI Target Platform ,

•  RdkWanManager 
• JSON RPC

The following  are the existing components which are modified, 

• Utopia 
• PandM 
• LogAgent
• CcspCommonLibrary 
• meta-rdk-broadband 
• meta-cmf-broadband 
• CcspEthAgent
• JSON ETHSW
• rdk_logger
• meta-cmf-raspberrypi

Control Flow

Following diagram depicts the flow of control among the components,

• Eth Hal will configure interface and monitor the link. CcspEthAgent will subscribe for ‘EthInterfaceStatus’ event so that it can receive the notification form Vendor Software (i.e. Eth Hal)
  whenever physical link event change.
• CcspEthAgent will pass the link change event to Wan Manager,
                     It will set the value for Wan Manger DM ‘Device.X_RDK_WanManager.CPEInterface.1.Wan.LinkStatus’  

Approach

Integration Approach

Manifest Changes

<project name="rdkb/components/opensource/ccsp/RdkWanManager" revision="rdk-next"/>
<project name="rdkb/components/generic/json-rpc" revision="rdk-next"/>

Note :  RdkWanManager Project will be added in RPI Manifest , Once the RdkWanManager Compilation error changes are merged in rdk-next(58500) 

Global CFLAGS

• FEATURE_RDKB_WANMANAGER is the global CFLAG used in other components to use with WANMANAGER feature.
• All the changes are enclosed inside FEATURE_RDKB_WAN_MANAGER compilation flag, this CFLAG can be used to control whether or not to
  compile the WanManager code changes.

We enabled WanManager CFLAGS in below file in rpi(meta-cmf-raspberrypi) layer,

...

...

" revision="rdk-next"/>
<project name="rdkb/components/generic/json-rpc" revision="rdk-next"/>

Note :  RdkWanManager Project will be added in RPI Manifest , Once the RdkWanManager Compilation error changes are merged in rdk-next(58500) 

Global CFLAGS

• FEATURE_RDKB_WANMANAGER is the global CFLAG used in other components to use with WANMANAGER feature.
• All the changes are enclosed inside FEATURE_RDKB_WAN_MANAGER compilation flag, this CFLAG can be used to control whether or not to
  compile the WanManager code changes.

We enabled WanManager CFLAGS in below file in rpi(meta-cmf-raspberrypi) layer,

CFLAGS_append += "${@bb.utils.contains('DISTRO_FEATURES', 'rdkb_wan_manager', ' -DFEATURE_RDKB_WAN_MANAGER ', '', d)}"

Distro Features

We are using the following distro features to enable rdkb wanmanager in RPI machine configuration file,

• rdkb_wan_manager : Used to enable RDK WanManager and json hal

DISTRO_FEATURES_append = "  rdkb_wan_manager"

Also , we need to disable the GwProvapp-EthWan component in ccsp packagegroup . 

GWPROVAPP = ""

Package Group

To enable the RDKB Wanmanager components, added those components into the final build target.  So, We have added those components into the  ccsp packagegroup(58865),

RDEPENDS_packagegroup-rdk-ccsp-broadband_append = " ${@bb.utils.contains('DISTRO_FEATURES', 'rdkb_wan_manager', ' rdk-wanmanager json-hal-lib hal-json-ethsw', '', d)} "

hal-json-ethsw(Eth Hal)

• Eth Hal will configure interface and monitor the link. CcspEthAgent will subscribe for ‘EthInterfaceStatus’ event so that it can receive the notification form Vendor Software (i.e. Eth Hal)whenever physical link event change.
• JSON HAL server library can be used by the vendor application to receive actions from RDK WanManager application and do necessary action. The vendor application that has HAL server library integrated will receive the JSON rpc request from the RDK WanManager, process the request and sends the JSON based response back to the RDK WanManager. The HAL server also helps to dispatch asynchronous events to the RDK WanManager based on the event subscription.

• Recipe-path for JSON HAL server(58865)

  $  ~/meta-cmf-broadband/recipes-ccsp/hal/hal-json-ethsw.bb

  
  

Utopia CFLAG

• To disable the utopia service_wan execution , we need to enable the utopia _WAN_MANAGER_ENABLED_ flag would mean that the RdkWanManager controls the Wan Management.   

  
  

  Code Block
  language bash title utopia.bbappend
  CFLAGS_append += "${@bb.utils.contains('DISTRO_FEATURES', 'rdkb_wan_manager', ' -

...

• D_

...

• WAN_MANAGER

...

• _ENABLED_', '', d)}"

Package Group

To enable the RDKB Wanmanager components, added those components into the final build target.  So, We have added those components into the  ccsp packagegroup(58865),

RDEPENDS_packagegroup-rdk-ccsp-broadband_append = " ${@bb.utils.contains('DISTRO_FEATURES', 'rdkb_wan_manager', ' rdk-wanmanager json-hal-lib hal-json-ethsw', '', d)} "

hal-json-ethsw(Eth Hal)

...

Persistent (PSM) configuration changes

For wanmanager, the default configurations are stored in PSM. As of now, we have 1 interfaces defined for WAN in wanmanager modules (i,e) wanoe.

For WANOE, by default we are using `eth0 `port for WAN connection. 

Example PSM Configurations

Recipe-path for JSON HAL server

...

Utopia CFLAG

• To disable the utopia service_wan execution , we need to enable the utopia _WAN_MANAGER_ENABLED_ flag would mean that the RdkWanManager controls the Wan Management.                         

Persistent (PSM) configuration changes

For wanmanager, the default configurations are stored in PSM. As of now, we have 1 interfaces defined for WAN in wanmanager modules (i,e) wanoe.

For WANOE, by default we are using `eth0 `port for WAN connection. 

...

<Record name=""dmsb.wanmanager.if.2.Name"" type=""astr"">eth0</Record>

Example PSM Configurations

Errors and Challenges in yocto

Major Errors and Challenges 

...

Validation Test Results

• Flash the latest generated build
• Goto RG console

erouter0 IPv4 address

                    erouter0 should have valid IP based on the wan configuration (Eg 192.168.0.11/24)

Image Added

brlan0 IPv4 Address

                         brlan0 IPv4 should be 10.0.0.1 ( i,e Default IP Address )

Image Added

Able to take SSH from WAN IP

                     ssh from WAN to eRouter IP should be successful

Image Added

Image Added

Internet Testing on RPI

•  erouter0 Interface should have Ipv4 Address
• verify the ping www.google.com on RPI
• RPI shouldn't lose the Internet

Image Added

LAN client IPv4 and Internet 

                   Lan clients should get IPv4 address in the range of 10 series(i,e default DHCP server pool range) and captive portal page should be loaded.

Image Added

Image Added

CCSP Process Status

                All ccsp process should be Up and corresponding DataModel parameters should be loaded properly.

Image Added

RdkWanManager systemd Status

•   RdkWanManager process should be up . We can verify the status by using the below screenshot command,

Image Added

• RdkWanManager  DataModel Parameters should be loaded properly, we can use the below command to verify the status, 

Image Added 

WanManager Logs

                 WanManager logs will be generated in /rdklogs/logs folder in RPI

Image Added

Systemd Status

          Following systemd service file's status needs to be verfiy,

1.  hal-json-ethsw
2.  utopia
3.  CcspEthAgent
4. CcspPandMSsp

Image Added

Image Added

Image Added

Image Added

Image Added

Using dmcli commands to verify the LinkStatus(CcspEthAgent will pass the LinkStatus to WanManager )

Image Added

Image Added

WebUI Test on RPI

                 WebUI should be loaded in Webbrowser by using erouter0 IPv4 Address(i,e erouter0ip:8080) and login should be successful

Image Added

Internet check should be successful,

Image Added

Known Issues

              Sometimes , erouter0 interface is not getting the WAN IP .