# broadcom-network-switching-software/openfirmware architecture

> Architecture diagram of the GitHub repository broadcom-network-switching-software/openfirmware, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-03-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/broadcom-network-switching-software/openfirmware
- Repository: https://github.com/broadcom-network-switching-software/openfirmware

## Overview

##### Main Components
- Firmware Repository (root node)
- Four primary firmware types:
- BFD
- BroadSync
- IFA1.1
- MOD
- Under each firmware type, further nodes represent the supported device families (e.g., BCM56870, BCM56980 for BFD; BCM56070, BCM88270, etc. for BroadSync; and so on).
- Within each device family node, additional nodes for the firmware version directories (e.g., “4.3.12”, “4.4.0”, “4.3.15”, etc.).
- File nodes under version directories for:
- Firmware binary files (.srec)
- Release notes (release_notes.txt)

##### Relationships and Interactions
- That the Repository “branches” into the four main firmware types.
- That release notes tie back to each firmware version and, by extension, each device family.
- Optionally, include a separate node for “License” information that applies globally.

##### Architectural Patterns and Design Principles
- Use grouping and nesting to represent version control and device family support.

##### Detailed Elements to be Included
- A root node labeled “OpenFirmware Repository.”
- Four main child nodes branching out under the root with labels BFD, BroadSync, IFA1.1, and MOD.
- Under each firmware category, add child nodes for each device family available in that category (e.g., under BFD include BCM56870 and BCM56980).
- Under each device family, further nest nodes for each version directory with its respective files:
- For instance, under BFD → BCM56870, nodes for “4.3.12” (containing BCM56870_0_bfd.srec and release_notes.txt) and “4.4.0”, etc.
- An external node or note for “License.txt” to remind users that licensing terms apply repository-wide.

## Diagram (Mermaid)

