Creating Components in LatticeMico32 System (v6.1SP1)

Creating Components in 

LatticeMico32 System 

Lattice Semiconductor Corporation 

5555 NE Moore Court 

Hillsboro, OR 97124 

(503) 268-8000 

November 15, 2006

Copyright 

Copyright © 2006 Lattice Semiconductor Corporation. 

This document may not, in whole or part, be copied, photocopied, 

reproduced, translated, or reduced to any electronic medium or machinereadable 

form without prior written consent from Lattice Semiconductor 

Corporation. 

Trademarks 

Lattice Semiconductor Corporation, L Lattice Semiconductor Corporation 

(logo), L (stylized), L (design), Lattice (design), LSC, E 2 CMOS, Extreme 

Performance, FlexiMAC, FlexiPCS, GAL, GDX, Generic Array Logic, HDL 

Explorer, IPexpress, ISP, ispATE, ispCLOCK, ispDOWNLOAD, ispGAL, 

ispGDS, ispGDX, ispGDXV, ispGDX2, ispGENERATOR, ispJTAG, ispLEVER, 

ispLEVERCORE, ispLSI, ispMACH, ispPAC, ispTRACY, ispTURBO, 

ispVIRTUAL MACHINE, ispVM, ispXP, ispXPGA, ispXPLD, LatticeEC, 

LatticeECP2, LatticeECP2M, LatticeECP, LatticeECP-DSP, LatticeMico8, 

LatticeMico32, LatticeSC, LatticeXP, MACH, MachXO, MACO, ORCA, PAC, 

PAC-Designer, PAL, Performance Analyst, PureSPEED, Silicon Forest, 

Speedlocked, Speed Locking, SuperBIG, SuperCOOL, SuperFAST, 

SuperWIDE, sysCLOCK, sysCONFIG, sysDSP, sysHSI, sysI/O, sysMEM, The 

Simple Machine for Complex Design, TransFR, UltraMOS, and specific 

product designations are either registered trademarks or trademarks of 

Lattice Semiconductor Corporation or its subsidiaries in the United States 

and/or other countries. ISP and Bringing the Best Together are service marks 

of Lattice Semiconductor Corporation. 

Other product names used in this publication are for identification purposes 

only and may be trademarks of their respective companies. 

Disclaimers 

NO WARRANTIES: THE INFORMATION PROVIDED IN THIS DOCUMENT 

IS “AS IS” WITHOUT ANY EXPRESS OR IMPLIED WARRANTY OF ANY 

KIND INCLUDING WARRANTIES OF ACCURACY, COMPLETENESS, 

MERCHANTABILITY, NONINFRINGEMENT OF INTELLECTUAL 

PROPERTY, OR FITNESS FOR ANY PARTICULAR PURPOSE. IN NO 

EVENT WILL LATTICE SEMICONDUCTOR CORPORATION (LSC) OR ITS 

SUPPLIERS BE LIABLE FOR ANY DAMAGES WHATSOEVER (WHETHER 

DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL, 

INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF PROFITS, 

BUSINESS INTERRUPTION, OR LOSS OF INFORMATION) ARISING OUT 

OF THE USE OF OR INABILITY TO USE THE INFORMATION PROVIDED 

ON THIS SITE, EVEN IF LSC HAS BEEN ADVISED OF THE POSSIBILITY 

OF SUCH DAMAGES. BECAUSE SOME JURISDICTIONS PROHIBIT THE 

EXCLUSION OR LIMITATION OF CERTAIN LIABILITY, SOME OF THE 

ABOVE LIMITATIONS MAY NOT APPLY TO YOU. 

LSC may make changes to these materials, specifications, or information, or 

to the products described herein, at any time without notice. LSC makes no 

commitment to update this documentation. LSC reserves the right to 

discontinue any product or service without notice and assumes no obligation 

to correct any errors contained herein or to advise any user of this document 

of any correction if such be made. LSC recommends its customers obtain the 

Creating Components in LatticeMico32 System ii

latest version of the relevant information to establish, before ordering, that the 

information being relied upon is current. 

Type Conventions Used in This Document 

Convention Meaning or Use 

Bold Items in the user interface that you select or click. Text that you type 

into the user interface. 

Variables in commands, code syntax, and path names. 

Ctrl+L Press the two keys at the same time. 

Courier Code examples. Messages, reports, and prompts from the software. 

