URL
https://opencores.org/ocsvn/openrisc/openrisc/trunk
Subversion Repositories openrisc
Compare Revisions
- This comparison shows the changes necessary to convert path
/openrisc/trunk/or1ksim/doc
- from Rev 440 to Rev 442
- ↔ Reverse comparison
Rev 440 → Rev 442
/or1ksim.info
1,9 → 1,9
This is ../../doc/or1ksim.info, produced by makeinfo version 4.13 from |
../../doc/or1ksim.texi. |
This is ../../or1ksim/doc/or1ksim.info, produced by makeinfo version |
4.13 from ../../or1ksim/doc/or1ksim.texi. |
|
INFO-DIR-SECTION Embedded development |
START-INFO-DIR-ENTRY |
* Or1ksim: (or32-uclinux-or1ksim). The OpenRISC 1000 Architectural |
* Or1ksim: (or32-elf-or1ksim). The OpenRISC 1000 Architectural |
Simulator |
END-INFO-DIR-ENTRY |
|
81,7 → 81,7
OpenRISC 1000 32-bit architecture. If this argument is omitted, it will |
default to OpenRISC 1000 32-bit with a warning |
|
../or1ksim-2010-12-08/configure --target=or32-uclinux ... |
../or1ksim-2010-12-08/configure --target=or32-elf ... |
|
There are several other options available, many of which are standard |
to GNU `configure' scripts. Use `configure --help' to see all the |
239,9 → 239,9
make install |
|
This will install the three variations of the Or1ksim tool, |
`or32-uclinux-sim', `or32-uclinux-psim' and `or32-uclinux-mpsim', the |
Or1ksim library, `libsim', the header file, `or1ksim.h' and this |
documentation in `info' format. |
`or32-elf-sim', `or32-elf-psim' and `or32-elf-mpsim', the Or1ksim |
library, `libsim', the header file, `or1ksim.h' and this documentation |
in `info' format. |
|
The documentation may be created and installed in alternative formats |
(PDF, Postscript, DVI, HTML) with for example: |
285,6 → 285,7
* Standalone Simulator:: |
* Profiling Utility:: |
* Memory Profiling Utility:: |
* Trace Generation:: |
* Simulator Library:: |
* Ethernet TUN/TAP Interface:: |
|
296,7 → 297,7
|
The general form the standalone command is: |
|
or32-uclinux-sim [-vhiqVt] [-f FILE] [--nosrv] [--srv=[N]] |
or32-elf-sim [-vhiqVt] [-f FILE] [--nosrv] [--srv=[N]] |
[-m <n>][-d STR] |
[--enable-profile] [--enable-mprofile] [FILE] |
|
421,7 → 422,7
It may be invoked as a standalone command, or from the Or1ksim CLI. |
The general form the standalone command is: |
|
or32-uclinux-profile [-vhcq] [-g=FILE] |
or32-elf-profile [-vhcq] [-g=FILE] |
|
Many of the options have both a short and a long form. For example |
`-h' or `--help'. |
450,7 → 451,7
|
|
|
File: or1ksim.info, Node: Memory Profiling Utility, Next: Simulator Library, Prev: Profiling Utility, Up: Usage |
File: or1ksim.info, Node: Memory Profiling Utility, Next: Trace Generation, Prev: Profiling Utility, Up: Usage |
|
2.3 Memory Profiling Utility |
============================ |
459,7 → 460,7
be invoked as a standalone command, or from the Or1ksim CLI. The |
general form the standalone command is: |
|
or32-uclinux-mprofile [-vh] [-m=M] [-g=N] [-f=FILE] FROM TO |
or32-elf-mprofile [-vh] [-m=M] [-g=N] [-f=FILE] FROM TO |
|
Many of the options have both a short and a long form. For example |
`-h' or `--help'. |
510,9 → 511,24
|
|
|
File: or1ksim.info, Node: Simulator Library, Next: Ethernet TUN/TAP Interface, Prev: Memory Profiling Utility, Up: Usage |
File: or1ksim.info, Node: Trace Generation, Next: Simulator Library, Prev: Memory Profiling Utility, Up: Usage |
|
2.4 Simulator Library |
2.4 Trace Generation |
==================== |
|
An execution trace can be generated at run time with options passed by |
the command line, or via the operating system's signal passing |
mechanism. |
|
`-t' |
`--trace' |
Dump instruction just executed and any register/memory location |
chaged after each instruction (one line per instruction). |
|
|
File: or1ksim.info, Node: Simulator Library, Next: Ethernet TUN/TAP Interface, Prev: Trace Generation, Up: Usage |
|
2.5 Simulator Library |
===================== |
|
Or1ksim may be used as a static of dynamic library, `libsim.a' or |
760,7 → 776,7
|
File: or1ksim.info, Node: Ethernet TUN/TAP Interface, Prev: Simulator Library, Up: Usage |
|
2.5 Ethernet TUN/TAP Interface |
2.6 Ethernet TUN/TAP Interface |
============================== |
|
When an Ethernet peripheral is configured (*note Ethernet |
790,7 → 806,7
|
File: or1ksim.info, Node: Setting Up a Persistent TAP device, Next: Establishing a Bridge, Up: Ethernet TUN/TAP Interface |
|
2.5.1 Setting Up a Persistent TAP device |
2.6.1 Setting Up a Persistent TAP device |
---------------------------------------- |
|
TUN/TAP devices can be created dynamically, but this requires superuser |
805,7 → 821,7
|
File: or1ksim.info, Node: Establishing a Bridge, Next: Opening the Firewall, Prev: Setting Up a Persistent TAP device, Up: Ethernet TUN/TAP Interface |
|
2.5.2 Establishing a Bridge |
2.6.2 Establishing a Bridge |
--------------------------- |
|
A bridge is a "virtual" local area network interfaces, subsuming two or |
846,7 → 862,7
|
File: or1ksim.info, Node: Opening the Firewall, Next: Disabling Ethernet Filtering, Prev: Establishing a Bridge, Up: Ethernet TUN/TAP Interface |
|
2.5.3 Opening the Firewall |
2.6.3 Opening the Firewall |
-------------------------- |
|
Firewall rules should be added to ensure traffic flows freely through |
860,7 → 876,7
|
File: or1ksim.info, Node: Disabling Ethernet Filtering, Next: Networking from OpenRISC Linux and BusyBox, Prev: Opening the Firewall, Up: Ethernet TUN/TAP Interface |
|
2.5.4 Disabling Ethernet Filtering |
2.6.4 Disabling Ethernet Filtering |
---------------------------------- |
|
Some systems may have ethernet filtering enabled (`ebtables', |
877,7 → 893,7
|
File: or1ksim.info, Node: Networking from OpenRISC Linux and BusyBox, Next: Tearing Down a Bridge, Prev: Disabling Ethernet Filtering, Up: Ethernet TUN/TAP Interface |
|
2.5.5 Networking from OpenRISC Linux and BusyBox |
2.6.5 Networking from OpenRISC Linux and BusyBox |
------------------------------------------------ |
|
The main use of this style of Ethernet interface to Or1ksim is when |
918,7 → 934,7
|
File: or1ksim.info, Node: Tearing Down a Bridge, Prev: Networking from OpenRISC Linux and BusyBox, Up: Ethernet TUN/TAP Interface |
|
2.5.6 Tearing Down a Bridge |
2.6.6 Tearing Down a Bridge |
--------------------------- |
|
There is little reason why a bridge should ever need to be torn down, |
3809,6 → 3825,7
(line 60) |
* --strict-npc: Standalone Simulator. |
(line 100) |
* --trace <1>: Trace Generation. (line 12) |
* --trace: Standalone Simulator. |
(line 39) |
* --verbose: Standalone Simulator. |
3842,6 → 3859,7
* -q <1>: Profiling Utility. (line 30) |
* -q: Standalone Simulator. |
(line 29) |
* -t <1>: Trace Generation. (line 12) |
* -t: Standalone Simulator. |
(line 39) |
* -V: Standalone Simulator. |
4595,6 → 4613,7
(line 141) |
* toggle debug mode (Interactive CLI): Interactive Command Line. |
(line 151) |
* trace generation of Or1ksim: Trace Generation. (line 6) |
* tx_channel (Ethernet configuration): Ethernet Configuration. |
(line 68) |
* txfile (Ethernet configuration): Ethernet Configuration. |
4667,63 → 4686,64
|
|
Tag Table: |
Node: Top814 |
Node: Installation1224 |
Node: Preparation1471 |
Node: Configuring the Build1766 |
Node: Build and Install7910 |
Node: Known Issues8688 |
Node: Usage9743 |
Node: Standalone Simulator9988 |
Node: Profiling Utility14552 |
Node: Memory Profiling Utility15462 |
Node: Simulator Library16827 |
Node: Ethernet TUN/TAP Interface27267 |
Node: Setting Up a Persistent TAP device28350 |
Node: Establishing a Bridge29025 |
Node: Opening the Firewall30708 |
Node: Disabling Ethernet Filtering31199 |
Node: Networking from OpenRISC Linux and BusyBox31824 |
Node: Tearing Down a Bridge33486 |
Node: Configuration34229 |
Node: Configuration File Format34841 |
Node: Configuration File Preprocessing35226 |
Node: Configuration File Syntax35523 |
Node: Simulator Configuration38308 |
Node: Simulator Behavior38599 |
Node: Verification API Configuration43180 |
Node: CUC Configuration45120 |
Node: Core OpenRISC Configuration47112 |
Node: CPU Configuration47614 |
Node: Memory Configuration51733 |
Node: Memory Management Configuration58455 |
Node: Cache Configuration60832 |
Node: Interrupt Configuration63218 |
Node: Power Management Configuration65051 |
Node: Branch Prediction Configuration66328 |
Node: Debug Interface Configuration67688 |
Node: Peripheral Configuration70031 |
Node: Memory Controller Configuration70657 |
Node: UART Configuration74437 |
Node: DMA Configuration77956 |
Node: Ethernet Configuration79823 |
Node: GPIO Configuration84468 |
Node: Display Interface Configuration86101 |
Node: Frame Buffer Configuration88410 |
Node: Keyboard Configuration90274 |
Node: Disc Interface Configuration92512 |
Node: Generic Peripheral Configuration97616 |
Node: Interactive Command Line99911 |
Node: Verification API106885 |
Node: Code Internals111315 |
Node: Coding Conventions111898 |
Node: Global Data Structures116325 |
Node: Concepts118982 |
Ref: Output Redirection119127 |
Ref: Interrupts Internal119665 |
Node: Internal Debugging120818 |
Node: Regression Testing121342 |
Node: GNU Free Documentation License125131 |
Node: Index147538 |
Node: Top826 |
Node: Installation1236 |
Node: Preparation1483 |
Node: Configuring the Build1778 |
Node: Build and Install7918 |
Node: Known Issues8684 |
Node: Usage9739 |
Node: Standalone Simulator10005 |
Node: Profiling Utility14565 |
Node: Memory Profiling Utility15471 |
Node: Trace Generation16831 |
Node: Simulator Library17286 |
Node: Ethernet TUN/TAP Interface27718 |
Node: Setting Up a Persistent TAP device28801 |
Node: Establishing a Bridge29476 |
Node: Opening the Firewall31159 |
Node: Disabling Ethernet Filtering31650 |
Node: Networking from OpenRISC Linux and BusyBox32275 |
Node: Tearing Down a Bridge33937 |
Node: Configuration34680 |
Node: Configuration File Format35292 |
Node: Configuration File Preprocessing35677 |
Node: Configuration File Syntax35974 |
Node: Simulator Configuration38759 |
Node: Simulator Behavior39050 |
Node: Verification API Configuration43631 |
Node: CUC Configuration45571 |
Node: Core OpenRISC Configuration47563 |
Node: CPU Configuration48065 |
Node: Memory Configuration52184 |
Node: Memory Management Configuration58906 |
Node: Cache Configuration61283 |
Node: Interrupt Configuration63669 |
Node: Power Management Configuration65502 |
Node: Branch Prediction Configuration66779 |
Node: Debug Interface Configuration68139 |
Node: Peripheral Configuration70482 |
Node: Memory Controller Configuration71108 |
Node: UART Configuration74888 |
Node: DMA Configuration78407 |
Node: Ethernet Configuration80274 |
Node: GPIO Configuration84919 |
Node: Display Interface Configuration86552 |
Node: Frame Buffer Configuration88861 |
Node: Keyboard Configuration90725 |
Node: Disc Interface Configuration92963 |
Node: Generic Peripheral Configuration98067 |
Node: Interactive Command Line100362 |
Node: Verification API107336 |
Node: Code Internals111766 |
Node: Coding Conventions112349 |
Node: Global Data Structures116776 |
Node: Concepts119433 |
Ref: Output Redirection119578 |
Ref: Interrupts Internal120116 |
Node: Internal Debugging121269 |
Node: Regression Testing121793 |
Node: GNU Free Documentation License125582 |
Node: Index147989 |
|
End Tag Table |
/or1ksim.texi
5,7 → 5,7
@include config.texi |
@dircategory Embedded development |
@direntry |
* Or1ksim: (or32-uclinux-or1ksim). The OpenRISC 1000 Architectural |
* Or1ksim: (or32-elf-or1ksim). The OpenRISC 1000 Architectural |
Simulator |
@end direntry |
|
102,7 → 102,7
default to OpenRISC 1000 32-bit with a warning |
|
@example |
../or1ksim-@value{VERSION}/configure --target=or32-uclinux ... |
../or1ksim-@value{VERSION}/configure --target=or32-elf ... |
@end example |
|
There are several other options available, many of which are standard |
305,8 → 305,8
@end example |
|
This will install the three variations of the @value{OR1KSIM} tool, |
@command{or32-uclinux-sim}, @command{or32-uclinux-psim} and |
@command{or32-uclinux-mpsim}, the @value{OR1KSIM} library, @file{libsim}, the |
@command{or32-elf-sim}, @command{or32-elf-psim} and |
@command{or32-elf-mpsim}, the @value{OR1KSIM} library, @file{libsim}, the |
header file, @file{or1ksim.h} and this documentation in @command{info} format. |
|
The documentation may be created and installed in alternative formats (PDF, |
352,6 → 352,7
* Standalone Simulator:: |
* Profiling Utility:: |
* Memory Profiling Utility:: |
* Trace Generation:: |
* Simulator Library:: |
* Ethernet TUN/TAP Interface:: |
@end menu |
363,7 → 364,7
The general form the standalone command is: |
|
@example |
or32-uclinux-sim [-vhiqVt] [-f @var{file}] [--nosrv] [--srv=[@var{n}]] |
or32-elf-sim [-vhiqVt] [-f @var{file}] [--nosrv] [--srv=[@var{n}]] |
[-m <n>][-d @var{str}] |
[--enable-profile] [--enable-mprofile] [@var{file}] |
@end example |
517,7 → 518,7
the @value{OR1KSIM} CLI. The general form the standalone command is: |
|
@example |
or32-uclinux-profile [-vhcq] [-g=@var{file}] |
or32-elf-profile [-vhcq] [-g=@var{file}] |
@end example |
|
Many of the options have both a short and a long form. For example |
568,7 → 569,7
the @value{OR1KSIM} CLI. The general form the standalone command is: |
|
@example |
or32-uclinux-mprofile [-vh] [-m=@var{m}] [-g=@var{n}] [-f=@var{file}] @var{from} @var{to} |
or32-elf-mprofile [-vh] [-m=@var{m}] [-g=@var{n}] [-f=@var{file}] @var{from} @var{to} |
@end example |
|
Many of the options have both a short and a long form. For example |
637,6 → 638,40
|
@end table |
|
@node Trace Generation |
@section Trace Generation |
@cindex trace generation of @value{OR1KSIM} |
|
An execution trace can be generated at run time with options passed by the command line, or via the operating system's signal passing mechanism. |
|
The following, passed at run time, can be used to create an execution dump. |
|
@table @code |
|
@item -t |
@itemx --trace |
@cindex @code{-t} |
@cindex @code{--trace} |
Dump instruction just executed and any register/memory location chaged |
after each instruction (one line per instruction). |
@end table |
|
Passing a signal @code{SIGUSR1} while the simulator is running toggles trace generation. This can be done with the following command, assuming @value{OR1KSIM}'s executable name is @code{or32-elf-sim}: |
|
@example |
pkill -SIGUSR1 or32-elf-sim |
@end example |
|
This is useful in the case where trace output is desired after a significant amount of simulation time, where it would be inconvenient to generate trace up to that point. |
|
If the @code{pkill} utility is not available, the @code{kill} utility can be used if @value{OR1KSIM}'s process number is known. Use the following to determine the process ID of the @code{or32-elf-sim} and then send the @code{SIGUSR1} command to toggle execution trace generation: |
|
@example |
ps a | grep or32-elf-sim |
kill -SIGUSR1 @emph{process-number} |
@end example |
|
|
@node Simulator Library |
@section Simulator Library |
@cindex library version of @value{OR1KSIM} |
/version.texi
1,4 → 1,4
@set UPDATED 8 December 2010 |
@set UPDATED 9 December 2010 |
@set UPDATED-MONTH December 2010 |
@set EDITION 2010-12-08 |
@set VERSION 2010-12-08 |