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