```mermaid
flowchart TD
    repo["OpenFirmware Repository"]
    doc1["License.txt"]
    doc2["README.md"]
    
    repo --> doc1
    repo --> doc2
    repo --> bfd["BFD"]
    repo --> bs["BroadSync"]
    repo --> ifa["IFA1.1"]
    repo --> mod["MOD"]
    
    %% BFD Subgraph
    subgraph "BFD Firmware"
        bfd_bcm56870["BCM56870"]
        bfd_bcm56980["BCM56980"]
        
        bfd --> bfd_bcm56870
        bfd --> bfd_bcm56980
        
        bfd_bcm56870 --> bfd_bcm56870_v4312["4.3.12"]
        bfd_bcm56870_v4312 --> bfd_bcm56870_v4312_bin["Firmware (.srec)"]
        bfd_bcm56870_v4312 --> bfd_bcm56870_v4312_rn["release_notes.txt"]
        
        bfd_bcm56980 --> bfd_bcm56980_v4315["4.3.15"]
        bfd_bcm56980_v4315 --> bfd_bcm56980_v4315_bin["Firmware (.srec)"]
        bfd_bcm56980_v4315 --> bfd_bcm56980_v4315_rn["release_notes.txt"]
    end

    %% BroadSync Subgraph
    subgraph "BroadSync Firmware"
        bs_bcm56070["BCM56070"]
        bs_bcm88270["BCM88270"]
        bs_bcm88480["BCM88480"]
        bs_bcm88690["BCM88690"]
        bs_bcm88800["BCM88800"]

        bs --> bs_bcm56070
        bs --> bs_bcm88270
        bs --> bs_bcm88480
        bs --> bs_bcm88690
        bs --> bs_bcm88800
        
        %% BCM56070
        bs_bcm56070 --> bs_bcm56070_v4314["4.3.14"]
        bs_bcm56070_v4314 --> bs_bcm56070_v4314_bin["Firmware (.srec)"]
        bs_bcm56070_v4314 --> bs_bcm56070_v4314_rn["release_notes.txt"]
        
        %% BCM88270
        bs_bcm88270 --> bs_bcm88270_v4318["4.3.8"]
        bs_bcm88270_v4318 --> bs_bcm88270_v4318_bin["Firmware (.srec)"]
        bs_bcm88270_v4318 --> bs_bcm88270_v4318_rn["release_notes.txt"]
        
        %% BCM88480 has two versions
        bs_bcm88480 --> bs_bcm88480_v4313["4.3.13"]
        bs_bcm88480_v4313 --> bs_bcm88480_v4313_bin["Firmware (.srec)"]
        bs_bcm88480_v4313 --> bs_bcm88480_v4313_rn["release_notes.txt"]
        
        bs_bcm88480 --> bs_bcm88480_v4316["4.3.16"]
        bs_bcm88480_v4316 --> bs_bcm88480_v4316_bin["Firmware (.srec)"]
        bs_bcm88480_v4316 --> bs_bcm88480_v4316_rn["release_notes.txt"]
        
        %% BCM88690
        bs_bcm88690 --> bs_bcm88690_v43142["4.3.14.2"]
        bs_bcm88690_v43142 --> bs_bcm88690_v43142_bin["Firmware (.srec)"]
        bs_bcm88690_v43142 --> bs_bcm88690_v43142_rn["release_notes.txt"]
        
        %% BCM88800
        bs_bcm88800 --> bs_bcm88800_v4313["4.3.13"]
        bs_bcm88800_v4313 --> bs_bcm88800_v4313_bin["Firmware (.srec)"]
        bs_bcm88800_v4313 --> bs_bcm88800_v4313_rn["release_notes.txt"]
    end

    %% IFA1.1 Subgraph
    subgraph "IFA1.1 Firmware"
        ifa_bcm56870["BCM56870"]
        ifa --> ifa_bcm56870
        
        ifa_bcm56870 --> ifa_bcm56870_v43117["4.3.11.7"]
        ifa_bcm56870_v43117 --> ifa_bcm56870_v43117_bin["Firmware (.srec)"]
        ifa_bcm56870_v43117 --> ifa_bcm56870_v43117_rn["release_notes.txt"]
        
        ifa_bcm56870 --> ifa_bcm56870_v43118["4.3.11.8"]
        ifa_bcm56870_v43118 --> ifa_bcm56870_v43118_bin["Firmware (.srec)"]
        ifa_bcm56870_v43118 --> ifa_bcm56870_v43118_rn["release_notes.txt"]
    end

    %% MOD Subgraph
    subgraph "MOD Firmware"
        mod_bcm56870["BCM56870"]
        mod_bcm56980["BCM56980"]
        mod --> mod_bcm56870
        mod --> mod_bcm56980
        
        %% MOD BCM56870
        mod_bcm56870 --> mod_bcm56870_v43122["4.3.12.2"]
        mod_bcm56870_v43122 --> mod_bcm56870_v43122_fw0["FIRMWARE-BCM56870_0_MOD"]
        mod_bcm56870_v43122 --> mod_bcm56870_v43122_fw1["FIRMWARE-BCM56870_1_MOD"]
        mod_bcm56870 --> mod_bcm56870_rn["release_notes.txt"]
        
        %% MOD BCM56980
        mod_bcm56980 --> mod_bcm56980_v43122["4.3.12.2"]
        mod_bcm56980_v43122 --> mod_bcm56980_v43122_fw0["FIRMWARE-BCM56980_0_MOD"]
        mod_bcm56980_v43122 --> mod_bcm56980_v43122_fw1["FIRMWARE-BCM56980_1_MOD"]
        mod_bcm56980 --> mod_bcm56980_rn["release_notes.txt"]
    end

    %% Styles for Firmware Categories
    class bfd bfd
    class bs bs
    class ifa ifa
    class mod mod

    %% Click Events
    click repo "https://github.com/broadcom-network-switching-software/openfirmware/tree/master/root"
    click bfd "https://github.com/broadcom-network-switching-software/openfirmware/tree/master/BFD"
    click bfd_bcm56870 "https://github.com/broadcom-network-switching-software/openfirmware/tree/master/BFD/BCM56870"
    click bfd_bcm56870_v4312 "https://github.com/broadcom-network-switching-software/openfirmware/blob/master/BFD/BCM56870/4.3.12"
    click bfd_bcm56980 "https://github.com/broadcom-network-switching-software/openfirmware/tree/master/BFD/BCM56980"
    click bfd_bcm56980_v4315 "https://github.com/broadcom-network-switching-software/openfirmware/blob/master/BFD/BCM56980/4.3.15"
    
    click bs "https://github.com/broadcom-network-switching-software/openfirmware/tree/master/BroadSync"
    click bs_bcm56070 "https://github.com/broadcom-network-switching-software/openfirmware/tree/master/BroadSync/BCM56070"
    click bs_bcm56070_v4314 "https://github.com/broadcom-network-switching-software/openfirmware/blob/master/BroadSync/BCM56070/4.3.14"
    click bs_bcm88270 "https://github.com/broadcom-network-switching-software/openfirmware/tree/master/BroadSync/BCM88270"
    click bs_bcm88270_v4318 "https://github.com/broadcom-network-switching-software/openfirmware/blob/master/BroadSync/BCM88270/4.3.8"
    click bs_bcm88480 "https://github.com/broadcom-network-switching-software/openfirmware/tree/master/BroadSync/BCM88480"
    click bs_bcm88480_v4313 "https://github.com/broadcom-network-switching-software/openfirmware/blob/master/BroadSync/BCM88480/4.3.13"
    click bs_bcm88480_v4316 "https://github.com/broadcom-network-switching-software/openfirmware/blob/master/BroadSync/BCM88480/4.3.16"
    click bs_bcm88690 "https://github.com/broadcom-network-switching-software/openfirmware/tree/master/BroadSync/BCM88690"
    click bs_bcm88690_v43142 "https://github.com/broadcom-network-switching-software/openfirmware/blob/master/BroadSync/BCM88690/4.3.14.2"
    click bs_bcm88800 "https://github.com/broadcom-network-switching-software/openfirmware/tree/master/BroadSync/BCM88800"
    click bs_bcm88800_v4313 "https://github.com/broadcom-network-switching-software/openfirmware/blob/master/BroadSync/BCM88800/4.3.13"
    
    click ifa "https://github.com/broadcom-network-switching-software/openfirmware/blob/master/IFA1.1"
    click ifa_bcm56870 "https://github.com/broadcom-network-switching-software/openfirmware/tree/master/IFA1.1/BCM56870"
    click ifa_bcm56870_v43117 "https://github.com/broadcom-network-switching-software/openfirmware/blob/master/IFA1.1/BCM56870/4.3.11.7"
    click ifa_bcm56870_v43118 "https://github.com/broadcom-network-switching-software/openfirmware/blob/master/IFA1.1/BCM56870/4.3.11.8"
    
    click mod "https://github.com/broadcom-network-switching-software/openfirmware/tree/master/MOD"
    click mod_bcm56870 "https://github.com/broadcom-network-switching-software/openfirmware/tree/master/MOD/BCM56870"
    click mod_bcm56870_v43122 "https://github.com/broadcom-network-switching-software/openfirmware/blob/master/MOD/BCM56870/4.3.12.2"
    click mod_bcm56870_rn "https://github.com/broadcom-network-switching-software/openfirmware/blob/master/MOD/BCM56870/release_notes.txt"
    click mod_bcm56980 "https://github.com/broadcom-network-switching-software/openfirmware/tree/master/MOD/BCM56980"
    click mod_bcm56980_v43122 "https://github.com/broadcom-network-switching-software/openfirmware/blob/master/MOD/BCM56980/4.3.12.2"
    click mod_bcm56980_rn "https://github.com/broadcom-network-switching-software/openfirmware/blob/master/MOD/BCM56980/release_notes.txt"
    click doc1 "https://github.com/broadcom-network-switching-software/openfirmware/blob/master/License.txt"
    click doc2 "https://github.com/broadcom-network-switching-software/openfirmware/blob/master/README.md"
    
    %% Class Definitions
    classDef bfd fill:#ADD8E6,stroke:#000,stroke-width:2px;
    classDef bs fill:#B2D8B2,stroke:#000,stroke-width:2px;
    classDef ifa fill:#FFEB80,stroke:#000,stroke-width:2px;
    classDef mod fill:#FF9999,stroke:#000,stroke-width:2px;
```