... Omitted material in a line of code. 

. 

. 

. 

Omitted lines in code and report examples. 

[ ] Optional items in syntax descriptions. In bus specifications, the 

brackets are required. 

( ) Grouped items in syntax descriptions. 

{ } Repeatable items in syntax descriptions. 

| A choice between items in syntax descriptions. 

Creating Components in LatticeMico32 System iii

Creating Components in LatticeMico32 System iv

Contents 

Creating a Custom Component in LatticeMico32 System 1 

Design Flow 1 

Create New Custom Component Flow 1 

Edit Existing Custom Component Flow 2 

Building and Adding Your Component to MSB 3 

MSB Components 3 

Typical Component Folder and File Structure 4 

Import/Create Component Graphical Interface 5 

Component Tab 7 

Master/Slave Ports Tab 9 

External Ports Tab 13 

RTL Files Tab 15 

Creating Verilog RTL Files 17 

Parameters Tab 19 

Software Tab 21 

Software Files Tab 24 

References 25 

Creating Components in LatticeMico32 System v

Contents 

Creating Components in LatticeMico32 System vi

Design Flow 

Creating a Custom 

Component in 

LatticeMico32 System 

1 

This document shows you how to create a custom component for insertion 

into a LatticeMico32 System software Mico System Builder (MSB) platform 

using the Import/Create Custom Component dialog box. 

It is assumed that you already have the Verilog source code for the 

component that you wish to add. (Refer to the “WISHBONE Interconnect 

Architecture” chapter of the LatticeMico32 Software Developer User’s Guide.) 

There are two design flows available with the MSB Import/Create Custom 

Component dialog box: 

� Create new custom component flow 

� Edit existing custom component flow 

Create New Custom Component Flow 

The following is the design flow for creating new custom components: 

1. In the LatticeMico32 System MSB perspective, open the “Import/Create 

New Component" dialog box. 

2. In the Component Tab, select the Create New Component option. 

3. In the Component Tab, enter the new component name and new 

component folder path. 

4. In the Master/Slave Ports tab, specify ports 

5. In the External Ports tab, specify external definitions. 

6. In the RTL tab, import generated RTL files. 

7. In the Parameters Tab, specify parameters and GUI widgets. 

Creating Components in LatticeMico32 System 1

Creating a Custom Component in LatticeMico32 System Design Flow 

8. In the Software tab, enter DDStruct and DDInit information. 

9. In the Software Files tab, import software files. 

10. Click OK. The software: 

� Creates the component folder structure (refer to Figure 3 on page 4). 

� Creates the component description file (.xml) and 

adds it to the correct folder. 

� Adds Verilog wrapper file (.v) to instantiate the 

top level of the design. 

� Copies the component RTL into the rtl/verilog folder, as shown in 

Figure 3 on page 4. 

� Creates a makefile (peripheral.mk). The makefile directs the C/C++ 

SPE to C/assembly source files containing user defined APIs. An 

example of a makefile file is shown in Figure 1. 

Figure 1: Example of makefile 

#--------------------------------------------------------- 

# Identify source-paths for this device's driver-sources, 

# compiled when building the library 

#--------------------------------------------------------- 

LIBRARY_C_SRCS+= OpenCoresI2CMaster.c\ 

OpenCoresI2CMasterService.c 

LIBRARY_ASM_SRCS += 

Edit Existing Custom Component Flow 

The following is the design flow for editing existing components: 

1. In the LatticeMico32 System MSB perspective, open the “Import/Create 

New Component" dialog box. 

2. In the Component Tab, select the Open Component XML option. 

3. In the Component Tab, enter the component description file 

(.xml) name. The software log reads the component 

XML data, gets the RTL file names and gets the software file names. 

4. In the Component Tab, edit general requirements, such as component 

name. 

5. In the Master/Slave Ports tab, edit, add or delete Master/Slave ports 

6. In the External Ports tab, edit, add or delete external definitions. 

7. In the RTL tab, delete the current RTL files or import different RTL files. 

8. In the Parameters Tab, edit, add or delete parameters and GUI widget. 

9. In the Software tab, edit, add or delete DDStruct and DDInit information. 

10. In the Software Files tab, delete current software files or import different 

software files. 

11. Click OK. The software regenerates the component folder structure, adds/ 

removes files to/from the correct folders, recreates the wrapper files, and 


