Magic Do

Macro Generation Software

Version 1.0

Magic Do is a VHDL hierarchy builder that automates the process of generating ncsim/modelsim compilation script/macro. The same generated file can be used as synthesis scripts or compilation macro for any other simulator. This document provides information about the various features of Magic Do and their use. To generate compilation script magic do requires top file (top design file of a project/module for which is to be generated) and top folder (folder where magic do can find required components being used in your design), magic do will automatically look into sub folders within top folder to find required components.

Figure 1 : User Interface for Magic Do

Features

1. Automatically generates compilation macro.

2. Automatically finds and includes required packages.

3. Automatically inserts 87 and 93 option for each file.

4. Provides Alternate folder (optional).

5. Generates unused files and multiple component definition report (optional).

1. Options and their explanations

------------------------------------------------------------------------------------------------------------

1. Top file

This should be the top file of the design, a design/project for which the users want to generate compilation macro.

------------------------------------------------------------------------------------------------------------

2. Top folder

After specifying the top file, the user must specify a top folder path. Magic Do will search all the required components and packages in this top folder and its sub folders. If the components are not found, Magic Do will flag warning in the compilation macro itself. The user is advised to check for these warnings before using it.

------------------------------------------------------------------------------------------------------------

3. Alternate folder

In some cases it may not be possible to specify a single top folder that contains all the required components. In such case you can provide magic do an alternate folder to look for components.

e.g. If the user wants to include some files from local folder then he may point alternate folder path to its local directory.

When an alternate folder is specified, Magic Do will search the required components in both top folder and alternate folder including their sub directories.

------------------------------------------------------------------------------------------------------------

4. Log file

If selected, Magic Do generates a log of the run. This log reports unused files and multiple component definitions present in the top folder or alternate folder.

By default log file is generated in C:/magic_do.log but this can be changed by specifying the complete path and file name.

a) Unused files

Files, which are present in top folder or alternate folder (if selected) but are not required in the design (non dependency files), are declared as unused files. Magic Do reports such files in log file.

b) Multiple Component Definition

If the same component is defined in one or more files, Magic Do reports such components and their file path in log file.

------------------------------------------------------------------------------------------------------------

5. Out put File

By default Magic Do generates the compilation macro at “C:\default.do”, which can be changed by browsing to a new location, new location can be browsed by clicking the green icon present on right side or specifying the complete path and the file name.

----------------------------------------------------------------------------------------------------------

6. Simulator Selector

Simulator selector allows user to specify simulator for which you want to generate compilation macro. If you select ncsim, switch selector shall guide you in selecting different switches required for NCSim.

-----------------------------------------------------------------------------------------------------

7. Switch Selector

Switch selector allows user to select different switches for NCSim macros, only file list option is also available to generate plain files list. Any user defined commands or string can be appended using user string option. (e.g., if the user wishes to create a synthesis script, then he should select only file list and give “READ_VHDL” command as user string).

Note: Only frequently used switches are provided through check box selector, others switches can be given through user string

------------------------------------------------------------------------------------------------------------

8. Multiple Component Definition Resolver

In case Magic Do finds more then one component definition file for a single component, it provides a component resolver window through which user may select the required component.

A component resolver window pops up when such a case is encountered by Magic Do. User may change the selection by changing the highlighted path.

------------------------------------------------------------------------------------------------------------

2) How to use Magic Do

1. Browse and specify the file path in Top file .

2. Browse and specify the folder in Top Folder.

3. Browse and specify the Alternate Folder path (This step is OPTIONAL).

4. Browse and specify the unused report path and file name (This step is OPTIONAL).

5. Browse and specify the path and file name for macro to be created.

6. Select ncsim/modelsim simulator. In case of ncsim you may have to select required switches from switch selector.

7. Hit Run.

------------------------------------------------------------------------------------------------------------

3) Limitations

1. Magic Do accepts only vhdl files.

2. Component name, variable name or a single word in the VHDL file should not exceed 500 characters.

4) Output

Snapshot of generated macro/script.

------------------------------------------------------------------------------------------------------------