RDKCOM-5496: RDKBDEV-3335 Add Vlan Bridging Manager Documentation#30
RDKCOM-5496: RDKBDEV-3335 Add Vlan Bridging Manager Documentation#30raslam930 wants to merge 6 commits into
Conversation
pradeeptakdas
changed the title
|
Hi @guto86 , @johnsonsebastiar Can you please review and merge this PR? |
|
Hi @guto86 |
|
Hi @guto86 . @S-Parthiban-Selvaraj Can you please merge this PR if you are happy? |
raslam930
force-pushed
the
feature/RDKBDEV-3335
branch
from
3e35aa2 to
bdc51f3
Compare
|
Hi Bhanu, As per @S-Parthiban-Selvaraj input, please move the documentation to the docs folder. If the docs folder does not already exist in the component, please create it. |
|
Hi @S-Parthiban-Selvaraj @pradeeptakdas |
| @@ -0,0 +1,499 @@ | |||
| # VLAN Manager | |||
There was a problem hiding this comment.
can you make it vlan and bridging manager? and mention responsible for both valn and bridge creation.
There was a problem hiding this comment.
Updated the title from # VLAN Manager to # VLAN and Bridging Manager. The opening description paragraph has been updated to explicitly state that the component is responsible for both VLAN creation and bridge creation. References to "VLAN Manager" throughout the introductory paragraphs have been updated to "VLAN and Bridging Manager" to reflect the broader scope of the component.
|
|
||
| **Build-Time Flags and Configuration:** | ||
|
|
||
| | Flag | Description | Source Files | |
There was a problem hiding this comment.
Most of the build flags are dormant and moved from legacy EthAgnt. We will do a cleanup soon. Lets not mention this list
There was a problem hiding this comment.
Removed the entire Build-Time Flags and Configuration section, including the table listing all compile-time flags (VLAN_MANAGER_HAL_ENABLED, COMCAST_VLAN_HAL_ENABLED, WAN_MANAGER_UNIFICATION_ENABLED, ENABLE_WANMODECHANGE_NOREBOOT, FEATURE_MAPT, FEATURE_SUPPORT_RDKLOG, ENABLE_SD_NOTIFY, INCLUDE_BREAKPAD, BRIDGE_UTILS_BIN). These flags are largely dormant and were carried over from the legacy EthAgent component. The section will be re-introduced after the planned cleanup is complete.
| | TR-069 Parameter Agent | TR-181 parameter get/set operations, configuration management | `GetParameterValues`, `SetParameterValues`, `GetParameterNames` | | ||
| | PSM (Persistent Storage Manager) | VLAN configuration persistence, parameter storage | `PSM_Set_Record_Value2`, `PSM_Get_Record_Value2` | | ||
| | WAN Manager | WAN interface VLAN configuration, status synchronization | `Device.X_RDK_WanManager.CPEInterface.{i}.*` | | ||
| | Bridge Manager | L2 bridge VLAN membership, port configuration | `Device.X_RDK_BridgingManager.*` events | |
There was a problem hiding this comment.
Do we have a bridge manager?
There was a problem hiding this comment.
We do not currently have a standalone Bridge Manager component. Removed the Bridge Manager row from the Component Interactions matrix (which referenced Device.X_RDK_BridgingManager.*) and removed Bridge Manager from the subscriber lists in the events published by VLAN Manager (VLANInterface.Created and EthernetLink.StatusChange). Additionally, removed the Sub2 as Bridge Manager participant and its related message lines from the mermaid sequence diagram in the IPC Event Notification Flow section. These references were inaccurate and could cause confusion for anyone reviewing the integration surface.
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds a comprehensive README documenting the VLAN and Bridging Manager component, including architecture diagrams, TR-181 data model details, and operational flows.
Changes:
- Introduces high-level component overview and design documentation with Mermaid diagrams
- Documents TR-181 object hierarchy and parameter tables
- Describes dependencies, threading model, lifecycle/state flows, and HAL integration points
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| PluginMain["Plugin Main"] | ||
| end | ||
|
|
||
| subgraph BusinessLofic ["Business Logic Layer"] |
There was a problem hiding this comment.
Fixed the typo — BusinessLofic corrected to BusinessLogic in the Mermaid architecture diagram subgraph identifier and label.
| | Parameter Path | Data Type | Access | Default Value | Description | BBF Compliance | | ||
| | ---------------------------------------------------- | --------- | ------ | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | | ||
| | `Device.X_RDK_Ethernet.Link.{i}.Enable` | boolean | R/W | `true` | Enables or disables the Ethernet link interface. When disabled, the interface is administratively down and no traffic is forwarded. Setting to false triggers interface shutdown procedures. | Custom Extension | |
There was a problem hiding this comment.
The section header rows | RDK-B Middleware Components | and | System & HAL Layers | in the Interaction Matrix table only had one cell in a 3-column table, causing malformed rendering in strict Markdown renderers. Fixed by adding the two missing empty cells to each row: | RDK-B Middleware Components | | | and | System & HAL Layers | | |.
| │ ├── LowerLayers (string, R/W) | ||
| │ ├── X_RDK_BaseInterface (string, R/W) | ||
| │ ├── MACAddress (string, R) | ||
| │ ├── MACAddrOffSet (unsignedInt, R) |
There was a problem hiding this comment.
Verified against the source code — MACAddrOffSet (capital S) is the exact name used throughout the implementation: ethernet_dml.c (DML get/set handlers use strcmp(ParamName, "MACAddrOffSet")), ethernet_apis.h (struct field MACAddrOffSet), vlan_apis.c, ethernet_apis.c, and RdkVlanManager.xml. No change needed; the documentation is accurate.
|
hi @S-Parthiban-Selvaraj , fixed the changes that you have suggested and updated PR at 4ca98ee could you please check this? |
|
Hi @S-Parthiban-Selvaraj , @guto86 , |
[https://jira.rdkcentral.com/jira/browse/RDKBDEV-3335]
Reason for Change:
To add Component Documentation for Vlan Bridging Manager
Fix:
Added the documentation
Test Procedure:
None
Signed-off-by: Raheen Aslam [raheen_aslam@comcast.com]