Creating a Custom Component in LatticeMico32 System Building and Adding Your Component to MSB 

recreates the component description file (.xml). The 

wrapper file to the top-level module will also be recreated with the edited 

information. Any data edited or added independent of the Import/Create 

Custom Components graphical user interface (GUI) will be lost. 

Building and Adding Your Component to MSB 

To build a custom component, you should run the LatticeMico32 System 

software and be in the MSB perspective. Refer to the LatticeMico32 

Development Tools Installation Guide for instructions on installing and starting 

the LatticeMico32 System software. 

MSB Components 

The available LatticeMico32 components are listed in the Available 

Components view in MSB, as shown in Figure 2. 

Figure 2: Available Components View in MSB 


Creating a Custom Component in LatticeMico32 System Building and Adding Your Component to MSB 

Typical Component Folder and File Structure 

Figure 3 shows a typical folder and file structure for a LatticeMico32 

component. 

Figure 3: Typical Component Folder and File Structure 

 

.xml 

document 

drivers 

rtl 

.htm 

peripheral.mk 

device 

verilog 

.c 

.h 

service.c 

service.h 

.v 

.v 

Component folder 

Component description file 

“document” sub-folder 

HTML file 

“drivers” sub-folder 

peripheral.mk file 

“device” sub-folder 

Device driver files 

System service files 

“rtl” sub-folder 

“verilog” sub-folder 

Verilog component RTL files 

The following is a brief description of the folders and files contained in a 

typical custom component folder: 

� folder – Contains the following files and directories: 

� .xml – This is the component description file that 

contains the XML code required to attach your component to the 

LatticeMico32 processor. 

� document folder – Contains documentation file or files. This folder, at a 

minimum, contains the following file: 

� .htm – HTML file that is displayed in the MSB 

Main WIndow Component Help view 

� drivers folder – Contains the peripheral.mk file, which is used to direct 

C/C++ System Programming Environment (SPE) to the C/assembly 

driver files containing user-defined application programming interfaces 

(APIs). 


Creating a Custom Component in LatticeMico32 System Import/Create Component Graphical Interface 

Also inside the drivers folder are two subdirectories: 

� Device driver files (.c and 

.h). The device driver files define the API 

function calls available to the C/C++ SPE developer. The functions 

are user-defined according to the specific needs of the custom 

component. 

� System service driver files (Service.c and 

Service.h). The service files must be 

implemented to support the LatticeMico32 initialization process. 

Each component must define a basic set of service functions 

which have been defined by the LatticeMico32 boot process. 

� rtl folder – Contains the verilog subfolder. 

� verilog folder – Contains the component Verilog RTL files. 

Import/Create Component Graphical Interface 

The LatticeMico32 MSB perspective has an Import/Create Custom 

Component graphical user interface (GUI) that allows you to create or import 

custom components for use in your MSB platform. 

To open the Import/Create Custom Component GUI: 


Creating a Custom Component in LatticeMico32 System Import/Create Component Graphical Interface 

� In the LatticeMico32 System MSB perspective, click the Import/Create 

Custom Component button in the MSB Available Components view, 

as shown in Figure 4. 

Note 

A custom component is indicated in the MSB Available Components view with the 

following icon: . You can remove a previously created custom component by 

highlighting the component in the Available Components view and clicking the 

Remove Custom Component button. 

Figure 4: Import/Create Custom Component Button in Available Components View 

Import/Create 

Custom Component 

Button 

Remove 

Custom Component 

Button 


Creating a Custom Component in LatticeMico32 System Component Tab 

Component Tab 

Figure 5: Component Tab 

When the MSB Import/Create Custom Component button is clicked, the 

Import/Create Custom Component dialog box appears, with the Component 

tab displayed as default. 

The Component tab specifies component names, folders, and main attributes 

of the component. Figure 5 shows the Component tab of the Import/Create 

Custom Components dialog box. 


Creating a Custom Component in LatticeMico32 System Component Tab 

Table 1: Component Tab Options 

Option Description 

Table 1 lists the options available in the Component tab of the Import/Create 

Custom Component dialog box. 

Create New Component Choose this option to create a new component. 

Refer to “Create New Custom Component Flow” on page 1 for a description of the 

create new component flow. 

Open Component XML Choose this option to open an existing component description file 

(.xml) to edit the existing component. 

Refer to “Edit Existing Custom Component Flow” on page 2 for a description of 

