Automatic Instruction-Set Documentation from Hierarchical ADL Models

Resolve Bottlenecks,
Find Innovative Solutions
Generate Solutions

Solution Overview

Problem

The manual generation of instruction-set documentation for processor design is labor-intensive, error-prone, and delays the design process, as it is typically created late in the development cycle, making it difficult to maintain and distribute accurately among design teams, especially for ASIPs where instruction-sets are dynamically generated.

Innovation Solution

A method and system for automatically generating instruction-set documentation from an abstract processor model described using a hierarchical architectural description language (ADL), which involves accessing the model, flattening it to generate internal rules, and then producing documentation arranged by convergent instructions, allowing for parallel documentation generation during the design process.

Engineering Contradictions & Design Principles

VSEngineering Contradiction Analysis

1Reliability

If manual documentation generation is used, then documentation can be created with human expertise and judgment, but the process becomes labor-intensive, error-prone, and delays the design process

Engineering Contradiction:
Improvedocumentation accuracyVSAvoiddocumentation generation speed
Core Design Contradiction:
ReliabilityVSProductivity

Solution Approach 1:

The patent uses automated copying of processor model data to generate documentation. The system extracts information directly from the hierarchical processor model and transforms it into documentation format without manual intervention, eliminating human errors while maintaining accuracy through systematic data transformation rules.

Inventive Principle:
Principle #26Copying

Solution Approach 2:

The documentation generation system performs self-service by automatically extracting, organizing, and formatting documentation from the processor model itself. The system uses the model's inherent structure and metadata to generate accurate documentation without requiring external human expertise for each documentation update.

Inventive Principle:
Principle #25Self-service

2Stability of the object's composition

If documentation is created late in the design process, then all critical processor parts are in their final phase with stable specifications, but documentation cannot serve the design team during earlier development stages

Engineering Contradiction:
Improveprocessor design stabilityVSAvoiddesign process time
Core Design Contradiction:
Stability of the object's compositionVSLoss of time

Solution Approach 1:

The patent implements preliminary action by enabling documentation generation at any stage of the design process, not just when the processor model is complete. The system continuously extracts documentation from the evolving hierarchical model, allowing design teams to access accurate documentation during early development phases while the processor architecture is still being refined.

Inventive Principle:
Principle #10Preliminary action

3Adaptability or versatility

If manual documentation maintenance is performed, then documentation can be customized and adapted to specific design needs, but the process becomes slow and difficult to keep up-to-date with dynamically changing instruction-sets

Engineering Contradiction:
Improvedocumentation customizationVSAvoiddocumentation update speed
Core Design Contradiction:
Adaptability or versatilityVSProductivity

Solution Approach 1:

The patent applies dynamics by making the documentation generation process adaptive to changes in the processor model. The system continuously monitors the hierarchical processor model and automatically regenerates documentation when instructions are added, removed, or modified, ensuring documentation always reflects the current state without manual intervention.

Inventive Principle:
Principle #15Dynamics

Solution Approach 2:

The system uses feedback mechanisms where the generated documentation is continuously validated against the processor model. When discrepancies are detected or model changes occur, the system automatically updates the documentation to maintain consistency, creating a closed-loop system that ensures accuracy while maintaining adaptability.

Inventive Principle:
Principle #23Feedback

4Reliability

If teams of highly skilled engineers are used for manual documentation, then documentation quality and expertise are ensured, but the cost and complexity of the design process increase

Engineering Contradiction:
Improvedocumentation qualityVSAvoiddesign process complexity
Core Design Contradiction:
ReliabilityVSDevice complexity

Solution Approach 1:

The patent replaces the mechanical system of manual documentation creation by skilled engineers with an automated computational system. The hierarchical processor model and documentation generation algorithm substitute for human expertise, eliminating the need for specialized documentation writers while maintaining high quality through systematic data extraction and transformation.

Inventive Principle:
Principle #28Mechanics substitution (Replace mechanical system)

Data Source

PatentUS8006225B1Method and system for automatic generation of instruction-set documentation from an abstract processor model described using a hierarchical architectural description language
Publication Date: 2011.08.23 MIPS HLDG INC
  • US8006225B1 patent drawing
  • US8006225B1 patent drawing
  • US8006225B1 patent drawing

AI summary

A method and system for the automatic generation of instruction-set manuals. Specifically, the method of the present invention includes accessing an abstract processor model of a processor, wherein said abstract processor model is represented using a hierarchical architecture description language (ADL). The abstract processor model includes a plurality of instructions arranged in a hierarchical structure. An internal representation of the abstract processor model is generated by flattening the abstract processor model. The flattening process generates a plurality of rules grouped by common convergent instructions. Each rule describes an instruction path through the hierarchical structure that converges at a corresponding convergent instruction. An instruction-set documentation is automatically generated from the plurality of rules, wherein the instruction-set documentation is arranged convergent instruction by convergent instruction.