| Version 83 (modified by elliotng, 17 years ago) (diff) |
|---|
sysgen2opb Peripheral Conversion Tool
'sysgen2opb' is a MATLAB script which converts a model built in Xilinx System Generator into an OPB-compliant peripheral for use with the embedded PowerPCs. The script replaces all the model's gateways in/out with memory mapped registers. It also creates the necessary address decode logic and a C header file with the resulting register map. There are two options in running the script:
- Simple Gateways Script - This script is exactly what is described on the above.
- From/To Registers Extension Script - Uses Simple Registers Script except that it uses From/To Registers instead of Gateways In/Out
In addition, there are two options to turn on/off
- Shared Memory Extension Script - This script is the Simple Registers Script with the Shared Memory extension. The Shared Memory support requires the usage of Dual Port RAM's.
- Configurable Subsystem Extension Script - This script is the Simple Registers Script with the Configurable Subsystem Extension. It will take the gateway's/FromTo Registers and register's and store them into a library of Configurable Subsystems.
The latest copy of this tool is available in the repository.
A copy of Xilinx's OPB Export tool is needed to use the models generated by sysgen2opb.
Example unconverted and converted models are also available. orig refers to original script example files. smro refers to Shared Memory read only example files. smwo refers to Shared Memory write only example files. 'confsubsys' refers to Configurable Subsystem Extension script example files.
Using sysgen2opb
- Prepend "no_reg_" to a gateway's name to prevent its being converted to a register. These gateways will become top-level HDL ports in the exported peripheral.
- The Simple Gateway Script is supported for System Generator version 7.1 and 8.1. Shared Memory Extension, Configurable Subsystem Extension, and From/To Registers Extension Script are only supported for System Generator version 8.1.
- Copy the conversion script (sysgen2opb.m) and its required skelton peripheral model (skeleton_periph_model.mdl) to the same directory as your model.
- Make sure MATLAB's current working directory is the folder containing your model, the sysgen2opb script and skeleton model. Run the script on the MATLAB command line like: sysgen2opb('yourModelName', 'yourScriptChoice', 'yourSMChoice', 'yourCSChoice', 'yourAppend')
- Replace 'yourModelName' with your Simulink model's name without the .mdl extension.
- Replace 'yourScriptChoice' with one of the following:
- 'gw' which will run the Simple Gateways Script
- 'ftreg' which will run the From/To Registers Extension Script
- Replace 'yourSMChoice' with one of the following:
- 'smon' which will turn on the Shared Memory Extension Script
- 'smoff' which will turn off the Shared Memory Extension Script
- Replace 'yourCSChoice' with one of the following:
- 'cson' which will turn on the Configurable Subsystem Extension Script
- 'csoff' which will turn off the Configurable Subsystem Extension Script
- For Simple Gateways, From/To Registers, Shared Memory Extension, and Configurable Subsystem Extension Script, replace 'yourAppend' with a string which will replace the "no_reg_" prefix attached to unconverted gateways.
- Additional Options
- If you want to run the From/To register script with no shared memory extension, no configurable subsystem extension, and a blank string to strip away the "no_reg_" prefix, run: sysgen2opb('yourModelName')
- If you want to run the simple gateway script with no shared memory extension, no configurable subsystem extension, and a blank string to strip away the "no_reg_" prefix, run: sysgen2opb('yourModelName', 'gw')
- If you want to run the simple gateway script or From/To Register script with your choice on shared memory, no configurable subsystem extension, and a blank string to strip away the "no_reg_" prefix, run: sysgen2opb('yourModelName', 'yourScriptChoice', 'yourSMChoice')
- If you want to run the simple gateway script or From/To Register script with your choice on shared memory, with your choice on configurable subsystem extension, and a blank string to strip away the "no_reg_" prefix, run: sysgen2opb('yourModelName', 'yourScriptChoice', 'yourSMChoice','yourCSChoice');
Current Limitations
- The script (sysgen2opb.m) and skeleton peripheral model (skeleton_periph_model.mdl) must in the same directory as the model you wish to convert.
- The model you're converting must contain at least one Gateway In and one Gateway Out which will become registers.
- The base address and memory size of the resulting OPB peripheral cannot be changed dynamically in XPS. These parameters must be entered manually in XPS and locked before autogenerating addresses for other peripherals.
- All gateways which become registers must be clocked at the system sample period.
- Any sources driving gateways which are converted to registers will remain in the model. Functionally this is fine; they're just clutter.
- Every register created by the script will have a unique address on a 4-byte boundary (i.e. addr[1:0]=2'b0 for all).
- Every register will be read/write. Read/write-only must be enforced by software.
- From the script, we can have at most 1024 Gateways. However, with some limitation in one of the tools, we can only use 450 Gateways. A check is implemented to make sure that we have less than/equal 450 Gateways.
- The memory interface blocks created by the script will be placed in the middle of the top-level of the model, probably underneath existing subsystems. Connectivity won't be changed, but you'll have to clean things up by hand.
- Any Boolean type connected to a Gateway Out needs to be cast to a UFix1_0 before being connected to the Gateway Out.
- Path to output register must contain synchronous path.
Known Bugs
- The script fails if there are no gateways or if there are no gateways out. It should fail only if there are no gateways at all.
