Skip to content

Latest commit

 

History

History
48 lines (27 loc) · 3.71 KB

File metadata and controls

48 lines (27 loc) · 3.71 KB
graph LR
    SVD_HTML_Documentation_Generator["SVD HTML Documentation Generator"]
    SVD_Comparison_Reporting_Tool["SVD Comparison & Reporting Tool"]
    SVD_Device_Parser["SVD Device Parser"]
    SVD_Device_Parser -- "provides data to" --> SVD_HTML_Documentation_Generator
    SVD_Device_Parser -- "provides data to" --> SVD_Comparison_Reporting_Tool
Loading

CodeBoardingDemoContact

Details

The system is composed of three main architectural components: the SVD HTML Documentation Generator, the SVD Comparison & Reporting Tool, and the SVD Device Parser. The SVD Device Parser acts as a foundational utility, responsible for extracting core device and interrupt information from SVD files. Both the SVD HTML Documentation Generator and the SVD Comparison & Reporting Tool consume data provided by the SVD Device Parser. The SVD HTML Documentation Generator transforms this parsed SVD data into human-readable HTML documentation, while the SVD Comparison & Reporting Tool leverages the parsed data from two SVD files to identify and report discrepancies in an HTML format. This architecture promotes reusability of the SVD parsing logic and clearly delineates responsibilities for documentation and comparison functionalities.

SVD HTML Documentation Generator

This component is responsible for parsing a single SVD (System View Description) file and transforming its contents into human-readable HTML documentation. It focuses on presenting the device's peripherals, registers, and fields in a structured, browsable format. This component acts as a data transformation stage, converting SVD XML data into a structured HTML output.

Related Classes/Methods:

SVD Comparison & Reporting Tool

This component provides analytical capabilities by comparing two SVD files, typically representing different versions or configurations of a device. It identifies and highlights discrepancies between the two SVDs and generates an HTML report that visually presents these differences, aiding in change tracking and verification.

Related Classes/Methods:

SVD Device Parser

This component is a shared utility responsible for parsing SVD files to extract device-level information, specifically interrupt data. It provides a standardized way to access core device details from SVD files for other components.

Related Classes/Methods: