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

Subversion Repositories sc2v

[/] [sc2v/] [trunk/] [README] - Blame information for rev 39

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 35 jcastillo
/*
2
 *  This program is free software; you can redistribute it and/or modify
3
 *  it under the terms of the GNU General Public License as published by
4
 *  the Free Software Foundation; either version 2 of the License, or
5
 *  (at your option) any later version.
6
 *
7
 *  This program is distributed in the hope that it will be useful,
8
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
9
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10
 *  GNU Library General Public License for more details.
11
 *
12
 *  You should have received a copy of the GNU General Public License
13
 *  along with this program; if not, write to the Free Software
14
 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
15
 */
16
 
17
  Authors:
18
 
19
            Pablo Huerta (pablo.huerta@urjc.es)
20
            Javier Castillo (javier.castillo@urjc.es)
21
 
22
  Contributors:
23
 
24
         David Moloney
25
         Harald Devos
26
         Chris Stratford
27
 
28
 
29
INSTRUCTIONS OF USE:
30
 
31
1- Compiling the sources:
32
 
33
The sc2v translator is based on lex and yacc tools. You need lex and yacc
34 39 vasiliev
installed before trying to compile sc2v. On Windows operating systems, you can
35
find them in MinGW package.
36 35 jcastillo
 
37
For compiling the sources just type "make" under the directory you unzipped the
38
fonts. It will generate three executables: sc2v_step1 and sc2v_step2 sc2v_step3.
39
 
40
 
41
2- Translating an SystemC module:
42
 
43
To translate use sc2v.sh script in the /bin directory just writting sc2v.sh module_name
44 39 vasiliev
(or sc2v.bat module_name on windows)
45 35 jcastillo
 
46
3- Format and restrictions of the SystemC files:
47
 
48
        - Each module must have a .h file with the declarations of ports,
49
        signals, and processes, and there must exist a .cpp file with the code
50
        of the processes.
51
 
52
        - For writing to a port or a signal you must ALWAYS use the .write()
53
        method.
54
 
55
        -Macros not fully supported.
56
 
57
        -Only data types: bool, sc_int, sc_bigint, sc_uint and sc_biguint are
58
        supported.
59
 
60
        -No global variables supported.
61
 
62
4- Known bugs
63
 
64
        -The usage of macros and defines may cause some errors.
65
 
66
5- For testing the application we recommend to use the systemcdes,systecaes and
67
systemcmd5 cores, available at www.opencores.org.
68
 
69
 
70
TODO:
71
 
72
        - Repair all known bugs.
73
        - Make macros fully supported.

powered by: WebSVN 2.1.0

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