OpenCores
URL https://opencores.org/ocsvn/openmsp430/openmsp430/trunk

Subversion Repositories openmsp430

[/] [openmsp430/] [trunk/] [doc/] [html/] [files_directory_description.html] - Blame information for rev 166

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 50 olivier.gi
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
2 100 olivier.gi
<html><head><title>openMSP430 File &amp; Directory description</title></head><body>
3 50 olivier.gi
<a name="TOC"></a>
4
<h3>Table of content</h3>
5
<ul>
6 100 olivier.gi
        <li><a href="#1.%20Introduction">                                   1. Introduction</a></li>
7
        <li><a href="#2.%20Directory%20structure:%20openMSP430%20core">           2. Directory structure: openMSP430 core</a></li>
8
   <li><a href="#3.%20Directory%20structure:%20FGPA%20projects">             3. Directory structure: FGPA projects</a>
9 50 olivier.gi
        <ul>
10 100 olivier.gi
      <li><a href="#3.1%20Xilinx%20Spartan%203%20example">                       3.1 Xilinx Spartan 3 example</a></li>
11
      <li><a href="#3.2%20Altera%20Cyclone%20II%20example">                      3.2 Altera Cyclone II example</a></li>
12
      <li><a href="#3.3%20Actel%20ProASIC3%20example">                         3.3 Actel ProASIC3 example</a></li>
13 50 olivier.gi
        </ul>
14
        </li>
15 100 olivier.gi
        <li><a href="#4.%20Directory%20structure:%20Software%20Development%20Tools">4. Directory structure: Software Development Tools</a></li>
16 50 olivier.gi
</ul>
17
 
18
<a name="1. Introduction"></a>
19
<h1>1. Introduction</h1>
20
 
21 135 olivier.gi
To simplify the integration of this IP, the directory structure is based on the <a href="http://cdn.opencores.org/downloads/opencores_coding_guidelines.pdf">OpenCores</a> recommendations.
22 100 olivier.gi
<br>
23 50 olivier.gi
<a name="2. Directory structure: openMSP430 core"></a>
24 100 olivier.gi
<div style="text-align: right;"><a href="#TOC">Top</a></div>
25 50 olivier.gi
<h1>2. Directory structure: openMSP430 core</h1>
26
 
27
<table border="1">
28 100 olivier.gi
        <tbody><tr><td colspan="5"><b>core</b></td>                                                                           <td><i><b>openMSP430 Core top level directory</b></i></td></tr>
29 166 olivier.gi
        <tr><td rowspan="120" valign="bottom"><font color="white">abcd</font></td> <td colspan="4"><b>bench</b></td>    <td><i><b>Top level testbench directory</b></i></td></tr>
30
        <tr><td rowspan="9" valign="bottom"><font color="white">abcd</font></td> <td colspan="3"><b>verilog</b></td>  <td><i></i><br>
31 100 olivier.gi
</td></tr>
32 166 olivier.gi
        <tr><td rowspan="8" valign="bottom"><font color="white">abcd</font></td> <td colspan="2">tb_openMSP430.v</td> <td><i>Testbench top level module</i></td></tr>
33 50 olivier.gi
        <tr><td colspan="2">ram.v</td>                                                                                 <td><i>RAM verilog model</i></td></tr>
34
        <tr><td colspan="2">registers.v</td>                                                                           <td><i>Connections to Core internals for easy debugging</i></td></tr>
35
        <tr><td colspan="2">dbg_uart_tasks.v</td>                                                                      <td><i>UART tasks for the serial debug interface</i></td></tr>
36 116 olivier.gi
        <tr>
37 166 olivier.gi
      <td colspan="2" rowspan="1" style="vertical-align: top;">dbg_i2c_tasks.v<br>
38
      </td>
39
      <td style="vertical-align: top;"><span style="font-style: italic;">I2C tasks for the serial debug interface</span><br>
40
      </td>
41
    </tr>
42
    <tr>
43
      <td colspan="2" rowspan="1" style="vertical-align: top;">io_cell.v<br>
44
      </td>
45
      <td style="vertical-align: top;"><span style="font-style: italic;">Generic I/O cell model for building the serial debug interface I2C bus</span><br>
46
      </td>
47
    </tr>
48
<tr>
49 116 olivier.gi
      <td colspan="2" rowspan="1" style="vertical-align: top;">msp_debug.v</td>
50
      <td style="vertical-align: top;"><i>Testbench instruction decoder and ASCII chain generator for easy debugging</i></td>
51
    </tr>
52
<tr><td colspan="2">timescale.v</td>                                                                           <td><i>Global time scale definition for simulation.</i></td></tr>
53 50 olivier.gi
        <tr><td colspan="4"><b>doc</b></td>                                                                            <td><i><b>Diverse documentation</b></i></td></tr>
54
        <tr><td><font color="white">abcd</font></td> <td colspan="3">slau049f.pdf</td>                                 <td><i>MSP430x1xx Family User's Guide</i></td></tr>
55
        <tr><td colspan="4"><b>rtl</b></td>                                                                            <td><i><b>RTL sources</b></i></td></tr>
56 166 olivier.gi
        <tr><td rowspan="31" valign="bottom"><font color="white">abcd</font></td><td colspan="3"><b>verilog</b></td>   <td><i></i><br>
57 100 olivier.gi
</td></tr>
58 166 olivier.gi
        <tr><td rowspan="30" valign="bottom"><font color="white">abcd</font></td> <td colspan="2">openMSP430_defines.v</td>  <td><i>openMSP430 core configuration file (Program and Data memory size definition, Debug Interface configuration, ...)</i></td></tr>
59 50 olivier.gi
        <tr><td colspan="2">openMSP430_undefines.v</td>                                                                <td><i>openMSP430 Verilog `undef file</i></td></tr>
60
        <tr><td colspan="2">openMSP430.v</td>                                                                          <td><i>openMSP430 top level</i></td></tr>
61
        <tr><td colspan="2">omsp_frontend.v</td>                                                                       <td><i>Instruction fetch and decode</i></td></tr>
62
        <tr><td colspan="2">omsp_execution_unit.v</td>                                                                 <td><i>Execution unit</i></td></tr>
63
        <tr><td colspan="2">omsp_alu.v</td>                                                                            <td><i>ALU</i></td></tr>
64
        <tr><td colspan="2">omsp_register_file.v</td>                                                                  <td><i>Register file</i></td></tr>
65
        <tr><td colspan="2">omsp_mem_backbone.v</td>                                                                   <td><i>Memory backbone</i></td></tr>
66
        <tr><td colspan="2">omsp_clock_module.v</td>                                                                   <td><i>Basic Clock Module</i></td></tr>
67
        <tr><td colspan="2">omsp_sfr.v</td>                                                                            <td><i>Special function registers</i></td></tr>
68
        <tr><td colspan="2">omsp_watchdog.v</td>                                                                       <td><i>Watchdog Timer</i></td></tr>
69 69 olivier.gi
        <tr><td colspan="2">omsp_multiplier.v</td>                                                                     <td><i>16x16 Hardware Multiplier</i></td></tr>
70 50 olivier.gi
        <tr><td colspan="2">omsp_dbg.v</td>                                                                            <td><i>Serial Debug Interface main block</i></td></tr>
71
        <tr><td colspan="2">omsp_dbg_hwbrk.v</td>                                                                      <td><i>Serial Debug Interface hardware breakpoint unit</i></td></tr>
72
        <tr><td colspan="2">omsp_dbg_uart.v</td>                                                                       <td><i>Serial Debug Interface UART communication block</i></td></tr>
73 135 olivier.gi
        <tr>
74 166 olivier.gi
      <td colspan="2" rowspan="1" style="vertical-align: top;">omsp_dbg_i2c.v<br>
75
      </td>
76
      <td style="vertical-align: top;"><span style="font-style: italic;">Serial Debug Interface I2C communication block</span><br>
77
      </td>
78
    </tr>
79
<tr>
80 135 olivier.gi
      <td colspan="2" rowspan="1" style="vertical-align: top;">omsp_sync_cell.v</td>
81
      <td style="vertical-align: top;"><i>Simple synchronization module (double flip-flop).</i></td>
82
    </tr>
83
    <tr>
84
      <td colspan="2" rowspan="1" style="vertical-align: top;">omsp_sync_reset.v</td>
85
      <td style="vertical-align: top;"><i>Generic Reset synchronizer (double flip-flop).</i></td>
86
    </tr>
87
    <tr>
88
      <td colspan="2" rowspan="1" style="vertical-align: top;">omsp_clock_gate.v</td>
89
      <td style="vertical-align: top;"><i>Generic Clock gate (NAND2 or LATCH-AND based).</i></td>
90
    </tr>
91
    <tr>
92
      <td colspan="2" rowspan="1" style="vertical-align: top;">omsp_clock_mux.v</td>
93
      <td style="vertical-align: top;"><i>Standard Clock Mux (used in the clock module &amp; watchdog timer).<br>
94
      </i></td>
95
    </tr>
96
    <tr>
97
      <td colspan="2" rowspan="1" style="vertical-align: top;">omsp_and_gate.v</td>
98
      <td style="vertical-align: top;"><i>AND gate module used on sensitive glitch free data paths.<br>
99
      </i></td>
100
    </tr>
101
    <tr>
102
      <td colspan="2" rowspan="1" style="vertical-align: top;">omsp_wakeup_cell.v</td>
103
      <td style="vertical-align: top;"><i>Generic Wake-up module.<br>
104
      </i></td>
105
    </tr>
106
    <tr>
107
      <td colspan="2" rowspan="1" style="vertical-align: top;">omsp_scan_mux.v</td>
108
      <td style="vertical-align: top;"><i>Scan MUX.<br>
109
      </i></td>
110
    </tr>
111
 
112 50 olivier.gi
        <tr><td colspan="2"><b>periph</b></td>                                                                         <td><i><b>Peripherals directory</b></i></td></tr>
113 116 olivier.gi
        <tr><td rowspan="6"><font color="white">abcd</font></td> <td>omsp_gpio.v</td>                                  <td><i>Digital I/O (Port 1 to 6)</i></td></tr>
114
        <tr>
115
      <td style="vertical-align: top;">omsp_timerA_defines.v<br>
116
      </td>
117
      <td style="vertical-align: top;"><i>Timer A configuration file</i></td>
118
    </tr>
119
    <tr>
120
      <td style="vertical-align: top;">omsp_timerA_undefines.v<br>
121
      </td>
122
      <td style="vertical-align: top;"><i>Timer A Verilog `undef file</i></td>
123
    </tr>
124
<tr><td colspan="1">omsp_timerA.v</td>                                                                         <td><i>Timer A</i></td></tr>
125 50 olivier.gi
        <tr><td colspan="1">template_periph_16b.v</td>                                                                 <td><i>Verilog template for 16 bit peripherals</i></td></tr>
126
        <tr><td colspan="1">template_periph_8b.v</td>                                                                  <td><i>Verilog template for 8 bit peripherals</i></td></tr>
127
        <tr><td colspan="4"><b>sim</b></td>                                                                            <td><i><b>Top level simulations directory</b></i></td></tr>
128 166 olivier.gi
        <tr><td colspan="1" rowspan="62" valign="bottom"><font color="white">abcd</font></td> <td colspan="3"><b>rtl_sim</b></td>  <td><i><b>RTL simulations</b></i></td></tr>
129
        <tr><td colspan="1" rowspan="61" valign="bottom"><font color="white">abcd</font></td> <td colspan="2"><b>bin</b></td>      <td><i><b>RTL simulation scripts</b></i></td></tr>
130
        <tr><td colspan="1" rowspan="10" valign="bottom"><font color="white">abcd</font><br>
131
 
132
      </td> <td colspan="1">msp430sim</td>       <td><i>Main simulation script for assembler vector sources (located in the <span style="font-weight: bold;">src</span> directory)<br>
133 116 olivier.gi
</i></td></tr>
134
        <tr>
135
      <td style="vertical-align: top;">msp430sim_c<br>
136
      </td>
137
      <td style="vertical-align: top;"><i>Main simulation script for C vector sources</i><i> (located in the <span style="font-weight: bold;">src-c</span> directory)</i></td>
138
    </tr>
139
<tr><td colspan="1">asm2ihex.sh</td>                                                                           <td><i>Assembly file compilation (Intel HEX file generation)</i></td></tr>
140 50 olivier.gi
        <tr><td colspan="1">ihex2mem.tcl</td>                                                                          <td><i>Verilog program memory file generation</i></td></tr>
141
        <tr><td colspan="1">rtlsim.sh</td>                                                                             <td><i>Verilog Icarus simulation script</i></td></tr>
142 135 olivier.gi
        <tr><td colspan="1">template.x</td>                                                                          <td><i>ASM linker definition file template</i></td></tr>
143 116 olivier.gi
        <tr>
144 166 olivier.gi
      <td style="vertical-align: top;">template_defs.asm<br>
145 135 olivier.gi
      </td>
146 166 olivier.gi
      <td style="vertical-align: top;"><span style="font-style: italic;">Common ASM definition file included in all ".s43" files</span><br>
147
      </td>
148
    </tr>
149
    <tr>
150
      <td style="vertical-align: top;">omsp_config.sh<br>
151
      </td>
152
      <td style="vertical-align: top;"><span style="font-style: italic;">oMSP configuration file.</span><br>
153
      </td>
154
    </tr>
155
    <tr>
156
      <td style="vertical-align: top;">parse_results<br>
157
      </td>
158
      <td style="vertical-align: top;"><span style="font-style: italic;">Script parsing regression log files and generating summary report.</span><br>
159
      </td>
160
    </tr>
161
<tr>
162
 
163 135 olivier.gi
      <td style="vertical-align: top;">cov_*<br>
164
      </td>
165
      <td style="vertical-align: top;"><span style="font-style: italic;">Code coverage scripts for NC-Verilog and ICM</span><br>
166
      </td>
167
    </tr>
168
<tr><td colspan="2"><b>run</b></td>                                                                            <td><i><b>For running RTL simulations</b></i></td></tr>
169
        <tr><td rowspan="7" valign="bottom"><font color="white">abcd</font></td> <td colspan="1">run</td>             <td><i>Run single simulation of a given assembler vector</i></td></tr>
170
        <tr>
171 116 olivier.gi
      <td style="vertical-align: top;">run_c<br>
172
      </td>
173
      <td style="vertical-align: top;"><i>Run single simulation of a given C vector</i></td>
174
    </tr>
175
<tr><td colspan="1">run_all</td>                                                                               <td><i>Run regression of all vectors</i></td></tr>
176
        <tr>
177
      <td style="vertical-align: top;">run_all_mpy<br>
178
      </td>
179
      <td style="vertical-align: top;"><span style="font-style: italic;">Run regression of all hardware multiplier vectors (!!! very long simulation time !!!)</span><br>
180
      </td>
181
    </tr>
182
<tr><td colspan="1">run_disassemble</td>                                                                       <td><i>Disassemble the program memory content of the latest simulation</i></td></tr>
183 135 olivier.gi
        <tr>
184
      <td style="vertical-align: top;">run_coverage_analysis<br>
185
      </td>
186
      <td style="vertical-align: top; font-style: italic;">Performs the coverage report merging of the regression run and starts ICM for the analysis.<br>
187
      </td>
188
    </tr>
189
<tr><td colspan="1">load_waveform.sav</td>                                                                     <td><i>SAV file for gtkWave</i></td></tr>
190 166 olivier.gi
        <tr><td colspan="2"><b>src</b></td>                                                                            <td><i><b>RTL simulation vectors sources (ASM based)<br>
191
</b></i></td></tr>
192 135 olivier.gi
        <tr><td rowspan="36" valign="bottom"><font color="white">abcd</font></td> <td colspan="1">ldscript_example.x<br>
193 116 olivier.gi
</td>        <td><i>MSPGCC toolchain linker script example</i></td></tr>
194
        <tr>
195 135 olivier.gi
      <td style="vertical-align: top;">submit.prj<br>
196
      </td>
197
      <td style="vertical-align: top;"><span style="font-style: italic;">ISIM simulator verilog command file</span><br>
198
      </td>
199
    </tr>
200
<tr>
201 116 olivier.gi
      <td style="vertical-align: top;">submit.f</td>
202
      <td style="vertical-align: top;"><i>Verilog simulator command file</i></td>
203
    </tr>
204 135 olivier.gi
    <tr>
205
      <td style="vertical-align: top;">core.f<br>
206
      </td>
207
      <td style="vertical-align: top;"><span style="font-style: italic;">Command file listing the CPU files only.</span><br>
208
      </td>
209
    </tr>
210 116 olivier.gi
<tr><td colspan="1">sing-op_*.s43</td>                                                                         <td><i>Single-operand assembler vector files</i></td></tr>
211 50 olivier.gi
        <tr><td colspan="1">sing-op_*.v</td>                                                                           <td><i>Single-operand verilog stimulus vector files</i></td></tr>
212
        <tr><td colspan="1">two-op_*.s43</td>                                                                          <td><i>Two-operand assembler vector files</i></td></tr>
213
        <tr><td colspan="1">two-op_*.v</td>                                                                            <td><i>Two-operand verilog stimulus vector files</i></td></tr>
214
        <tr><td colspan="1">c-jump_*.s43</td>                                                                          <td><i>Jump assembler vector files</i></td></tr>
215
        <tr><td colspan="1">c-jump_*.v</td>                                                                            <td><i>Jump verilog stimulus vector files</i></td></tr>
216 135 olivier.gi
        <tr>
217
      <td style="vertical-align: top;">nmi.s43</td>
218
      <td style="vertical-align: top;"><i>NMI assembler vector files</i></td>
219
    </tr>
220
    <tr>
221
      <td style="vertical-align: top;">nmi.v</td>
222
      <td style="vertical-align: top;"><i>NMI verilog stimulus vector files</i></td>
223
    </tr>
224
    <tr>
225
      <td style="vertical-align: top;">cpu_startup_asic.s43</td>
226
      <td style="vertical-align: top;"><i>CPU startup assembler vector files</i></td>
227
    </tr>
228
    <tr>
229
      <td style="vertical-align: top;">cpu_startup_asic.v</td>
230
      <td style="vertical-align: top;"><i>CPU startup stimulus vector files</i></td>
231
    </tr>
232
<tr><td colspan="1">op_modes*.s43</td>                                                                          <td><i>CPU operating modes assembler vector files (CPUOFF, OSCOFF, SCG1)</i></td></tr>
233
        <tr><td colspan="1">op_modes*.v</td>                                                                            <td><i>CPU operating modes verilog stimulus vector files (CPUOFF, OSCOFF, SCG1)</i></td></tr>
234
        <tr><td colspan="1">clock_module*.s43</td>                                                                      <td><i>Basic Clock Module assembler vector files</i></td></tr>
235
        <tr><td colspan="1">clock_module*.v</td>                                                                        <td><i>Basic Clock Module verilog stimulus vector files</i></td></tr>
236
        <tr>
237
      <td style="vertical-align: top;">lp_modes_*.s43</td>
238
      <td style="vertical-align: top;"><i>Low Power modes assembler vector files</i></td>
239
    </tr>
240
    <tr>
241
      <td style="vertical-align: top;">lp_modes_*.v</td>
242
      <td style="vertical-align: top;"><i>Low Power modes verilog stimulus vector files</i></td>
243
    </tr>
244
<tr><td colspan="1">dbg_*.s43</td>                                                                             <td><i>Serial Debug Interface assembler vector files</i></td></tr>
245 50 olivier.gi
        <tr><td colspan="1">dbg_*.v</td>                                                                               <td><i>Serial Debug Interface verilog stimulus vector files</i></td></tr>
246 135 olivier.gi
        <tr>
247
      <td style="vertical-align: top;">sfr.s43</td>
248
      <td style="vertical-align: top;"><i>SFR assembler vector files</i></td>
249
    </tr>
250
    <tr>
251
      <td style="vertical-align: top;">sfr.v</td>
252
      <td style="vertical-align: top;"><i>SFR verilog stimulus vector files</i></td>
253
    </tr>
254
<tr><td colspan="1">gpio_*.s43</td>                                                                            <td><i>Digital I/O assembler vector files</i></td></tr>
255 50 olivier.gi
        <tr><td colspan="1">gpio_*.v</td>                                                                              <td><i>Digital I/O verilog stimulus vector files</i></td></tr>
256
        <tr><td colspan="1">template_periph_*.s43</td>                                                                 <td><i>Peripheral templates assembler vector files</i></td></tr>
257
        <tr><td colspan="1">template_periph_*.v</td>                                                                   <td><i>Peripheral templates verilog stimulus vector files</i></td></tr>
258
        <tr><td colspan="1">wdt_*.s43</td>                                                                             <td><i>Watchdog timer assembler vector files</i></td></tr>
259
        <tr><td colspan="1">wdt_*.v</td>                                                                               <td><i>Watchdog timer verilog stimulus vector files</i></td></tr>
260
        <tr><td colspan="1">tA_*.s43</td>                                                                              <td><i>Timer A assembler vector files</i></td></tr>
261
        <tr><td colspan="1">tA_*.v</td>                                                                                <td><i>Timer A verilog stimulus vector files</i></td></tr>
262 69 olivier.gi
        <tr><td colspan="1">mpy_*.s43</td>                                                                             <td><i>16x16 Multiplier assembler vector files</i></td></tr>
263 135 olivier.gi
        <tr>
264
      <td style="vertical-align: top;">mpy_*.v</td>
265
      <td style="vertical-align: top;"><i>16x16 Multiplier verilog stimulus vector files</i></td>
266
    </tr>
267
    <tr>
268
      <td style="vertical-align: top;">scan.s43</td>
269
      <td style="vertical-align: top;"><i>Scan test assembler vector files</i></td>
270
    </tr>
271
<tr><td colspan="1">scan.v</td>                                                                               <td><i>Scan test verilog stimulus vector files</i></td></tr>
272 166 olivier.gi
        <tr>
273
      <td colspan="2" rowspan="1" style="vertical-align: top;"><span style="font-weight: bold;">src-c</span><br>
274
      </td>
275
      <td style="vertical-align: top;"><i><b>RTL simulation vectors sources (C based)</b></i></td>
276
    </tr>
277
    <tr>
278
      <td colspan="1" rowspan="4" style="vertical-align: top;"><br>
279
      </td>
280
      <td style="vertical-align: top;">coremark_v1.0<br>
281
      </td>
282
      <td style="vertical-align: top; font-style: italic;">CoreMark benchmark<br>
283
      </td>
284
    </tr>
285
    <tr>
286
      <td style="vertical-align: top;">dhrystone_v2.1<br>
287
      </td>
288
      <td style="vertical-align: top; font-style: italic;">Dhrystone benchmark ("official" version)<br>
289
      </td>
290
    </tr>
291
    <tr>
292
      <td style="vertical-align: top;">dhrystone_4mcu<br>
293
      </td>
294
      <td style="vertical-align: top; font-style: italic;">Dhrystone benchmark (MCU adapted)<br>
295
      </td>
296
    </tr>
297
    <tr>
298
      <td style="vertical-align: top;">sandbox<br>
299
      </td>
300
      <td style="vertical-align: top; font-style: italic;">Small playground :-)<br>
301
      </td>
302
    </tr>
303
<tr><td colspan="4"><b>synthesis</b></td>                                                                     <td><i><b>Top level synthesis directory</b></i></td></tr>
304
        <tr><td rowspan="12" valign="bottom"><font color="white">abcd</font></td><td colspan="3"><b>synopsys</b></td><td><i>Synopsys (Design Compiler) directory</i></td></tr>
305
        <tr><td rowspan="8" valign="bottom"><font color="white">abcd</font></td> <td colspan="2">run_syn</td>        <td><i>Run synthesis</i></td></tr>
306
        <tr>
307
      <td colspan="2" rowspan="1" style="vertical-align: top;">run_tmax<br>
308
      </td>
309
      <td style="vertical-align: top;"><span style="font-style: italic;">Run ATPG</span><br>
310
      </td>
311
    </tr>
312
<tr><td colspan="2">synthesis.tcl</td>                                                                         <td><i>Main synthesis TCL script</i></td></tr>
313 50 olivier.gi
        <tr><td colspan="2">library.tcl</td>                                                                           <td><i>Load library, set operating conditions and wire load models</i></td></tr>
314
        <tr><td colspan="2">read.tcl</td>                                                                              <td><i>Read RTL</i></td></tr>
