024b138e648c5827cae7a01046d4a1cdd896e9cd
[fw/sdcc] / sim / ucsim / doc / invoke.html
1 <html>
2 <head>
3 <title>UCSIM: Invokation</title>
4 </head>
5
6 <body bgcolor="white">
7
8 <h1>Starting the simulator</h1>
9
10 There are separate programs to simulate different microcontroller
11 families:
12
13 <p>MCS51 family is simulated by <b>s51</b>
14 <br>AVR family is simulated by <b>savr</b>
15 <br>Z80 processor is simulated by <b>sz80</b>
16
17 <p>The simulator can be started in the following way:
18
19 <p><tt><font color="blue">$</font> s51 [-hHVvP] [-p prompt] [-t CPU]
20 [-X freq[k|M]] [-c file] [-s file] [-S optionlist] [-Z portnum]
21 [files...]</tt>
22
23 <p>Specified files must be names of Intel hex files. Simulator loads
24 them in specified order into the ROM of the simulated system.
25
26 <p>Options:
27
28 <dl><dt><tt><b>-t CPU</b></tt>
29
30 <dd>Type of CPU. Recognized types are: 51, 8051, 8751, C51, 80C51,
31 87C51, 31, 8031, C31, 80C31, 52, 8052, 8752, C52, 80C52, 87C52, 32,
32 8032, C32, 80C32, 51R, 51RA, 51RB, 51RC, C51R, C51RA, C51RB, C51RC,
33 89C51R, 251, C251, DS390, DS390F. Note that recognition of a CPU type
34 as option does not mean that the simulator can simulate that kind of
35 CPU. Default type is C51.
36 <br>DS390 supports Dallas DS80C390 24 bit flat mode, dual-dptr operations, etc.
37 DS390F is the same as DS390, but it starts already in 24 bit flat mode
38 (ACON = 0xFA instead of 0xF8). DS390F is needed to run programs compiled
39 with sdcc -mds390.
40
41 <br>See <a href="cpu_types.html">how to select CPU type</a>.
42
43 <dt><tt><b>-X freq[k|M]</b></tt>
44
45 <dd>XTAL frequency is <b>freq</b> Hertz. <b>k</b> or <b>M</b> can be
46 used to specify frequency in kHZ or MHz. Space is not allowed between
47 the number and the <b>k</b> or <b>M</b>. Default value is 11059200 Hz.
48
49 <a name="coption"><dt><tt><b>-c file</b></tt></a>
50
51 <dd>Open command console on <b>file</b>. Command consoles are on
52 standard input and output by default. Using this option the console
53 can be opened on any file for example on the serial interface of the
54 computer.
55
56 <a name="Zoption"><dt><tt><b>-Z portnum</b></tt></a>
57
58 <dd>Listen for incoming connections on port <b>portnum</b>. Using this
59 option <i>uCsim</i> can serve multiple consoles. You can get a console
60 by simply telnet into machine running <i>uCsim</i> to port
61 <b>portnumber</b>. This option is not available on platforms which
62 doesn't support BSD networking.
63
64 <br>See <a href="mulcons.html">how to use multiple consoles</a>.
65
66 <dt><tt><b>-s file</b></tt>
67
68 <dd>Connect serial interface of the simulated microcontroller to the
69 <b>file</b>. Nothing is used by default which means that characters
70 transmitted by serial interface of the simulated microcontroller go to
71 nowhere and it will never receive anything. If you are going to
72 communicate with serial interface interactively the best idea is to
73 specify a teminal with -s option.
74
75 <dt><tt><b>-S in=file,out=file</b></tt>
76
77 <dd>Using this option you can specify different files for input and
78 output streams that <i>uCsim</i> uses to simulate microprocessor's
79 serial interface.
80
81 <br>See <a href="serial.html">more about serial interface
82 simulation</a>.
83
84 <dt><tt><b>-p prompt</b></tt>
85
86 <dd>Using this option you can specify any string to be the prompt of
87 command interpreter, for example:
88
89 <pre><font color="blue">$</font> s51 -p "s51> "
90 <font color="green">ucsim 0.2.12, Copyright (C) 1997 Daniel Drotos, Talker Bt.
91 ucsim comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
92 This is free software, and you are welcome to redistribute it
93 under certain conditions; type `show c' for details.
94 s51> </font></pre>
95
96 <dt><tt><b>-P</b></tt>
97
98 <dd>Prompt will be a null ('\0') character. This feature can be
99 useful for programs which controlls simulator through a pipe.
100
101 <dt><tt><b>-V</b></tt>
102
103 <dd>Verbose mode. The simulator notifies you about some kind of
104 internal actions for example interrupts. Messages are printed on
105 command console.
106
107 <dt><tt><b>-v</b></tt>
108
109 <dd>Print out version number and stop.
110
111 <dt><tt><b>-H</b></tt>
112
113 <dd>Print out types of known CPUs. Names printed out by this option
114 can be used to determine CPU type using <tt><b>-t</b></tt> option.
115
116 <dt><tt><b>-h</b></tt>
117
118 <dd>Print out a short help about the options and stop.
119
120 </dl>
121
122
123 <hr>
124
125 </body>
126 </html>