sdcc/sim/ucsim/docs/ucsim.1

   1 .TH UCSIM 1
   2
   3 .SH NAME
   4 uCsim \- Micro\-controller simulator
   5
   6 .SH SYNOPSIS
   7 .B ucsim_i8051
   8 .br
   9 .B ucsim_51
  10 .br
  11 .B ucsim_xa
  12 .br
  13 .B ucsim_z80
  14 .br
  15 .B ucsim_tlcs
  16 .br
  17 .B ucsim_rxk
  18 .br
  19 .B ucsim_i8085
  20 .br
  21 .B ucsim_avr
  22 .br
  23 .B ucsim_pdk
  24 .br
  25 .B ucsim_st7
  26 .br
  27 .B ucsim_stm8
  28 .br
  29 .B ucsim_p1516
  30 .br
  31 .B ucsim_m6800
  32 .br
  33 .B ucsim_m6809
  34 .br
  35 .B ucsim_m68hc08
  36 .br
  37 .B ucsim_m68hc11
  38 .br
  39 .B ucsim_m68hc12
  40 .br
  41 .B ucsim_mos6502
  42 .br
  43 .B ucsim_plaze
  44 .br
  45 .B ucsim_f8
  46 .br
  47 .B ucsim_oisc
  48 .br
  49 .RS
  50 .B \-a nr
  51 .B \-b
  52 .B \-B
  53 .B \-c file
  54 .B \-C cfg_file
  55
  56 .B \-e command
  57 .B \-E
  58 .B \-g
  59 .B \-G
  60 .B \-h
  61 .B \-H
  62 .B \-I options
  63 .B \-k portnum
  64 .B \-l
  65 .B \-o colors
  66 .B \-p prompt
  67 .B \-P
  68 .B \-R seed
  69 .B \-s file
  70 .B \-S options
  71 .B \-t cpu_type
  72 .B \-U uartnr
  73 .B \-u hw
  74 .B \-v
  75 .B \-V
  76 .B \-w
  77 .B \-X freq[k|M]
  78 .B \-z portnum
  79 .B \-Z portnum
  80 .RE
  81
  82 .SH DESCRIPTION
  83 uCsim is a microcontroller, microprocessor simulator for several
  84 processor families. It can be started as
  85 .B ucsim_XXXX
  86 command, where XXXX specifies the simulated processor type. Eg.
  87 .I ucsim_51
  88 starts Intel MCS51 microcontroller simulator,
  89 .I ucsim_z80
  90 starts Zilog Z80 microprocessor simulator, etc.
  91
  92 .SH OPTIONS
  93
  94 .B Options of the command
  95
  96 .TP
  97 .B \-a nr
  98 Specify size of variable space (default=256).
  99
 100 .TP
 101 .B \-b
 102 Black & white (non-color) theme.
 103
 104 .TP
 105 .B \-B
 106 Beep on breakpoints.
 107
 108 .TP
 109 .B \-c file
 110 Open command console on
 111 .I file
 112 (use \- for std in/out).
 113
 114 .TP
 115 .B \-C file
 116 Read initial commands from
 117 .I file
 118 and execute them.
 119
 120
 121 .TP
 122 .B \-e command
 123 Execute
 124 .I command
 125 at program startup (before config file).
 126
 127 .TP
 128 .B \-E
 129 Go, start simulation in emulation mode.
 130
 131 .TP
 132 .B \-g
 133 Go, start simulation.
 134
 135 .TP
 136 .B \-G
 137 Go, start simulation, quit on stop.
 138
 139 .TP
 140 .B \-h
 141 Print out this help and quit.
 142
 143 .TP
 144 .B \-H
 145 Print out types of known CPUs and quit.
 146
 147 .TP
 148 .B \-I options
 149 .I options
 150 is a comma separated list of options according to simulator
 151 interface. Known options are:
 152 .br
 153 .I if=memory[address]
 154 turn on interface on given memory location.
 155 .br
 156 .I in=file
 157 specify input file for IO.
 158 .br
 159 .I out=file
 160 specify output file for IO.
 161 .PP
 162
 163 .TP
 164 .B \-k portnum
 165 Use
 166 .I localhost:portnum
 167 for serial I/O. This option is obsolete, use \-S instead.
 168
 169 .TP
 170 .B \-l
 171 Use colors of the light theme (default is dark).
 172 .PP
 173
 174 .TP
 175 .B \-o colors
 176 List of color specification: what=colspec,... where colspec is :
 177 separated list of color options e.g.: prompt=b:white:black (bold white
 178 on black).
 179
 180 .TP
 181 .B \-p prompt
 182 Specify string for prompt.
 183
 184 .TP
 185 .B \-P
 186 Prompt is a null ('\\0') character.
 187 .PP
 188
 189 .TP
 190 .B \-q
 191 Quiet mode (implies -b).
 192
 193 .TP
 194 .B \-R seed
 195 Set the random number generator seed.
 196
 197 .TP
 198 .B \-s file
 199 Connect serial interface uart0 to
 200 .I file
 201 This option is obsolete, use \-S instead.
 202
 203 .TP
 204 .B \-S options
 205 .I options
 206 is a comma separated list of options according to serial interface. Know options are:
 207 .br
 208 .I uart=nr
 209 number of uart (default=0)
 210 .br
 211 .I in=file
 212 serial input will be read from file named `file'.
 213 .br
 214 .I out=file
 215 serial output will be written to `file'.
 216 .br
 217 .I port=nr
 218 use localhost:nr as server for serial line.
 219 .br
 220 .I iport=nr
 221 use localhost:nr as server for serial input.
 222 .br
 223 .I oport=nr
 224 use localhost:nr as server for serial onput.
 225 .br
 226 .I raw
 227 perform non-interactive communication even on tty.
 228
 229 .TP
 230 .B \-t cpu_type
 231 Specifies type of the controller. Use \-H to list possible values.
 232
 233 .TP
 234 .B \-U uartnr
 235 Use std console as terminal for UART id=uartnr.
 236
 237 .TP
 238 .B \-u hw
 239 Use std console as display for specified hw.
 240
 241 .TP
 242 .B \-v
 243 Print out version number and quit.
 244
 245 .TP
 246 .B \-V
 247 Verbose mode.
 248
 249 .TP
 250 .B \-w
 251 Writable flash.
 252
 253 .TP
 254 .B \-X freq[k|M]
 255 XTAL frequency in Hz, Use
 256 .I k
 257 or
 258 .I M
 259 suffix to specify frequency in kHz or MHz.
 260
 261 .TP
 262 .B \-z portnum
 263 Listen
 264 .I portnum
 265 for command console.
 266
 267 .TP
 268 .B \-Z portnum
 269 Listen
 270 .I portnum
 271 for command console (no console on stdio).
 272
 273
 274
 275 .SH EXAMPLES
 276 None yet.
 277
 278 .SH "SEE ALSO"
 279 sdcc(1), sdcdb(1), serialview(1).
 280
 281 .SH BUGS
 282 Probably many.
 283
 284 .SH AUTHORS, CONTRIBUTORS
 285 Daniel Drotos,
 286 Gunar Holm,
 287 Sandeep Dutta,
 288 Salvador Eduardo Tropea,
 289 Josef Wolf,
 290 Stephane Meyer,
 291 Larry Doolittle,
 292 Timothy Hurman,
 293 Karl-Max Wagner,
 294 Edmar Wienskoski Jr,
 295 Alexandre Frey,
 296 Kaido Karner,
 297 Kalr Bongers,
 298 Alexis Pavlov,
 299 Davine Zanni,
 300 Anton Persson,
 301 Nicolas Lesser,
 302 Mike Jagdis,
 303 Jiri Simek,
 304 Zbynek Krivka,
 305 Vaclav Peroutka,
 306 Valentin Dudouyt,
 307 Erik Petrich,
 308 Leland Morrison,
 309 Johan Knol.