315
        <tr><td colspan="2">constraints.tcl</td>                                                                       <td><i>Set design constrains</i></td></tr>
316 166 olivier.gi
        <tr>
317
      <td colspan="2" rowspan="1" style="vertical-align: top;">tmax.tcl<br>
318
      </td>
319
      <td style="vertical-align: top;"><span style="font-style: italic;">Main TetraMax (ATPG) script.</span><br>
320
      </td>
321
    </tr>
322
<tr><td colspan="2"><b>results</b></td>                                                                       <td><i>Results directory</i></td></tr>
323 100 olivier.gi
        <tr><td colspan="3"><b>actel</b></td>                                                                         <td><i>Actel synthesis setup for area &amp; speed analysis</i></td></tr>
324
        <tr><td colspan="3"><b>altera</b></td>                                                                        <td><i>Altera synthesis setup for area &amp; speed analysis</i></td></tr>
325
        <tr><td colspan="3"><b>xilinx</b></td>                                                                        <td><i>Xilinx synthesis setup for area &amp; speed analysis</i></td></tr>
326
</tbody></table>
327
<br>
328 50 olivier.gi
<a name="3. Directory structure: FGPA projects"></a>
329 100 olivier.gi
<div style="text-align: right;"><a href="#TOC">Top</a></div>
330 50 olivier.gi
<h1>3. Directory structure: FGPA projects</h1>
331
 
332
<a name="3.1 Xilinx Spartan 3 example"></a>
333
<h2>3.1 Xilinx Spartan 3 example</h2>
334
 
335
<table border="1">
336 100 olivier.gi
        <tbody><tr><td colspan="7"><b>fpga</b></td>                                                                                    <td><i><b>openMSP430 FPGA Projects top level directory</b></i></td></tr>
337 166 olivier.gi
        <tr><td rowspan="61" valign="bottom"><font color="white">abcd</font></td> <td colspan="6"><b>xilinx_diligent_s3_board</b></td>  <td><i><b>Xilinx FPGA Project based on the Diligent Spartan-3 board</b></i></td></tr>
338
        <tr><td rowspan="60" valign="bottom"><font color="white">abcd</font></td> <td colspan="5"><b>bench</b></td>             <td><i><b>Top level testbench directory</b></i></td></tr>
339 116 olivier.gi
        <tr><td colspan="1" rowspan="6" valign="bottom"><font color="white">abcd</font></td> <td colspan="4"><b>verilog</b></td>           <td><i></i><br>
340 100 olivier.gi
</td></tr>
341 116 olivier.gi
        <tr><td colspan="1" rowspan="5" valign="bottom"><font color="white">abcd</font></td> <td colspan="3">tb_openMSP430_fpga.v</td>     <td><i>FPGA testbench top level module</i></td></tr>
342 50 olivier.gi
        <tr><td colspan="3">registers.v</td>                                                                                    <td><i>Connections to Core internals for easy debugging</i></td></tr>
343
        <tr><td colspan="3">msp_debug.v</td>                                                                                    <td><i>Testbench instruction decoder and ASCII chain generator for easy debugging</i></td></tr>
344
        <tr><td colspan="3">glbl.v</td>                                                                                         <td><i>Xilinx "glbl.v" file</i></td></tr>
345 116 olivier.gi
        <tr>
346
      <td colspan="3">timescale.v<br>
347
</td>      <td>   <i>Global time scale definition for simulation.</i>  </td>
348
    </tr>
349
<tr><td colspan="5"><b>doc</b></td>                                                                                     <td><i><b>Diverse documentation</b></i></td></tr>
350 50 olivier.gi
        <tr><td rowspan="3"><font color="white">abcd</font></td> <td colspan="4">board_user_guide.pdf</td>                      <td><i>Spartan-3 FPGA Starter Kit Board User Guide</i></td></tr>
351
        <tr><td colspan="4">msp430f1121a.pdf</td>                                                                               <td><i>msp430f1121a Specification</i></td></tr>
352
        <tr><td colspan="4">xapp462.pdf</td>                                                                                    <td><i>Xilinx Digital Clock Managers (DCMs) user guide</i></td></tr>
353
        <tr><td colspan="5"><b>rtl</b></td>                                                                                     <td><i><b>RTL sources</b></i></td></tr>
354 116 olivier.gi
        <tr><td rowspan="10" valign="bottom"><font color="white">abcd</font></td><td colspan="4"><b>verilog</b></td>            <td><br>
355 100 olivier.gi
</td></tr>
356 50 olivier.gi
        <tr><td rowspan="9" valign="bottom"><font color="white">abcd</font></td> <td colspan="3">openMSP430_fpga.v</td>         <td><i>FPGA top level file</i></td></tr>
357
        <tr><td colspan="3">driver_7segment.v</td>                                                                              <td><i>Four-Digit, Seven-Segment LED Display driver</i></td></tr>
358
        <tr><td colspan="3">io_mux.v</td>                                                                                       <td><i>I/O mux for port function selection.</i></td></tr>
359
        <tr><td colspan="3"><b>openmsp430</b></td>                                                                              <td><i><b>Local copy of the openMSP430 core.</b> The *define.v file has been adjusted to the requirements of the project.</i></td></tr>
360
        <tr><td colspan="3"><b>coregen</b></td>                                                                                 <td><i>Xilinx's coregen directory</i></td></tr>
361 166 olivier.gi
        <tr><td rowspan="4" valign="bottom"><font color="white">abcd</font></td> <td rowspan="1" colspan="2">ram_8x512_hi.*<i><br>
362
      </i></td>          <td style="vertical-align: top;"><i>512 Byte RAM (upper byte)</i></td>
363
</tr>
364
        <tr><td rowspan="1" colspan="2">ram_8x512_lo.*<i><br>
365
      </i></td>                                                                               <td style="vertical-align: top;"><i>512 Byte RAM (lower byte)</i></td>
366
</tr>
367
        <tr><td rowspan="1" colspan="2">ram_8x2k_hi.*<i><br>
368
      </i></td>                                                                                <td style="vertical-align: top;"><i>2 kByte RAM (upper byte)</i></td>
369
</tr>
370
        <tr><td rowspan="1" colspan="2">ram_8x2k_lo.*<i><br>
371
      </i></td>                                                                                <td style="vertical-align: top;"><i>2 kByte RAM (lower byte)</i></td>
372
</tr>
373 50 olivier.gi
        <tr><td colspan="5"><b>sim</b></td>                                                                                     <td><i><b>Top level simulations directory</b></i></td></tr>
374
        <tr><td rowspan="11" valign="bottom"><font color="white">abcd</font></td><td colspan="4"><b>rtl_sim</b></td>            <td><i><b>RTL simulations</b></i></td></tr>
375
        <tr><td rowspan="10" valign="bottom"><font color="white">abcd</font></td> <td colspan="3"><b>bin</b></td>               <td><i><b>RTL simulation scripts</b></i></td></tr>
376 166 olivier.gi
        <tr><td rowspan="3" valign="bottom"><font color="white">abcd</font></td> <td rowspan="1" colspan="2">msp430sim<i><br>
377
      </i></td>                <td style="vertical-align: top;"><i>Main simulation script</i></td>
378
</tr>
379
        <tr><td rowspan="1" colspan="2">ihex2mem.tcl<i><br>
380
      </i></td>                                                                                   <td style="vertical-align: top;"><i>Verilog program memory file generation</i></td>
381
</tr>
382
        <tr><td rowspan="1" colspan="2">rtlsim.sh<i><br>
383
      </i></td>                                                                                      <td style="vertical-align: top;"><i>Verilog Icarus simulation script</i></td>
384
</tr>
385 50 olivier.gi
        <tr><td colspan="3"><b>run</b></td>                                                                                     <td><i><b>For running RTL simulations</b></i></td></tr>
386 166 olivier.gi
        <tr><td rowspan="2" valign="bottom"><font color="white">abcd</font></td> <td rowspan="1" colspan="2">run<i><br>
387
      </i></td>                       <td style="vertical-align: top;"><i>Run simulation of a given software project</i></td>
388
</tr>
389
        <tr><td rowspan="1" colspan="2">run_disassemble<i><br>
390
      </i></td>                                                                                <td style="vertical-align: top;"><i>Disassemble the program memory content of the latest simulation</i></td>
391
</tr>
392 50 olivier.gi
        <tr><td colspan="3"><b>src</b></td>                                                                                     <td><i><b>RTL simulation verilog stimulus</b></i></td></tr>
393 166 olivier.gi
        <tr><td rowspan="2" valign="bottom"><font color="white">abcd</font></td> <td rowspan="1" colspan="2">submit.f<i><br>
394
      </i></td>                  <td style="vertical-align: top;"><i>Verilog simulator command file</i></td>
395
</tr>
396
        <tr><td colspan="1">*.v</td>                                                                                          <td><i><br>
397
      </i></td><td style="vertical-align: top;"><i>Stimulus vector for the corresponding software project</i></td>
398
</tr>
399 50 olivier.gi
        <tr><td colspan="5"><b>software</b></td>                                                                                <td><i><b>Software C programs to be loaded in the program memory</b></i></td></tr>
400
        <tr><td rowspan="7" valign="bottom"><font color="white">abcd</font></td><td colspan="4"><b>leds</b></td>                <td><i>LEDs blinking application (from the CDK4MSP project)</i></td></tr>
401 166 olivier.gi
        <tr><td rowspan="5" valign="bottom"><font color="white">abcd</font></td> <td colspan="3">makefile</td>                  <td><br>
402 100 olivier.gi
</td></tr>
403 166 olivier.gi
        <tr><td colspan="3">hardware.h</td>                                                                                     <td><br>
404 100 olivier.gi
</td></tr>
405 166 olivier.gi
        <tr><td colspan="3">main.c</td>                                                                                         <td><br>
406 100 olivier.gi
</td></tr>
407 166 olivier.gi
        <tr><td colspan="3">7seg.h</td>                                                                                         <td><br>
408 100 olivier.gi
</td></tr>
409 166 olivier.gi
        <tr><td colspan="3">7seg.c</td>                                                                                         <td><br>
410 100 olivier.gi
</td></tr>
411 50 olivier.gi
        <tr><td colspan="4"><b>ta_uart</b></td>                                                                                 <td><i>Software UART with Timer_A (from the CDK4MSP project)</i></td></tr>
412
        <tr><td colspan="5"><b>synthesis</b></td>                                                                               <td><i><b>Top level synthesis directory</b></i></td></tr>
413 166 olivier.gi
        <tr><td rowspan="17" valign="bottom"><font color="white">abcd</font></td><td colspan="4"><b>xilinx</b></td>              <td><br>
414 100 olivier.gi
</td></tr>
415 166 olivier.gi
        <tr><td rowspan="16" valign="bottom"><font color="white">abcd</font></td> <td colspan="3">0_create_bitstream.sh</td>       <td><i>Run Xilinx ISE synthesis in a Linux environment</i></td></tr>
416
        <tr><td colspan="3">1_initialize_pmem.sh<br>
417
</td>                                                                           <td><i>Update bitstream's program memory with a given software ELF file<br>
418
</i></td></tr>
419
        <tr>
420
      <td colspan="3" rowspan="1" style="vertical-align: top;">2_generate_prom_file.sh<br>
421
      </td>
422
      <td style="vertical-align: top;"><span style="font-style: italic;">Generate PROM file</span><br>
423
      </td>
424
    </tr>
425
    <tr>
426
      <td colspan="3" rowspan="1" style="vertical-align: top;">3_program_fpga.sh<br>
427
      </td>
428
      <td style="vertical-align: top; font-style: italic;">Program FPGA and on-board flash memory<br>
429
      </td>
430
    </tr>
431
    <tr>
432
      <td colspan="3" rowspan="1" style="vertical-align: top;"><span style="font-weight: bold;">bitstreams</span><br>
433
      </td>
434
      <td style="vertical-align: top;"><br>
435
      </td>
436
    </tr>
437
    <tr>
438
      <td colspan="1" rowspan="3" style="vertical-align: top;"><br>
439
      </td>
440
      <td colspan="2" rowspan="1" style="vertical-align: top;">*.bit<br>
441
      </td>
442
      <td style="vertical-align: top;"><span style="font-style: italic;">Bitstream files</span><br>
443
      </td>
444
    </tr>
445
    <tr>
446
      <td colspan="2" rowspan="1" style="vertical-align: top;">*.mcs<br>
447
      </td>
448
      <td style="vertical-align: top;"><span style="font-style: italic;">PROM files</span><br>
449
      </td>
450
    </tr>
451
    <tr>
452
      <td colspan="2" rowspan="1" style="vertical-align: top;">README.jpg<br>
453
      </td>
454
      <td style="vertical-align: top;"><span style="font-style: italic;">README file</span><br>
455
      </td>
456
    </tr>
457
<tr><td colspan="3"><span style="font-weight: bold;">scripts</span><br>
458
</td>                                                                            <td><i><br>
459
</i></td></tr>
460
        <tr>
461
      <td colspan="1" rowspan="7" style="vertical-align: top;"><br>
462
      </td>
463
      <td colspan="2" rowspan="1" style="vertical-align: top;">ihex2mem.tcl<br>
464
      </td>
465
      <td style="vertical-align: top;"><span style="font-style: italic;">TCL script converting Intel-HEX format to Verilog memory file.</span><br>
466
      </td>
467
    </tr>
468
    <tr>
469
      <td colspan="2" rowspan="1" style="vertical-align: top;">impact_generate<br>
470
_prom_file.batch<br>
471
      </td>
472
      <td style="vertical-align: top;"><span style="font-style: italic;">iMPACT TCL script for PROM file generation.</span><br>
473
      </td>
474
    </tr>
475
    <tr>
476
      <td colspan="2" rowspan="1" style="vertical-align: top;">impact_program<br>
477
_fpga.batch<br>
478
      </td>
479
      <td style="vertical-align: top;"><span style="font-style: italic;">iMPACT TCL script for programing the FPGA and on-board flash memory.</span></td>
480
    </tr>
481
    <tr>
482
      <td colspan="2" rowspan="1" style="vertical-align: top;">memory.bmm<br>
483
      </td>
484
      <td style="vertical-align: top;"><i>FPGA memory description for bitstream's program memory update</i></td>
485
    </tr>
486
    <tr>
487
      <td colspan="2" rowspan="1" style="vertical-align: top;">openMSP430_fpga.ucf</td>
488
      <td style="vertical-align: top;"><i>UCF file</i></td>
489
    </tr>
490
    <tr>
491
      <td colspan="2" rowspan="1" style="vertical-align: top;">openMSP430_fpga.prj</td>
492
      <td style="vertical-align: top;"><i>RTL file list to be synthesized</i></td>
493
    </tr>
494
    <tr>
495
      <td colspan="2" rowspan="1" style="vertical-align: top;">xst_verilog.opt</td>
496
      <td style="vertical-align: top;"><i>Verilog Option File for XST. Among other things, the search path to the include files is specified here.</i></td>
497
    </tr>
498
 
499
 
500
 
501
 
502
 
503 100 olivier.gi
</tbody></table>
504
<br>
505 50 olivier.gi
 
506
<a name="3.2 Altera Cyclone II example"></a>
507 100 olivier.gi
<div style="text-align: right;"><a href="#TOC">Top</a></div>
508 50 olivier.gi
<h2>3.2 Altera Cyclone II example</h2>
509
 
510
 
511
<table border="1">
512 100 olivier.gi
        <tbody><tr><td colspan="7"><b>fpga</b></td>                                                                                    <td><i><b>openMSP430 FPGA Projects top level directory</b></i></td></tr>
513 116 olivier.gi
        <tr><td rowspan="50" valign="bottom"><font color="white">abcd</font></td> <td colspan="6"><b>altera_de1_board</b></td> <td><i><b>Altera FPGA Project based on Cyclone II Starter Development Board</b></i></td></tr>
514
        <tr><td rowspan="49" valign="bottom"><font color="white">abcd</font></td> <td colspan="5">README</td>                   <td><i>README file</i></td></tr>
515 50 olivier.gi
        <tr><td colspan="5"><b>bench</b></td>                                                                                     <td><i><b>Top level testbench directory</b></i></td></tr>
516 116 olivier.gi
        <tr><td colspan="1" rowspan="6" valign="bottom"><font color="white">abcd</font></td> <td colspan="4"><b>verilog</b></td>           <td><i></i><br>
517 100 olivier.gi
</td></tr>
518 116 olivier.gi
        <tr><td colspan="1" rowspan="5" valign="bottom"><font color="white">abcd</font></td> <td colspan="3">tb_openMSP430_fpga.v</td>     <td><i>FPGA testbench top level module</i></td></tr>
519 50 olivier.gi
        <tr><td colspan="3">registers.v</td>                                                                                    <td><i>Connections to Core internals for easy debugging</i></td></tr>
520
        <tr><td colspan="3">msp_debug.v</td>                                                                                    <td><i>Testbench instruction decoder and ASCII chain generator for easy debugging</i></td></tr>
521
        <tr><td colspan="3">altsyncram.v</td>                                                                                   <td><i>Altera verilog model of the altsyncram module.</i></td></tr>
522 116 olivier.gi
        <tr>
523
      <td colspan="3" rowspan="1" style="vertical-align: top;">timescale.v<br>
524
      </td>
525
      <td style="vertical-align: top;"><i>Global time scale definition for simulation.</i>
526
      </td>
527
    </tr>
528
<tr><td colspan="5"><b>doc</b></td>                                                                                     <td><i><b>Diverse documentation</b></i></td></tr>
529 50 olivier.gi
        <tr><td rowspan="3"><font color="white">abcd</font></td> <td colspan="4">DE1_Board_Schematic.pdf</td>                   <td><i>Cyclone II FPGA Starter Development Board Schematics</i></td></tr>
530
        <tr><td colspan="4">DE1_Reference_Manual.pdf</td>                                                                       <td><i>Cyclone II FPGA Starter Development Board Reference Manual</i></td></tr>
531
        <tr><td colspan="4">DE1_User_Guide.pdf</td>                                                                             <td><i>Cyclone II FPGA Starter Development Board User Guide</i></td></tr>
532
        <tr><td colspan="5"><b>rtl</b></td>                                                                                     <td><i><b>RTL sources</b></i></td></tr>
533 116 olivier.gi
        <tr><td rowspan="8" valign="bottom"><font color="white">abcd</font></td><td colspan="4"><b>verilog</b></td>             <td><br>
534 100 olivier.gi
</td></tr>
535 50 olivier.gi
        <tr><td rowspan="7" valign="bottom"><font color="white">abcd</font></td> <td colspan="3">OpenMSP430_fpga.v</td>         <td><i>FPGA top level file</i></td></tr>
536
        <tr><td colspan="3">driver_7segment.v</td>                                                                              <td><i>Four-Digit, Seven-Segment LED Display driver</i></td></tr>
537
        <tr><td colspan="3">io_mux.v</td>                                                                                       <td><i>I/O mux for port function selection.</i></td></tr>
538
        <tr><td colspan="3">ext_de1_sram.v</td>                                                                                 <td><i>Interface with altera DE1's external async SRAM (256kwords x 16bits)</i></td></tr>
539
        <tr><td colspan="3">ram16x512.v</td>                                                                                    <td><i>Single port RAM generated with the megafunction wizard</i></td></tr>
540
        <tr><td colspan="3">rom16x2048.v</td>                                                                                   <td><i>Single port ROM generated with the megafunction wizard</i></td></tr>
541
        <tr><td colspan="3"><b>openmsp430</b></td>                                                                              <td><i><b>Local copy of the openMSP430 core.</b> The *define.v file has been adjusted to the requirements of the project.</i></td></tr>
542
        <tr><td colspan="5"><b>sim</b></td>                                                                                     <td><i><b>Top level simulations directory</b></i></td></tr>
543
        <tr><td rowspan="11" valign="bottom"><font color="white">abcd</font></td><td colspan="4"><b>rtl_sim</b></td>            <td><i><b>RTL simulations</b></i></td></tr>
544
        <tr><td rowspan="10" valign="bottom"><font color="white">abcd</font></td> <td colspan="3"><b>bin</b></td>               <td><i><b>RTL simulation scripts</b></i></td></tr>
545 100 olivier.gi
        <tr><td rowspan="3" valign="bottom"><font color="white">abcd</font></td> <td colspan="2">msp430sim</td>                <td><i>Main simulation script</i></td></tr>
546 50 olivier.gi
        <tr><td colspan="2">ihex2mem.tcl</td>                                                                                   <td><i>Verilog program memory file generation</i></td></tr>
547
        <tr><td colspan="2">rtlsim.sh</td>                                                                                      <td><i>Verilog Icarus simulation script</i></td></tr>
548
        <tr><td colspan="3"><b>run</b></td>                                                                                     <td><i><b>For running RTL simulations</b></i></td></tr>
549
        <tr><td rowspan="2" valign="bottom"><font color="white">abcd</font></td> <td colspan="2">run</td>                       <td><i>Run simulation of a given software project</i></td></tr>
550
        <tr><td colspan="2">run_disassemble</td>                                                                                <td><i>Disassemble the program memory content of the latest simulation</i></td></tr>
551
        <tr><td colspan="3"><b>src</b></td>                                                                                     <td><i><b>RTL simulation verilog stimulus</b></i></td></tr>
552
        <tr><td rowspan="2" valign="bottom"><font color="white">abcd</font></td> <td colspan="2">submit.f</td>                  <td><i>Verilog simulator command file</i></td></tr>
553
        <tr><td colspan="2">*.v</td>                                                                                          <td><i>Stimulus vector for the corresponding software project</i></td></tr>
554
        <tr><td colspan="5"><b>software</b></td>                                                                                <td><i><b>Software C programs to be loaded in the program memory</b></i></td></tr>
555
        <tr><td rowspan="5" valign="bottom"><font color="white">abcd</font></td><td colspan="4"><b>bin</b></td>                 <td><i>Specific binaries required for software development.</i></td></tr>
556 100 olivier.gi
        <tr><td rowspan="3" valign="bottom"><font color="white">abcd</font></td> <td colspan="3">mifwrite.cpp</td>              <td><i>This
557
prog is taken from
558
http://www.johnloomis.org/ece595c/notes/isa/mifwrite.html and slightly
559
changed to satisfy quartus6.1 *.mif eating engine.</i></td></tr>
560 50 olivier.gi
        <tr><td colspan="3">mifwrite.exe</td>                                                                                   <td><i>Windows executable.</i></td></tr>
561
        <tr><td colspan="3">mifwrite</td>                                                                                       <td><i>Linux executable.</i></td></tr>
562
        <tr><td colspan="4"><b>memledtest</b></td>                                                                              <td><i>LEDs blinking application (from the CDK4MSP project)</i></td></tr>
563
        <tr><td colspan="5"><b>synthesis</b></td>                                                                               <td><i><b>Top level synthesis directory</b></i></td></tr>
564 100 olivier.gi
        <tr><td rowspan="5" valign="bottom"><font color="white">abcd</font></td><td colspan="4"><b>altera</b></td>              <td><i></i><br>
565
</td></tr>
566 50 olivier.gi
        <tr><td rowspan="4" valign="bottom"><font color="white">abcd</font></td> <td colspan="3">main.qsf</td>                  <td><i>Global Assignments file</i></td></tr>
567
        <tr><td colspan="3">main.sof</td>                                                                                       <td><i>SOF file</i></td></tr>
568
        <tr><td colspan="3">OpenMSP430_fpga.qpf</td>                                                                            <td><i>Quartus II project file</i></td></tr>
569
        <tr><td colspan="3">openMSP430_fpga_top.v</td>                                                                          <td><i>RTL file list to be synthesized</i></td></tr>
570 100 olivier.gi
</tbody></table>
571
<br>
572
 
573
<a name="3.3 Actel ProASIC3 example"></a>
574
<div style="text-align: right;"><a href="#TOC">Top</a></div>
575
<h2>3.3 Actel ProASIC3 example</h2>
576
 
577
<table border="1">
578
        <tbody><tr><td colspan="6"><b>fpga</b></td>                                                                                    <td><i><b>openMSP430 FPGA Projects top level directory</b></i></td></tr>
579 116 olivier.gi
        <tr><td rowspan="45" valign="bottom"><font color="white">abcd</font></td> <td colspan="5"><b>actel_m1a3pl_dev_kit</b></td> <td><i><b>Actel FPGA Project based on the ProASIC3 M1A3PL development kit<br>
