HOME   IP   TECHNICAL BULLETIN   ARTICLE ARCHIVES   ARTICLE

DesignWare Technical Bulletin Article

Search Tools

Spotlight

Latest Update to DesignWare Documentation and STARS-on-the-web


DesignWare Documentation Updates for Q2 2007

Documentation for DesignWare products is continuously updated and released. In the months of February through April 2007, there were over 27,000 pages of documentation released with new or updated products.

When you download and install a DesignWare product, the associated documentation is always installed on your local network along with the product. In addition to your personal copy of the documentation, you can also check the Synopsys website for updates to the documentation you already have:
o DesignWare Library documentation
o DesignWare Cores documentation (requires SolvNet ID)

Usually, substantive updates to the documentation only accompany new product releases. If you want to be sure that you are information about new product releases, go to www.myDesignWare.com and register for updates to the products of interest. A SolvNet ID is required to access myDesignWare.com.

The tech pubs team is always welcomes your feedback. If you have questions or comments about DesignWare product documentation, please send to jonw@synopsys.com.

 


Recent Improvements to STARs on the Web

STARs on the Web is an online service available to DesignWare customers that allows you to see new problem problem reports (STARs) almost as soon as they are identified by Synopsys. STARs on the Web also displays planned enhancements, implemented enhancements, as well as a record of fixed problems for previous releases over the past two years.

STARs on the Web now features an improved presentation that organizes fixed STARs according to release number as well as a dynamic list of open STARs (discovered since the last release). Each tabbed page displays an expandable/collapsible list of STARs that contains STAR ID, severity level, and a brief description.

There have also been improvements to the information supplied in the individual STAR reports, although the types of improvements depend on the type of DesignWare product. Due to customer demand, an upcoming improvement to synthesizable IP products will be the addition of waveform graphics to better illustrate the problem and the fix.

If you are a DesignWare customer and have not yet viewed STARs on the Web for your product, go to www.designware.com and use the "Search for IP" box to find your product. Then click on the "STARs" link in the resulting search list. A SolvNet ID is required to view STARs on the Web.

If you have comments about STARs on the Web, please send to jonw@synopsys.com.

 


Improvements to Documentation for DesignWare Verification IP

As more of the DesignWare Verification IP products add RVM and VMM interfaces, it has been necessary to improve on the traditional methods of documenting reference material for those products. Rather than provide a collection of command reference pages, the most recent approach has been to use an open-source tool called Doxygen to generate robust HTML documentation directly from the OpenVera source code itself plus embedded comment text. The result is accurate and feature-rich HTML documentation that includes accurate class and member declarations, functions, and enumerations.

The home page of a Doxygen HTML features an expandable/collapsible bookmark list on the left side, and tabbed summary pages on the right side.

Individual class reference pages feature hyperlinked class hierarchy diagrams, class structure and contents, a class member index,
a navigation pane, and extensive hyperlinks to related members and classes. The result is documentation presented in familiar programming terms that provides quick navigation to overviews as well as details.

Availability of Doxygen HTML VIP Documentation

The following is a list of DesignWare Verification IP suites and the status of Doxygen HTML documentation for each suite.

AMBA (4.50a)
AHB: Fully commented Doxygen for both RVM and VMM
APB: None yet
AXI: Fully commented Doxygen for both RVM and VMM

Ethernet (4.00a)
- Fully commented Doxygen for both RVM and VMM

I2C (1.10b)
- Fully commented Doxygen for RVM and VMM will be in 2.00a

OCP (1.00b)
- Fully commented Doxygen for VMM (OpenVera RVM not supported)

PCI Express (5.90a)
- Uncommented Doxygen for both RVM and VMM
- Fully commented Doxygen for both RVM and VMM planned for Gen2 release

SATA (2.10a)
- Fully commented Doxygen for both RVM and VMM

SIO (1.40a)
- Uncommented Doxygen for both RVM and VMM
- Fully commented Doxygen will be available for the next release.

USB (4.50b)
- Fully commented Doxygen for both RVM and VMM