the edit existing component flow. 

New Component Name Enter a name for your component. The name you enter in this box will be used to 

create a folder and a component description file (.xml). 

New Component Directory/ 

Select Component XML 

New Component Directory - This option displays if you are creating a new 

custom component and have selected the Create New Component option. Type 

in the path to your component folder, or use the browse button to browse to your 

new component folder. Note: Your new component folder should be outside of the 

.\micosystem folder. 

Select Component XML - This option displays if you are editing an existing 

component and have selected the Open Component XML option. Use the browse 

button to browse to the component description file (.xml) of 

the component you wish to edit. 

Display Name Enter a name for your component. This is the name that will appear in the MSB 

Available Components window. This name is not used for a folder or file name, so 

any combination of ASCII characters is permitted. 

Version Enter a version number for your component. This is the version number that will 

appear in the MSB Available Components window. 

Type Choose IO or Memory component type from the drop-down menu. 

Access This option is only available for memory type components. Choose Read, Write, 

or Read/Write from the drop-down menu. 

HTML Help Choose your component HTML file. The contents of this file will display in the 

MSB Component Help view. 

OK Accepts all values in the dialog box tab. If any value is incorrect, an error 

message will display at the bottom of the dialog box tab. You must complete all 

required values before you can continue. 

Cancel Cancels the actions and closes the dialog box. 

Reset Resets all values in all tabs in the dialog box. 

Help Displays the help for the dialog box. The help opens a copy of Creating 

Components in LatticeMico32 System. 


Creating a Custom Component in LatticeMico32 System Master/Slave Ports Tab 

Master/Slave Ports Tab 

Figure 6: Master/Slave Ports Tab 

Table 2: Master/Slave Port Tab Options 


The Master/Slave Ports tab specifies Master/Slave ports and connections to 

the LatticeMico32 WISHBONE Arbiter interface. Figure 6 shows the Master/ 

Slave Ports tab of the Import/Create Custom Components dialog box. 

Table 2 lists the options available in the Master/Slave Port tab of the Import/ 

Create Custom Component dialog box. 

Master/Slave Ports Lists the master and/or slave ports in your component. 

� You can create more than one Master Port. 

� You can create only one Slave Port. 

Delete To delete Master Port or a Slave Port, highlight the port in the Master/Slave Ports 

list, click Delete, then click OK. 

Note: There is no undo if you delete a port. Once you click Delete and then OK, 

the port will be permanently deleted. 



Table 2: Master/Slave Port Tab Options (Continued) 


Type Choose either Master Port or Slave Port from the drop-down menu. 

Display Name This defines the name of the Master/Slave port. The name is displayed indented 

and below the component name once the new component has been added to the 

platform. Any ASCII character is permitted in this field. 

Prefix The prefix you enter in this box will replace the variable in the Master 

Port or Slave Port signal names. The prefix is combined with the instance 

name given to each component when it is added to the platform creating 

an pair which is used for making port names 

unique. 

Port Attributes Connect the WISHBONE signal to the correct signal in your design. Refer to 

Table 3 on page 11 for a description of WISHBONE Slave Port signals. 

Update Updates options in MasterSlave Port tab. 

Add Adds the Master Port or Slave Port to the Master/Slave Ports list at the top of the 

dialog box. 

Reset Clears the port attributes. 

OK Accepts all values for every tab presented in the Import/Create Custom 

Component dialog box. If any value is incorrect, an error message will display at 

the bottom of the dialog box tab. You must complete all required values before 

you can continue. 





Attaching the WISHBONE Interface 

The ports of a component which implement a WISHBONE master or slave 

port must follow a specific naming convention. This allows MSB to correctly 

identify by name the ports by function so that they are connected properly 

when MSB generates the platform. 

Table 3 lists the signals required to connect the master port to the 

LatticeMico32 processor. Table 4 the signals required to connect the slave 

port to the LatticeMico32 processor. Each unique component must have a 

unique prefix. The ports which make up the WISHBONE master or slave port 

must follow the naming convention as described in the LatticeMico32 

Processor Reference Manual table entitled “List of Component Port and 

Signal Name Suffixes. 



Table 3: WISHBONE Signals Required to Connect Master Component to LatticeMico32 

Component Port Names for 

WISHBONE Slave Port 

Direction Width Required 

_ADR_O output 32 Yes 

_DAT_O output 32 No 