580 100 olivier.gi
</b></i></td></tr>
581
 
582 116 olivier.gi
        <tr><td rowspan="44" style="vertical-align: top;"><font color="white">abcd</font></td>
583 100 olivier.gi
<td colspan="4"><b>bench</b></td>                                                                                     <td><i><b>Top level testbench directory</b></i></td></tr>
584 116 olivier.gi
        <tr><td colspan="1" rowspan="8" valign="bottom"><font color="white">abcd</font></td> <td colspan="3"><b>verilog</b></td>           <td><i></i><br>
585 100 olivier.gi
</td></tr>
586 116 olivier.gi
        <tr><td colspan="1" rowspan="7" valign="bottom"><font color="white">abcd</font></td> <td colspan="2" rowspan="1" style="vertical-align: top;">tb_openMSP430_fpga.v</td>
587 100 olivier.gi
     <td><i>FPGA testbench top level module</i></td></tr>
588
        <tr><td colspan="2" rowspan="1" style="vertical-align: top;">registers.v</td>
589
                                                                                    <td><i>Connections to Core internals for easy debugging</i></td></tr>
590
        <tr><td colspan="2" rowspan="1" style="vertical-align: top;">msp_debug.v</td>
591
                                                                                    <td><i>Testbench instruction decoder and ASCII chain generator for easy debugging</i></td></tr>
592 116 olivier.gi
        <tr>
593
      <td colspan="2" rowspan="1" style="vertical-align: top;">dbg_uart_tasks.v<br>
594
      </td>
595
      <td style="vertical-align: top;"><i>UART tasks for the serial debug interface.</i></td>
596
    </tr>
597
    <tr>
598
      <td colspan="2" rowspan="1" style="vertical-align: top;">timescale.v<br>
599
      </td>
600
      <td style="vertical-align: top;"><i>Global time scale definition for simulation.</i></td>
601
    </tr>
602
<tr><td colspan="2" rowspan="1" style="vertical-align: top;">proasic3l.v</td>
603 100 olivier.gi
                                                                                   <td><i>Actel ProASIC3L library file.<br>
604
</i></td></tr>
605
        <tr>
606
      <td colspan="2" rowspan="1" style="vertical-align: top;">DAC121S101.v<br>
607
      </td>
608
      <td style="vertical-align: top;"><i>Verilog model of National's DAC121S101 12 bit DAC.</i></td>
609
    </tr>
610
<tr><td colspan="4"><b>doc</b></td>                                                                                     <td><i><b>Diverse documentation</b></i></td></tr>
611
        <tr><td rowspan="2"><font color="white">abcd</font></td> <td colspan="3">M1A3PL_DEV_KIT_QS.pdf</td>                   <td><i>Development Kit Quickstart Card.</i></td></tr>
612
        <tr><td colspan="3">M1IGLOO_StarterKit_v1_5_UG.pdf</td>                                                                       <td><i>Development Kit User's Guide.</i></td></tr>
613
 
614
        <tr><td colspan="4"><b>rtl</b></td>                                                                                     <td><i><b>RTL sources</b></i></td></tr>
615
        <tr><td rowspan="7" valign="bottom"><font color="white">abcd</font></td><td colspan="3"><b>verilog</b></td>             <td><br>
616
</td></tr>
617
        <tr><td rowspan="6" valign="bottom"><font color="white">abcd</font></td> <td colspan="2" rowspan="1" style="vertical-align: top;">openMSP430_fpga.v</td>
618
         <td><i>FPGA top level file</i></td></tr>
619
        <tr><td colspan="2" rowspan="1" style="vertical-align: top;">dac_spi_if.v</td>
620
                                                                              <td><i>SPI interface to National's DAC121S101 12 bit DAC.<br>
621
</i></td></tr>
622
        <tr><td colspan="2" rowspan="1" style="vertical-align: top;"><span style="font-weight: bold;">smartgen</span><br>
623
      </td>
624
                                                                                       <td><i>Actel's smartgen directory.</i></td></tr>
625
 
626
        <tr><td style="vertical-align: top;"><font color="white">abcd</font></td>
627
<td colspan="1">dmem_128B.v</td>                                                                                    <td><i>128 Byte RAM (for data memory).<br>
628
</i></td></tr>
629
        <tr><td style="vertical-align: top;"><br>
630
      </td>
631
<td colspan="1">pmem_2kB.v</td>                                                                                   <td><i>2 kByte RAM (for program memory).<br>
632
</i></td></tr>
633
        <tr><td colspan="2" rowspan="1" style="vertical-align: top;"><b>openmsp430</b></td>
634
                                                                              <td><i><b>Local copy of the openMSP430 core.</b> The *define.v file has been adjusted to the requirements of the project.</i></td></tr>
635
        <tr><td colspan="4"><b>sim</b></td>                                                                                     <td><i><b>Top level simulations directory</b></i></td></tr>
636
        <tr><td rowspan="11" valign="bottom"><font color="white">abcd</font></td><td colspan="3"><b>rtl_sim</b></td>            <td><i><b>RTL simulations</b></i></td></tr>
637
 
638
 
639
 
640
        <tr>                                                                                      <td rowspan="10" style="vertical-align: top;"><br>
641
      </td>
642
      <td colspan="2" rowspan="1" style="vertical-align: top;"><span style="font-weight: bold;">bin</span><br>
643
      </td>
644
<td style="font-style: italic;"><span style="font-weight: bold;">RTL simulation scripts</span><br>
645
</td></tr>
646
        <tr>
647
      <td colspan="1" rowspan="3" style="vertical-align: top;"><br>
648
      </td>
649
      <td style="vertical-align: top;">msp430sim<br>
650
      </td>
651
      <td style="vertical-align: top;">Main simulation script<br>
652
      </td>
653
    </tr>
654
    <tr>
655
      <td style="vertical-align: top;">ihex2mem.tcl<br>
656
      </td>
657
      <td style="vertical-align: top;">Verilog program memory file generation<br>
658
      </td>
659
    </tr>
660
    <tr>
661
      <td style="vertical-align: top;">rtlsim.sh<br>
662
      </td>
663
      <td style="vertical-align: top;">Verilog Icarus simulation script<br>
664
      </td>
665
    </tr>
666
<tr><td colspan="2" rowspan="1" style="vertical-align: top;"><b>run</b></td>
667
                                                                                     <td><i><b>For running RTL simulations</b></i></td></tr>
668
 
669
        <tr>                                                                                <td colspan="1" rowspan="2" style="vertical-align: top;"><br>
670
      </td>
671
      <td style="vertical-align: top;">run<br>
672
      </td>
673
<td><i>Run simulation of a given software project<br>
674
</i></td></tr>
675
        <tr>
676
      <td style="vertical-align: top;">run_disassemble<br>
677
      </td>
678
      <td style="vertical-align: top;"><i>Disassemble the program memory content of the latest simulation</i></td>
679
    </tr>
680
<tr><td colspan="2" rowspan="1" style="vertical-align: top;"><b>src</b></td>
681
                                                                                     <td><i><b>RTL simulation verilog stimulus</b></i></td></tr>
682
 
683
        <tr>
684
      <td colspan="1" rowspan="2" style="vertical-align: top;"><br>
685
      </td>
686
      <td style="vertical-align: top;">submit.f<br>
687
      </td>
688
      <td style="vertical-align: top;"><span style="font-style: italic;">Verilog simulator command file</span><br>
689
      </td>
690
    </tr>
691
<tr>                                                                                          <td style="vertical-align: top;">*.v<br>
692
      </td>
693
<td><i>Stimulus vector for the corresponding software project</i></td></tr>
694
        <tr><td colspan="4"><b>software</b></td>                                                                                <td><i><b>Software C programs to be loaded in the program memory</b></i></td></tr>
695
 
696
 
697
 
698
 
699
        <tr><td colspan="1" rowspan="2" style="vertical-align: top;"><br>
700
      </td>
701
<td colspan="3"><span style="font-weight: bold;">spacewar</span><br>
702
</td>                                                                              <td><span style="font-style: italic;">SpaceWar oscilloscope game.</span><br>
703
</td></tr>
704
        <tr>
705
      <td style="vertical-align: top;"><br>
706
      </td>
707 116 olivier.gi
      <td colspan="3" rowspan="1" style="vertical-align: top; text-align: center;"><img src="usercontent,img,1299013492" alt="Spacewar" title="Spacewar" width="25%"><br>
