db9301b3f42050f677cac68bae2265f19c9551c4
[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. Note that recongition of a CPU type as option does
34 not mean that the simulator can simulate that kind of CPU. Default
35 type is C51.
36
37 <br>See <a href="cpu_types.html">how to select CPU type</a>.
38
39 <dt><tt><b>-X freq[k|M]</b></tt>
40
41 <dd>XTAL frequency is <b>freq</b> Hertz. <b>k</b> or <b>M</b> can be
42 used to specify frequency in kHZ or MHz. Space is not allowed between
43 the number and the <b>k</b> or <b>M</b>. Default value is 11059200 Hz.
44
45 <a name="coption"><dt><tt><b>-c file</b></tt></a>
46
47 <dd>Open command console on <b>file</b>. Command consoles are on
48 standard input and output by default. Using this option the console
49 can be opened on any file for example on the serial interface of the
50 computer.
51
52 <a name="Zoption"><dt><tt><b>-Z portnum</b></tt></a>
53
54 <dd>Listen for incoming connections on port <b>portnum</b>. Using this
55 option <i>uCsim</i> can serve multiple consoles. You can get a console
56 by simply telnet into machine running <i>uCsim</i> to port
57 <b>portnumber</b>. This option is not available on platforms which
58 doesn't support BSD networking.
59
60 <br>See <a href="mulcons.html">how to use multiple consoles</a>.
61
62 <dt><tt><b>-s file</b></tt>
63
64 <dd>Connect serial interface of the simulated microcontroller to the
65 <b>file</b>. Nothing is used by default which means that characters
66 transmitted by serial interface of the simulated microcontroller go to
67 nowhere and it will never receive anything. If you are going to
68 communicate with serial interface interactively the best idea is to
69 specify a teminal with -s option.
70
71 <dt><tt><b>-S in=file,out=file</b></tt>
72
73 <dd>Using this option you can specify different files for input and
74 output streams that <i>uCsim</i> uses to simulate microprocessor's
75 serial interface.
76
77 <br>See <a href="serial.html">more about serial interface
78 simulation</a>.
79
80 <dt><tt><b>-p prompt</b></tt>
81
82 <dd>Using this option you can specify any string to be the prompt of
83 command interpreter, for example:
84
85 <pre><font color="blue">$</font> s51 -p "s51> "
86 <font color="green">ucsim 0.2.12, Copyright (C) 1997 Daniel Drotos, Talker Bt.
87 ucsim comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
88 This is free software, and you are welcome to redistribute it
89 under certain conditions; type `show c' for details.
90 s51> </font></pre>
91
92 <dt><tt><b>-P</b></tt>
93
94 <dd>Prompt will be a null ('\0') character. This feature can be
95 useful for programs which controlls simulator through a pipe.
96
97 <dt><tt><b>-V</b></tt>
98
99 <dd>Verbose mode. The simulator notifies you about some kind of
100 internal actions for example interrupts. Messages are printed on
101 command console.
102
103 <dt><tt><b>-v</b></tt>
104
105 <dd>Print out version number and stop.
106
107 <dt><tt><b>-H</b></tt>
108
109 <dd>Print out types of known CPUs. Names printed out by this option
110 can be used to determine CPU type using <tt><b>-t</b></tt> option.
111
112 <dt><tt><b>-h</b></tt>
113
114 <dd>Print out a short help about the options and stop.
115
116 </dl>
117
118
119 <hr>
120
121 </body>
122 </html>