_WE_O output 1 Yes 

_SEL_O output 4 Yes 

_STB_O output 1 Yes 

_CYC_O output 1 Yes 

_LOCK_0 output 1 No 

_CTI_O output 3 No 

_BTE_O output 2 No 

_DAT_I input 32 No 

_ACK_I input 1 Yes 

_ERR_I input 1 No 

_RTY_I input 1 No 

Table 4: WISHBONE Signals Required to Connect Slave Component to LatticeMico32 




_ADR_I input 32 Yes 

_DAT_I input 32 No 

_WE_I input 1 Yes 

_SEL_I input 4 Yes 

_STB_I input 1 Yes 

_CYC_I input 1 Yes 

_LOCK_I input 1 No 

_CTI_I input 3 ‘No 

_BTE_I input 2 No 

_DAT_O output 32 No 

_ACK_O output 1 Yes 



Table 4: WISHBONE Signals Required to Connect Slave Component to LatticeMico32 (Continued) 




_ERR_O input 1 No 

_RTY_O input 1 No 


Creating a Custom Component in LatticeMico32 System External Ports Tab 

External Ports Tab 

Figure 7: External Ports Tab 

Table 5: External Ports Tab Options 


Connecting the Wishbone bus lets the LatticeMico32 microprocessor control 

and access the custom component. The custom component has it's own 

unique input/output control signals that need to be connected to system logic. 

The External Ports Tab permits these control signals to be defined so that the 

MSB can correctly generate a top level Verilog module. Figure 7 shows the 

External Ports tab of the Import/Create Custom Components dialog box. 

Table 5 lists the options available in the External Ports tab of the Import/ 


Parameters Lists the parameters of the External Ports in your component. Note: ClockPort 

and ResetPort are mandatory. Interrupt is optional. 

Delete Deletes selected external port from the Parameters list. Note: There is no “undo” 

if you delete a port. If you click OK, the port will be permanently deleted. It is not 

possible to delete the ClockPort, ResetPort, or Interrupt entries. 


Creating a Custom Component in LatticeMico32 System External Ports Tab 

Table 5: External Ports Tab Options (Continued) 


Port Type Displays port type of port selected in Parameters box (either ClockPort, 

ResetPort, Interrupt, or ExternalPort). Not selectable or editable by user. 

Component Port User-defined component port name. 

Width Port width. Enter a number from 1 - 32. 

Direction Allows you to choose port direction. Choose input, output, or inout from the 

drop-down menu. 

Active This option is only available if Port Type is interrupt. Choose , High, or 

Low from the drop-down menu. 

Connect To Enter signal name. 

Update Updates the port Parameters list. Whenever a change is made to the Port 

Attribute entries that you wish to make permanent, it is necessary to use 

the Update button. 

Add Use this button to insert a new external port into the list of ports the custom 

component implements. Fill in each of the active Port Attribute fields and then 

click Add. If there are no syntax errors a new entry will be appended to the list of 

external ports. 

Reset Clears all entries in the Port Attributes group box and permits entry of a 

new external port. Use this button if the Add button is not available. 










Creating a Custom Component in LatticeMico32 System RTL Files Tab 

RTL Files Tab 

This section describes the design requirements for the Verilog HDL files 

associated with a MSB component. 

The functionality of components within the MSB environment are ultimately 

defined by a collection of Hardware Description Language files (also known 

as RTL). The Import/Create Custom Components UI needs to know which 

HDL files define the functionality of your Wishbone compliant component. The 

RTL Files tab allows you to import and edit the HDL files associated with your 

component. 

The User RTL Files Source group box enables new HDL files to be added to 

the component. The files added to the list inside this group box do not 

become part of the component until the OK button is clicked and the UI closes 

without errors. 

Currently the only HDL available in the MSB is Verilog. Components written in 

VHDL must have a Verilog black-box wrapper around them. The VHDL 

component must be compiled to NGO format, using ispLEVER Project 

Navigator, independently of the MSB and placed in the Project Navigator 

working directory. 

The Component RTL Files group box contains a list of the HDL files that are 

already part of the component. This list is only populated when editing an 

existing custom component. The list is updated when the OK button is clicked 

and the UI closes without errors. 

Figure 8 shows the RTL Files tab of the Import/Create Custom Components 

dialog box. 



Figure 8: RTL Files Tab 

Table 6: RTL Files Tab Options 


