How broadcom-network-switching-software/openfirmware works
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.