708 100 olivier.gi
      </td>
709
    </tr>
710
<tr><td colspan="4"><b>synthesis</b></td>                                                                               <td><i><b>Top level synthesis directory</b></i></td></tr>
711
        <tr><td rowspan="8" valign="bottom"><font color="white">abcd</font></td><td colspan="3"><b>actel</b></td>              <td><br>
712
</td></tr>
713
        <tr><td rowspan="7" valign="bottom"><font color="white">abcd</font></td> <td colspan="2" rowspan="1" style="vertical-align: top;">prepare_implementation.tcl<br>
714
      </td>
715
                  <td style="font-style: italic;">Generate required files prior synthesis and P&amp;R.<br>
716
</td></tr>
717
        <tr><td colspan="2" rowspan="1" style="vertical-align: top;">synplify.tcl<br>
718
      </td>
719
                                                                                       <td style="font-style: italic;">Synplify template for the synthesis run.<br>
720
</td></tr>
721
        <tr><td colspan="2" rowspan="1" style="vertical-align: top;">libero_designer.tcl<br>
722
      </td>
723
                                                                            <td style="font-style: italic;">Libero Designer template for the P&amp;R run.<br>
724
</td></tr>
725
        <tr>
726
      <td colspan="2" rowspan="1" style="vertical-align: top;">design_files.v<br>
727
      </td>
728
      <td style="vertical-align: top; font-style: italic;">RTL file list to be synthesized.<br>
729
      </td>
730
    </tr>
731
    <tr>
732
      <td colspan="2" rowspan="1" style="vertical-align: top;">design_constraints.pre.sdc<br>
733
      </td>
734
      <td style="vertical-align: top; font-style: italic;">Synthesis timing constraints.<br>
735
      </td>
736
    </tr>
737
    <tr>
738
      <td colspan="2" rowspan="1" style="vertical-align: top;">design_constraints.post.sdc<br>
739
      </td>
740
      <td style="vertical-align: top; font-style: italic;">P&amp;R timing constraints.<br>
741
      </td>
742
    </tr>
743
<tr><td colspan="2" rowspan="1" style="vertical-align: top;">design_constraints.pdc<br>
744
      </td>
745
                                                                          <td style="font-style: italic;">P&amp;R physical constraints.<br>
746
</td></tr>
747
</tbody></table>
748
 
749
<br>
750 50 olivier.gi
<a name="4. Directory structure: Software Development Tools"></a>
751 100 olivier.gi
<div style="text-align: right;"><a href="#TOC">Top</a></div>
752 50 olivier.gi
<h1>4. Directory structure: Software Development Tools</h1>
753
 
754
<table border="1">
755 116 olivier.gi
        <tbody><tr><td colspan="4"><b>tools</b></td>                                                                                   <td><i><b>openMSP430 Software Development Tools top level directory</b></i></td></tr>
756
        <tr>
757 166 olivier.gi
      <td colspan="1" rowspan="21" style="vertical-align: top;"><font color="white">abcd</font></td>
758 116 olivier.gi
      <td colspan="3" rowspan="1" style="vertical-align: top;">omsp_alias.xml<br>
759
      </td>
760
      <td style="vertical-align: top;"><span style="font-style: italic;">This
761
XML file allows the software development tools to identify a openMSP430
762
implementation, and add customized extra information (Alias, URL, ...).</span><br>
763
      </td>
764
    </tr>
765
<tr> <td colspan="3"><b>bin</b></td>               <td><i><b>Contains the main TCL scripts (and the windows executable files if generated)<br>
766
</b></i></td></tr>
767
        <tr><td rowspan="4" valign="bottom"><font color="white">abcd</font></td> <td colspan="2">openmsp430-loader.tcl</td>    <td><i>Simple command line boot loader</i></td></tr>
768
 
769
        <tr><td colspan="2">openmsp430-minidebug.tcl</td>                                                                       <td><i>Minimalistic debugger with simple GUI</i></td></tr>
770
 
771
        <tr><td colspan="2">openmsp430-gdbproxy.tcl</td>                                                                        <td><i>GDB Proxy server to be used together with MSP430-GDB and the Eclipse, DDD, or Insight graphical front-ends<br>
772
</i></td></tr>
773
        <tr><td colspan="2">README.TXT</td>                                                                                     <td><i>README file regarding the use of TCL scripts in a Windows environment.</i></td></tr>
774
 
775
        <tr><td colspan="3"><b>lib</b></td>                                                                                     <td><i><b>Common library</b></i></td></tr>
776 166 olivier.gi
        <tr><td colspan="1" rowspan="7" valign="bottom"><font color="white">abcd</font></td><td colspan="2"><b>tcl-lib</b></td>             <td><i><b>Common TCL library</b></i></td></tr>
777
        <tr><td colspan="1" rowspan="6" valign="bottom"><font color="white">abcd</font></td> <td rowspan="1" colspan="1">dbg_uart_generic.tcl<i><br>
778
      </i></td>              <td style="vertical-align: top;"><i>Low level Generic UART communication functions</i></td>
779 116 olivier.gi
</tr>
780 166 olivier.gi
        <tr>
781
      <td style="vertical-align: top;">dbg_i2c_usb-iss.tcl<br>
782
      </td>
783
      <td style="vertical-align: top;"><i>Low level I2C communication functions for the USB-ISS adapter<br>
784
      </i></td>
785
    </tr>
786
    <tr>
787
      <td style="vertical-align: top;">dbg_utils.tcl</td>
788
      <td style="vertical-align: top;"><i>Low level "COMx:" "/dev/tty" communication functions</i></td>
789
    </tr>
790
<tr><td rowspan="1" colspan="1">dbg_functions.tcl<i><br>
791 116 olivier.gi
      </i></td>                                                                              <td style="vertical-align: top;"><i>Main utility functions for the openMSP430 serial debug interface</i></td>
792
</tr>
793
        <tr><td rowspan="1" colspan="1">combobox.tcl<i><br>
794
      </i></td>                                                                                   <td style="vertical-align: top;"><i>A combobox listbox widget written in pure tcl (from Bryan Oakley)</i></td>
795
</tr>
796
        <tr><td colspan="1">xml.tcl</td>                                                                                        <td style="vertical-align: top;"><i>Simple XML parser (from Keith Vetter)</i></td>
797
</tr>
798
        <tr><td colspan="3"><b>openmsp430-gdbproxy</b></td>                                                                     <td><i><b>GDB Proxy server main project directory</b></i></td></tr>
799
        <tr><td rowspan="6" valign="bottom"><font color="white">abcd</font></td> <td colspan="2">openmsp430-gdbproxy.tcl</td>  <td><i>GDB Proxy server main TCL Script (symbolic link with the script in the <b>bin</b> directory)</i></td></tr>
800
        <tr><td colspan="2">server.tcl</td>                                                                                     <td><i>TCP/IP Server utility functions. Send/Receive RSP packets from GDB.</i></td></tr>
801
        <tr><td colspan="2">commands.tcl</td>                                                                                   <td><i>RSP command execution functions.</i></td></tr>
802
        <tr><td colspan="2"><b>doc</b></td>                                                                                     <td><i><b>Some documentation regarding GDB and the RSP protocol.</b></i></td></tr>
803
        <tr><td rowspan="2"><font color="white">abcd</font></td> <td rowspan="1" colspan="1">ew_GDB_RSP.pdf<i><br>
804
      </i></td>                            <td style="vertical-align: top;"><i>Document from Bill Gatliff: Embedding with GNU: the gdb Remote Serial Protocol</i></td>
805
</tr>
806
        <tr><td rowspan="1" colspan="1">Howto-GDB_Remote_Serial_Protocol.pdf<i><br>
807
      </i></td>                                                           <td style="vertical-align: top;"><i>Document from Jeremy Bennett (Embecosm): Howto: GDB Remote Serial Protocol - Writing a RSP Server</i></td>
808
</tr>
809 135 olivier.gi
 
810
 
811
 
812
 
813
 
814 100 olivier.gi
</tbody></table>
815
<br>
816
<div style="text-align: right;"><a href="#TOC">Top</a></div>
817 50 olivier.gi
 
818 100 olivier.gi
</body></html>

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.