Table 6 lists the options available in the RTL Files tab of the Import/Create 


Top-level Module Name Enter the name of the module that instantiates one instance of your 

component. 

RTL File This entry box permits you to enter a file name containing HDL code that 

is a part of your component. Enter a path and module name directly or 

use the Browse button to add HDL files interactively. 

Add Click the Add button to insert the file listed in the RTL File entry box to 

the list of files displayed in the Import RTL Files table. 

Delete Use this button to delete files from the Import RTL Files list. Highlight the 

file you wish to remove from the list and click Delete. 



Table 6: RTL Files Tab Options (Continued) 


Directory When a custom component is being edited, the Directory text box shows 

the path to the RTL files currently associated with the component. This 

field can not be edited. 

Delete The Delete button in the Component RTL Files group box allows you to 

remove files already associated to a custom component. Highlight the 

HDL file you want to remove and click Delete. 









Creating Verilog RTL Files 

The last section describes how MSB generates `define and parameter code 

used to customize the new component. 

MSB has some specific requirements for the structure of the Verilog source 

files used to define the component. It is important to follow the rules outlined 

below in order to successfully implement a MSB compliant component. 

When you are working on the Verilog HDL source files they can be placed 

anywhere in your files system hierarchy except the /micosystem/ 

components subdirectory. Once the OK button is clicked and the UI closes 

without errors the HDL source files are copied to the/micosystem/ 

components//rtl/verilog directory. 

When creating a platform in MSB you select each component in turn, and 

specify the unique requirements concerning each component. UARTS are 

given a particular baud rate, and data run length, SRAM memory is given a 

depth and width, and so forth. Each of these requirements becomes a Verilog 

parameter or a Verilog `define, which is stored in a generated file named 

system_conf.v. 

The MSB creates the system_conf.v parameter file each time the Generate 

Platform button is clicked. If your custom component uses parameters you will 

need to add a line in your module(s) to import the parameters defined in the 

system_conf.v file, for example: 

ìnclude "system_conf.v" 

When using Verilog `define for passing compilation configuration information it 

is necessary to ensure there are no namespace collisions. The `define values 

must be globally unique. 



MSB can also pass values to the Verilog top level module as parameters. 

When MSB generates code instantiating the top level module it will create 

code similar to the following example: 

I2cm_opencores #(.SYSCLK(25))…. 

When MSB generates the platform, it also adds the ‘define statement in the 

system_conf.v file parameter with the instance name prefixed to the 

parameter name, for example: 

‘define I2CM1SYSCLK 25 

Some custom components are unique and can only be added to a design a 

single time. Currently the LatticeMico32 processor can only be added to a 

platform a single time. However there may be components that may be added 

to a MSB platform many times. 

If the component can be instantiated multiple times in a system, all the source 

files must be enclosed in a globally unique `define statement, for example: 

ìfndef I2C_MASTER_CORE_V 

`define I2C_MASTER_CORE_V 

//all of the component’s source goes here 

èndif // I2C_MASTER_CORE_V 


Creating a Custom Component in LatticeMico32 System Parameters Tab 

Parameters Tab 

Figure 9: Parameters Tab 

Table 7: Parameters Tab Options 


This section describes how the `define and parameter statements are entered 

so that they can be sent to your Verilog source files. Figure 9 shows the 

Parameters tab of the Import/Create Custom Components dialog box. 

Table 7 lists the options available in the Parameters tab of the Import/Create 


Parameter Name This is the name of the parameter to be passed to the Verilog source 

code. When using Define types be sure to make the name globally 

unique. 

Display Text Each component, when added to the platform, brings up an 

individualized dialog box. Each element in the dialog box will have 

descriptive text placed adjacent to a control. Display Text defines the text 

that will be placed adjacent to the specific control. 


Creating a Custom Component in LatticeMico32 System Parameters Tab 

Table 7: Parameters Tab Options (Continued) 


Value Type Allows you to define value type. Choose Define, String, Integer, List, or 

Frequency from the drop-down menu. 

Default Value Default Value lets you define how each parameter or `define will be 

initialized when a component is added to the platform. This field is freeform, 

so you must be careful when entering default values. Any type 

mismatch or incorrect data entered here will impact the synthesis 

process later. 

GUI Widget Allows you to select GUI WIdget. 

� If Value type is Define, choose , Radio, or Check from the dropdown 

