Introduction
OpenSync :
- OpenSync is designed to provide a Software Defined Network (SDN) platform, through which it virtualizes the networking and wireless management for easy service roll-out. It acts as a silicon, CPE, and cloud-agnostic connection between in-home hardware devices and the cloud.
- It provides a modern set of utilities for collecting measurement and other telemetry data from devices. It also enables remote control and management of the devices, and advanced capabilities for specific services, including Wi-Fi meshing, access control, cybersecurity,
parental controls, and IoT onboarding and telemetry.
OneWiFi :
- The purpose of OneWifi project is to create a unified software architecture that preserves control plane and stats level functionality but is capable of running on both gateways and extenders.
Scope of the work
The scope of this activity to bring up Mesh functionality through opensync and onewifi components in RPI Router.
Target Audience
- RDK-B Operators
- RDK-B SoC Vendors
- RDK-B OEM's
- RDK-B Application Vendors(Plume)
- RDK-B System Integrators
High level Design / Architecture
eyJleHRTcnZJbnRlZ1R5cGUiOiIiLCJnQ2xpZW50SWQiOiIiLCJjcmVhdG9yTmFtZSI6IlVua25vd24gVXNlciAoa2VlcnRoYW5hLnApIiwib3V0cHV0VHlwZSI6ImJsb2NrIiwibGFzdE1vZGlmaWVyTmFtZSI6IlVua25vd24gVXNlciAoa2VlcnRoYW5hLnApIiwibGFuZ3VhZ2UiOiJlbiIsInVpQ29uZmlnIjoie30iLCJkaWFncmFtRGlzcGxheU5hbWUiOiIiLCJzRmlsZUlkIjoiIiwiYXR0SWQiOiIyOTIzMzg4NjkiLCJkaWFncmFtTmFtZSI6Ik9wZW5TeW5jX0FyY2hpdGVjdHVyZSIsImFzcGVjdCI6IiIsImxpbmtzIjoiYXV0byIsImNlb05hbWUiOiJPcGVuU3luYyA0LjQgd2l0aCBPbmVXaUZpIiwidGJzdHlsZSI6InRvcCIsImNhbkNvbW1lbnQiOmZhbHNlLCJkaWFncmFtVXJsIjoiIiwiY3N2RmlsZVVybCI6IiIsImJvcmRlciI6dHJ1ZSwibWF4U2NhbGUiOiIxIiwib3duaW5nUGFnZUlkIjoyODgwMDA1NjUsImVkaXRhYmxlIjpmYWxzZSwiY2VvSWQiOjI4ODAwMDU2NSwicGFnZUlkIjoiIiwibGJveCI6dHJ1ZSwic2VydmVyQ29uZmlnIjp7ImVtYWlscHJldmlldyI6IjEifSwib2RyaXZlSWQiOiIiLCJyZXZpc2lvbiI6MiwibWFjcm9JZCI6IjE4NTE0MWRhLWY5ZGMtNDYyYy04ZmNlLTljMmJhZjg2MzJiNiIsInByZXZpZXdOYW1lIjoiT3BlblN5bmNfQXJjaGl0ZWN0dXJlLnBuZyIsImxpY2Vuc2VTdGF0dXMiOiJPSyIsInNlcnZpY2UiOiIiLCJpc1RlbXBsYXRlIjoiIiwid2lkdGgiOiIxMDgxIiwic2ltcGxlVmlld2VyIjpmYWxzZSwibGFzdE1vZGlmaWVkIjoxNzAzMDczMDE3MDAwLCJleGNlZWRQYWdlV2lkdGgiOmZhbHNlLCJvQ2xpZW50SWQiOiIifQ==
System Architecture
eyJleHRTcnZJbnRlZ1R5cGUiOiIiLCJnQ2xpZW50SWQiOiIiLCJjcmVhdG9yTmFtZSI6IlVua25vd24gVXNlciAoa2VlcnRoYW5hLnApIiwib3V0cHV0VHlwZSI6ImJsb2NrIiwibGFzdE1vZGlmaWVyTmFtZSI6IlVua25vd24gVXNlciAoa2VlcnRoYW5hLnApIiwibGFuZ3VhZ2UiOiJlbiIsInVpQ29uZmlnIjoie30iLCJkaWFncmFtRGlzcGxheU5hbWUiOiIiLCJzRmlsZUlkIjoiIiwiYXR0SWQiOiIyOTIzMzg4NzciLCJkaWFncmFtTmFtZSI6IlN5c3RlbSBBcmNoaXRlY3R1cmUiLCJhc3BlY3QiOiIiLCJsaW5rcyI6ImF1dG8iLCJjZW9OYW1lIjoiT3BlblN5bmMgNC40IHdpdGggT25lV2lGaSIsInRic3R5bGUiOiJ0b3AiLCJjYW5Db21tZW50IjpmYWxzZSwiZGlhZ3JhbVVybCI6IiIsImNzdkZpbGVVcmwiOiIiLCJib3JkZXIiOnRydWUsIm1heFNjYWxlIjoiMSIsIm93bmluZ1BhZ2VJZCI6Mjg4MDAwNTY1LCJlZGl0YWJsZSI6ZmFsc2UsImNlb0lkIjoyODgwMDA1NjUsInBhZ2VJZCI6IiIsImxib3giOnRydWUsInNlcnZlckNvbmZpZyI6eyJlbWFpbHByZXZpZXciOiIxIn0sIm9kcml2ZUlkIjoiIiwicmV2aXNpb24iOjMsIm1hY3JvSWQiOiIyZjNiZDQ1Ny0yZWZkLTRjMWItODQ5OC05MmQyMzhiMmUyOWUiLCJwcmV2aWV3TmFtZSI6IlN5c3RlbSBBcmNoaXRlY3R1cmUucG5nIiwibGljZW5zZVN0YXR1cyI6Ik9LIiwic2VydmljZSI6IiIsImlzVGVtcGxhdGUiOiIiLCJ3aWR0aCI6IjUwMSIsInNpbXBsZVZpZXdlciI6ZmFsc2UsImxhc3RNb2RpZmllZCI6MTcwMzA3MzA1ODAwMCwiZXhjZWVkUGFnZVdpZHRoIjpmYWxzZSwib0NsaWVudElkIjoiIn0=
OVSDB Manager
Cloud controller can configure Wi-Fi parameters in gateway, extender or CPE using OVSDB & Manager entities. OVSDB is a database server that executes in RDK-B CPE. Any update of parameters in this database by cloud controller is notified to OneWifi process by OVSDB manager entity over RBUS. OneWifi process validates the parameter or set of parameters and applies the configuration in WiFi driver or baseband. If successfully applied, OneWifi also notifies OVSDB manager about the successful completion so that the database tables are updated with the right state of WiFi subsystem of the CPE.
OneWiFi Interface Map Table
VAP Index | Name | Comment |
---|
1 | private_ssid_2g | 2g user private ssid |
2 | private_ssid_5g | 5g user private ssid |
12 | mesh_backhaul_2g | Mesh backhaul on 2g |
13 | mesh_backhaul_5g | Mesh backhaul on 5g |
14 | mesh_sta_2g | Mesh station on 2g |
15 | mesh_sta_5g | Mesh station on 5g |
Target Build Variant
- RPI4 Kirkstone build with kernel 5.15
Identified task list
Need to learn how OpenSync work with OneWiFi - Communication is through DM/RBUS, not wifi hal. May need to refer Comcast device.
Need to compile OpenSync for OneWifi (some kconfig should be enabled)
Need to know how to start OpenSync through OneWiFi
Need to know OVSDB tables of OpenSync collaborate with OVSDB tables of OneWiFi(wifi.db)
Bringup OVSDB manager for synchronization
Wi-Fi interface alignment with Netgear wifi dongle and Make sure existing wifi functionality won't be disturbed.
Netgear driver support with Kirkstone version
Conversion of Linux bridge into OVS bridge(brlan0) - OVSAgent is now part of rootfs but not operational
Update dnsmasq configuration for OpenSync backhaul AP feature (wifi2, wifi3)
Enable IP_GRE as kernel module
Home AP bringup in RPI GW
Backhaul AP bringup in RPI GW
Make sure that GRE tunnel is created for backhaul communication and it is stable (Need to be tested with Extender)
Need to make sure that onewifi existing functionality is not breaking
Check point
Dependencies
Dongle's minimal support for 2AP and 1 STA.
If Netgear dongle is not providing such support, need to find new WiFi dongle.
Device provisioning in Plume Inventory (require Plume's support)
- ovsdb manager/OVSM acts as medium between onewifi webconfig subdoc and plume controller
- OpenSync have run-time dependencies with ovsdb-server & openvswitch(ovsdb-server start up is part of ovsagent . currently, this server is not running in rpi).
Validation
Risks
- Availability of OVSM for RDK Community is mandatory
- Wireless interface names for Wifi dongle needs to be aligned for OpenSync convention
Flow Diagram/Pseudo Code
eyJleHRTcnZJbnRlZ1R5cGUiOiIiLCJnQ2xpZW50SWQiOiIiLCJjcmVhdG9yTmFtZSI6IlVua25vd24gVXNlciAoa2VlcnRoYW5hLnApIiwib3V0cHV0VHlwZSI6ImJsb2NrIiwibGFzdE1vZGlmaWVyTmFtZSI6IlVua25vd24gVXNlciAoa2VlcnRoYW5hLnApIiwibGFuZ3VhZ2UiOiJlbiIsInVpQ29uZmlnIjoie30iLCJkaWFncmFtRGlzcGxheU5hbWUiOiIiLCJzRmlsZUlkIjoiIiwiYXR0SWQiOiIzMDY0MjA3MzMiLCJkaWFncmFtTmFtZSI6ImZsb3ciLCJhc3BlY3QiOiIiLCJsaW5rcyI6ImF1dG8iLCJjZW9OYW1lIjoiT3BlblN5bmMgNC40IHdpdGggT25lV2lGaSIsInRic3R5bGUiOiJ0b3AiLCJjYW5Db21tZW50IjpmYWxzZSwiZGlhZ3JhbVVybCI6IiIsImNzdkZpbGVVcmwiOiIiLCJib3JkZXIiOnRydWUsIm1heFNjYWxlIjoiMSIsIm93bmluZ1BhZ2VJZCI6Mjg4MDAwNTY1LCJlZGl0YWJsZSI6ZmFsc2UsImNlb0lkIjoyODgwMDA1NjUsInBhZ2VJZCI6IiIsImxib3giOnRydWUsInNlcnZlckNvbmZpZyI6eyJlbWFpbHByZXZpZXciOiIxIn0sIm9kcml2ZUlkIjoiIiwicmV2aXNpb24iOjQsIm1hY3JvSWQiOiI0OWJjOWYzMC01MzMwLTQxZjYtYTk5Yi0yODM3NjkxZjkzZDciLCJwcmV2aWV3TmFtZSI6ImZsb3cucG5nIiwibGljZW5zZVN0YXR1cyI6Ik9LIiwic2VydmljZSI6IiIsImlzVGVtcGxhdGUiOiIiLCJ3aWR0aCI6Ijc4MSIsInNpbXBsZVZpZXdlciI6ZmFsc2UsImxhc3RNb2RpZmllZCI6MTcwNzIyMTM5NDAwMCwiZXhjZWVkUGFnZVdpZHRoIjpmYWxzZSwib0NsaWVudElkIjoiIn0=
Sequence Diagrams
eyJleHRTcnZJbnRlZ1R5cGUiOiIiLCJnQ2xpZW50SWQiOiIiLCJjcmVhdG9yTmFtZSI6IlVua25vd24gVXNlciAoa2VlcnRoYW5hLnApIiwib3V0cHV0VHlwZSI6ImJsb2NrIiwibGFzdE1vZGlmaWVyTmFtZSI6IlVua25vd24gVXNlciAoa2VlcnRoYW5hLnApIiwibGFuZ3VhZ2UiOiJlbiIsInVpQ29uZmlnIjoie30iLCJkaWFncmFtRGlzcGxheU5hbWUiOiIiLCJzRmlsZUlkIjoiIiwiYXR0SWQiOiIzMDY0MTk5MTIiLCJkaWFncmFtTmFtZSI6IlNlcXVlbmNlIGRpYWdyYW0iLCJhc3BlY3QiOiIiLCJsaW5rcyI6ImF1dG8iLCJjZW9OYW1lIjoiT3BlblN5bmMgNC40IHdpdGggT25lV2lGaSIsInRic3R5bGUiOiJ0b3AiLCJjYW5Db21tZW50IjpmYWxzZSwiZGlhZ3JhbVVybCI6IiIsImNzdkZpbGVVcmwiOiIiLCJib3JkZXIiOnRydWUsIm1heFNjYWxlIjoiMSIsIm93bmluZ1BhZ2VJZCI6Mjg4MDAwNTY1LCJlZGl0YWJsZSI6ZmFsc2UsImNlb0lkIjoyODgwMDA1NjUsInBhZ2VJZCI6IiIsImxib3giOnRydWUsInNlcnZlckNvbmZpZyI6eyJlbWFpbHByZXZpZXciOiIxIn0sIm9kcml2ZUlkIjoiIiwicmV2aXNpb24iOjQsIm1hY3JvSWQiOiI1MDI1MGUzNi02ZjM2LTRmNjQtOWU0OS05ODIzNzc0OTc5ODAiLCJwcmV2aWV3TmFtZSI6IlNlcXVlbmNlIGRpYWdyYW0ucG5nIiwibGljZW5zZVN0YXR1cyI6Ik9LIiwic2VydmljZSI6IiIsImlzVGVtcGxhdGUiOiIiLCJ3aWR0aCI6IjExOTIiLCJzaW1wbGVWaWV3ZXIiOmZhbHNlLCJsYXN0TW9kaWZpZWQiOjE3MDcyMDM4MzMwMDAsImV4Y2VlZFBhZ2VXaWR0aCI6ZmFsc2UsIm9DbGllbnRJZCI6IiJ9
Build Instructions
Supported device
- Raspberry Pi4 32 bit
- Raspberry Pi4 64 bit
Use Cases
Sanity Testing
References
https://opensync.atlassian.net/wiki/spaces/OCC/pages/39920173081/OpenSync+4.4
Onewifi Reference Porting Documentation
Porting Guide - OneWifi
EPIC/User Stories
Key
|
Summary
|
T
|
Created
|
Updated
|
Due
|
Assignee
|
Reporter
|
P
|
Status
|
Resolution
|