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