menu. 

� If Value type is String, choose or Text from the drop-down menu. 

� If Value type is Integer, choose Text or Spinner from the drop-down menu. 

� If Value type is List, choose or Combo from the drop-down menu. 

� If Value type is Frequency, choose or Text from the drop-down 

menu. 

WIdget Setting If GUI widget is Combo, enter comma-separated list values. If GUI widget is 

Spinner, enter minimum and maximum values as a hyphen-separated pair. 

Flags Choose , parameter, or compiler from the drop-down menu. 

� The parameter flag specifies that it is a Verilog parameter. 

� The compiler flag specifies that this is a compiler option to be used 

in C/C++ SPE. 

Complier Options If compiler flag is selected, specify flag or option. 

Standard I/O This option is only available for CharIODevice. Choose , input, output, 

or inout from the drop-down menu. 

Update Update changes. 

Add Add new parameter 

Reset Clears the Parameter tab options. 










Creating a Custom Component in LatticeMico32 System Software Tab 

Software Tab 

LatticeMico32 System custom components are created inside a Latticedefined 

framework. The framework consists of the HDL component, the UI 

component, and the C/C++ source code component. 

The MSB environment defines and requires a specific set of C data structures 

and at a minimum a single C initialization point. The MSB uses this set of 

structures to keep track of the number of instantiated cores. It also uses this 

information to determine how each component was configured prior to 

synthesis. 

One MSB element that needs to be created is a C structure which is used by 

Lattice C/C++ SPE and Debug API calls to identify the specific MSB 

component the C function will manipulate. This structure is generically called 

the DDStruct, but in actual practice will be a C typedef named 

st_customname_t. The UI lets you specify the customname. 

Every DDStruct in the MSB must have the following entries: 

const char* name; // components instance name 

unsigned int base; // components base address 

void * userCtx; 

void * callback; 

void * prev; // linked list describing components of the same 

type 

void * next; 

The DDStruct also contains information specific to your custom component. 

For example a VGA controller may have a maximum and minimum horizontal 

synchronization frequency. The DDStruct structure could have a 

minimumHorizFreq and a maximumHorizFreq element that would be 

configured prior to synthesis and then passed on to the Lattice C/C++ SPE 

and Debug environment via these two variables. 



Figure 10: Software Tab 

Table 8: Software Tab Options 


The Software Tab allows you to define the initialization function and the 

DDStruct pieces of the custom component. Figure 10 shows the Software tab 

of the Import/Create Custom Components dialog box. 

Table 8 lists the options available in the Software tab of the Import/Create 


Initialization Function Name Enter user-defined initialization function name. 

Component Information Structure 

Name 

Defines the name given to the DDStruct structure. 

Data Type Defines the C data type of the DDStruct element being added. The drop 

down menu lets you specify the following C data types: void *, unsigned 

int, int, int *, const char, unsigned char, unsigned char *, char, or char *. 

Member Name Defines the name of the DDStruct element being added. 

Value Available values in the drop-down menu are dependant upon the chosen Data 

Type. 



Table 8: Software Tab Options (Continued) 


Is Array Check if member name is an array. 

Delete Deletes the highlighted DDstruct setting from the list. 

Update Allows an element already added to the DDStruct to be modified. 

Highlight the element, make any desired changes to the element, and 

the click Update to activate the changes. 

Add Adds a new element to the DDStruct structure with the values active in 

the DDStruct Attributes group box. 

Reset Clears the DDStruct Attributes group box controls. 









Initialization Function Name 

Specifies the name of the initialization routine for a given component type. 

This routine is used to initialize the component at system power-up and reset. 

When the project is built in Lattice C/C++ SPE, a call to this function for each 

instance of this component will be put into the Lattice_DDinit C function 

(which is defined in the DDinit.c file). Lattice DDinit is part of the default boot 

sequence, and it calls main() after the component initialization function calls 

have been executed. Refer to the LatticeMico32 Software Developer’s Guide 

for more information about the boot sequence. 

The C prototype expected of the initialization routine is as follows: 

void InitRoutineName ( StuctureNameValue *ctx );. 

The StuctureNameValue is the name of your DDStruct defined type. 


Creating a Custom Component in LatticeMico32 System Software Files Tab 

Software Files Tab 

Figure 11: Software Files 

The Lattice C/C++ SPE and Debug environment permits you to write your C/ 

C++ applications allowing you to control the components attached to the 

LatticeMico32 WISHBONE bus. 

The Lattice supplied components all have at a minimum two source files 

associated with them. The source files define a set of C/C++ API's the 

firmware writer can use to access the component. 

This section of the UI also permits the addition of any support files used with 

the component or for building a object library. 

Imported files do not become part of the component until the OK button is 

clicked and the component is saved without error.The Current Software Files 

portion of the Software Files tab displays existing software files if an existing 

custom component is being edited 

Figure 11 shows the Software Files tab of the Import/Create Custom 

Components dialog box. 


Creating a Custom Component in LatticeMico32 System References 

Table 9: Software Files Tab Options 


References 

Table 9 lists the options available in the Software Files tab of the Import/ 


Software File Browse to software driver files. Copies the selected file into the component 

folder. 

Add Adds the file currently listed in the Software File entry box to the table of 

Imported Files. 

Delete Deletes the highlighted entry in the Import Software Files table. 

Directory Displays the folder where the source code files associated with the 

component being edited. 

Delete Deletes a source file already associated with the component being edited. 

File Type Choose the following from the drop down menu: Application, Platform Library, 

Structure Header, Header. 









You can consult the following references for more information on 

LatticeMico32 System: 

� Online Help in the LatticeMico32 System GUI, which you can access by 

choosing Help > Help Contents. 

� LatticeMico32 Tutorial, which steps you through the basic process 

involved in using the LatticeMico32 System software to implement a soft 

microprocessor and attached components in a Lattice Semiconductor 

device for the LatticeMico32/DSP development board 

� LatticeMico32 Processor Reference Manual, which contains information 

on the architecture of the LatticeMico32 processor, including configuration 

options, pipeline architecture, register architecture, debug architecture, 

and details about the instruction set 

� LatticeMico32 Development Kit User’s Guide, which describes how to 

install all the necessary development tools; set up the LatticeMico32 

development board; connect to the development board; use the 

LatticeMico32 System software (MSB and C/C++ SPE) to create the 

hardware platform and the software application code that drives it; and 

download the bitstream to the LatticeMico32 development board. You 


Creating a Custom Component in LatticeMico32 System References 

should be familiar with all chapters that cover the boot/initialization 

sequence; developing device drivers for components; and the managed 

build process which uses the information in the component description file 

to build the appropriate Verilog and C/C++ source code for the platform. 

� LatticeMico32 Software Developer User’s Guide, which explains how to 

use C/C++ SPE to program the microprocessor, gives examples of the 

code used for different parts of the architecture, and describes the 

processes occurring in the background 

� LatticeMico32 Development Tools Installation Guide, which explains how 

to install the LatticeMico32 System software 

� LatticeMico32/DSP Development Board User’s Guide, which describes 

the features and functionality of the LatticeMico32/DSP development 

board. This board is designed as a hardware platform for design and 

development with the LatticeMico32 microprocessor, as well as for the 

LatticeMico8 microcontroller, and for various DSP functions. 

� LatticeMico32 Asynchronous SRAM Controller, which describes the 

features and functionality of the LatticeMico32 asynchronous SRAM 

controller 

� LatticeMico32 DMA Controller, which describes the features and 

functionality of the LatticeMico32 DMA controller 

� LatticeMico32 On-Chip Memory Controller, which describes the features 

and functionality of the LatticeMico32 on-chip memory controller 

� LatticeMico32 Parallel Flash Controller, which describes the features and 

functionality of the LatticeMico32 parallel flash controller 

� LatticeMico32 GPIO, which describes the features and functionality of the 

LatticeMico32 GPIO 

� LatticeMico32 SPI, which describes the features and functionality of the 

LatticeMico32 serial peripheral interface (SPI) 

� LatticeMico32 Timer, which describes the features and functionality of the 

LatticeMico32 timer 

� LatticeMico32 UART, which describes the features and functionality of the 

LatticeMico32 universal asynchronous receiver-transmitter (UART) 

� LatticeECP/EC FPGA Family Handbook, which is a collection of the data 

sheets and application notes on LatticeEC and LatticeECP-DSP devices 

� LatticeECP2/M Family Handbook, which is a collection of the data sheets 

and application notes on LatticeECP2-DSP and LatticeECP2M-DSP 

devices

Creating Components in LatticeMico32 System (v6.1SP1)

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?