This is ../../or1ksim/doc/or1ksim.info, produced by makeinfo version
|
This is ../../or1ksim/doc/or1ksim.info, produced by makeinfo version
|
4.13 from ../../or1ksim/doc/or1ksim.texi.
|
4.13 from ../../or1ksim/doc/or1ksim.texi.
|
|
|
INFO-DIR-SECTION Embedded development
|
INFO-DIR-SECTION Embedded development
|
START-INFO-DIR-ENTRY
|
START-INFO-DIR-ENTRY
|
* Or1ksim: (or32-uclinux-or1ksim). The OpenRISC 1000 Architectural
|
* Or1ksim: (or32-uclinux-or1ksim). The OpenRISC 1000 Architectural
|
Simulator
|
Simulator
|
END-INFO-DIR-ENTRY
|
END-INFO-DIR-ENTRY
|
|
|
This file documents the OpenRISC Architectural Simulator, Or1ksim.
|
This file documents the OpenRISC Architectural Simulator, Or1ksim.
|
|
|
Copyright (C) 2008, 2009 Embecosm Limited.
|
Copyright (C) 2008, 2009 Embecosm Limited.
|
|
|
Permission is granted to copy, distribute and/or modify this
|
Permission is granted to copy, distribute and/or modify this
|
document under the terms of the GNU Free Documentation License,
|
document under the terms of the GNU Free Documentation License,
|
Version 1.2 or any later version published by the Free Software
|
Version 1.2 or any later version published by the Free Software
|
Foundation; with no Invariant Sections, with no Front-Cover Texts,
|
Foundation; with no Invariant Sections, with no Front-Cover Texts,
|
and with no Back-Cover Texts. A copy of the license is included
|
and with no Back-Cover Texts. A copy of the license is included
|
in the section entitled "GNU Free Documentation License".
|
in the section entitled "GNU Free Documentation License".
|
|
|
|
|
File: or1ksim.info, Node: Top, Next: Installation, Up: (dir)
|
File: or1ksim.info, Node: Top, Next: Installation, Up: (dir)
|
|
|
Scope of this Document
|
Scope of this Document
|
**********************
|
**********************
|
|
|
This document is the user guide for Or1ksim, the OpenRISC 1000
|
This document is the user guide for Or1ksim, the OpenRISC 1000
|
Architectural Simulator.
|
Architectural Simulator.
|
|
|
* Menu:
|
* Menu:
|
|
|
* Installation::
|
* Installation::
|
* Usage::
|
* Usage::
|
* Configuration::
|
* Configuration::
|
* Interactive Command Line::
|
* Interactive Command Line::
|
* Verification API::
|
* Verification API::
|
|
|
* Code Internals::
|
* Code Internals::
|
|
|
* GNU Free Documentation License:: The license for this documentation
|
* GNU Free Documentation License:: The license for this documentation
|
* Index::
|
* Index::
|
|
|
|
|
File: or1ksim.info, Node: Installation, Next: Usage, Prev: Top, Up: Top
|
File: or1ksim.info, Node: Installation, Next: Usage, Prev: Top, Up: Top
|
|
|
1 Installation
|
1 Installation
|
**************
|
**************
|
|
|
Installation follows standard GNU protocols.
|
Installation follows standard GNU protocols.
|
|
|
* Menu:
|
* Menu:
|
|
|
* Preparation::
|
* Preparation::
|
* Configuring the Build::
|
* Configuring the Build::
|
* Build and Install::
|
* Build and Install::
|
* Known Issues::
|
* Known Issues::
|
|
|
|
|
File: or1ksim.info, Node: Preparation, Next: Configuring the Build, Up: Installation
|
File: or1ksim.info, Node: Preparation, Next: Configuring the Build, Up: Installation
|
|
|
1.1 Preparation
|
1.1 Preparation
|
===============
|
===============
|
|
|
Unpack the software and create a _separate_ directory in which to build
|
Unpack the software and create a _separate_ directory in which to build
|
it:
|
it:
|
|
|
tar jxf or1ksim-2010-11-11.tar.bz2
|
tar jxf or1ksim-2010-11-11.tar.bz2
|
mkdir builddir_or1ksim
|
mkdir builddir_or1ksim
|
cd builddir_or1ksim
|
cd builddir_or1ksim
|
|
|
|
|
File: or1ksim.info, Node: Configuring the Build, Next: Build and Install, Prev: Preparation, Up: Installation
|
File: or1ksim.info, Node: Configuring the Build, Next: Build and Install, Prev: Preparation, Up: Installation
|
|
|
1.2 Configuring the Build
|
1.2 Configuring the Build
|
=========================
|
=========================
|
|
|
Configure the software using the `configure' script in the main
|
Configure the software using the `configure' script in the main
|
directory.
|
directory.
|
|
|
The most significant argument is `--target', which should specify the
|
The most significant argument is `--target', which should specify the
|
OpenRISC 1000 32-bit architecture. If this argument is omitted, it will
|
OpenRISC 1000 32-bit architecture. If this argument is omitted, it will
|
default to OpenRISC 1000 32-bit with a warning
|
default to OpenRISC 1000 32-bit with a warning
|
|
|
../or1ksim-2010-11-11/configure --target=or32-uclinux ...
|
../or1ksim-2010-11-11/configure --target=or32-uclinux ...
|
|
|
There are several other options available, many of which are standard
|
There are several other options available, many of which are standard
|
to GNU `configure' scripts. Use `configure --help' to see all the
|
to GNU `configure' scripts. Use `configure --help' to see all the
|
options. The most useful is `--prefix' to specify a directory for
|
options. The most useful is `--prefix' to specify a directory for
|
installation of the tools.
|
installation of the tools.
|
|
|
For testing (using `make check'), the `--target' parameter may be
|
For testing (using `make check'), the `--target' parameter may be
|
specified, to allow the target tool chain to be selected. If not
|
specified, to allow the target tool chain to be selected. If not
|
specified, it will default to `or32-elf', which is the same prefix used
|
specified, it will default to `or32-elf', which is the same prefix used
|
with the standard OpenRISC toolchain installation script.
|
with the standard OpenRISC toolchain installation script.
|
|
|
A number of Or1ksim specific features in the simulator do require
|
A number of Or1ksim specific features in the simulator do require
|
enabling at configuration. These include
|
enabling at configuration. These include
|
|
|
`--enable-profiling'
|
`--enable-profiling'
|
`--disable-profiling'
|
`--disable-profiling'
|
If enabled, Or1ksim is compiled for profiling with `gprof'. This
|
If enabled, Or1ksim is compiled for profiling with `gprof'. This
|
is disabled by default. Only really of value for developers of
|
is disabled by default. Only really of value for developers of
|
Or1ksim.
|
Or1ksim.
|
|
|
`--enable-execution=simple'
|
`--enable-execution=simple'
|
`--enable-execution=complex'
|
`--enable-execution=complex'
|
`--enable-execution=dynamic'
|
`--enable-execution=dynamic'
|
Or1ksim has developed to improve functionality and performance.
|
Or1ksim has developed to improve functionality and performance.
|
This feature allows three versions of Or1ksim to be built
|
This feature allows three versions of Or1ksim to be built
|
|
|
`--enable-execution=simple'
|
`--enable-execution=simple'
|
Build the original simple interpreting simulator
|
Build the original simple interpreting simulator
|
|
|
`--enable-execution=complex'
|
`--enable-execution=complex'
|
Build a more complex interpreting simulator. Experiments
|
Build a more complex interpreting simulator. Experiments
|
suggest this is 50% faster than the simple simulator. This
|
suggest this is 50% faster than the simple simulator. This
|
is the default.
|
is the default.
|
|
|
`--enable-execution=dynamic'
|
`--enable-execution=dynamic'
|
Build a dynamically compiling simulator. This is the way
|
Build a dynamically compiling simulator. This is the way
|
many modern ISS are built. This represents a work in
|
many modern ISS are built. This represents a work in
|
progress. Currently Or1ksim will compile, but segfaults if
|
progress. Currently Or1ksim will compile, but segfaults if
|
configured with this option.
|
configured with this option.
|
|
|
|
|
The default is `--enable-execution=complex'.
|
The default is `--enable-execution=complex'.
|
|
|
`--enable-ethphy'
|
`--enable-ethphy'
|
`--disable-ethphy'
|
`--disable-ethphy'
|
If enabled, this option allows the Ethernet to be simulated by
|
If enabled, this option allows the Ethernet to be simulated by
|
connecting via a socket (the alternative reads and writes, from
|
connecting via a socket (the alternative reads and writes, from
|
and to files). This must then be configured using the relevant
|
and to files). This must then be configured using the relevant
|
fields in the `ethernet' section of the configuration file. *Note
|
fields in the `ethernet' section of the configuration file. *Note
|
Ethernet Configuration: Ethernet Configuration.
|
Ethernet Configuration: Ethernet Configuration.
|
|
|
The default is for this to be disabled.
|
The default is for this to be disabled.
|
|
|
`--enable-unsigned-xori'
|
`--enable-unsigned-xori'
|
`--disable-unsigned-xori'
|
`--disable-unsigned-xori'
|
Historically, `l.xori', has sign extended its operand. This is
|
Historically, `l.xori', has sign extended its operand. This is
|
inconsistent with the other logical opcodes (`l.andi', `l.ori'),
|
inconsistent with the other logical opcodes (`l.andi', `l.ori'),
|
but in the absence of `l.not', it allows a register to be inverted
|
but in the absence of `l.not', it allows a register to be inverted
|
in a single instruction using:
|
in a single instruction using:
|
|
|
`l.xori rD,rA,-1'
|
`l.xori rD,rA,-1'
|
|
|
This flag causes Or1ksim to treat the immediate operand as
|
This flag causes Or1ksim to treat the immediate operand as
|
unsigned (i.e to zero-extend rather than sign-extend).
|
unsigned (i.e to zero-extend rather than sign-extend).
|
|
|
The default is to sign-extend, so that existing code will continue
|
The default is to sign-extend, so that existing code will continue
|
to work.
|
to work.
|
|
|
Caution: The GNU compiler tool chain makes heavy use of this
|
Caution: The GNU compiler tool chain makes heavy use of this
|
instruction. Using unsigned behavior will require the
|
instruction. Using unsigned behavior will require the
|
compiler to be modified accordingly.
|
compiler to be modified accordingly.
|
|
|
This option is provided for experimentation. A future
|
This option is provided for experimentation. A future
|
version of OpenRISC may adopt this more consistent behavior
|
version of OpenRISC may adopt this more consistent behavior
|
and also provide a `l.not' opcode.
|
and also provide a `l.not' opcode.
|
|
|
`--enable-range-stats'
|
`--enable-range-stats'
|
`--disable-range-stats'
|
`--disable-range-stats'
|
If enabled, this option allows statistics to be collected to
|
If enabled, this option allows statistics to be collected to
|
analyse register access over time. The default is for this to be
|
analyse register access over time. The default is for this to be
|
disabled.
|
disabled.
|
|
|
`--enable-debug'
|
`--enable-debug'
|
`--disable-debug'
|
`--disable-debug'
|
This is a feature of the Argtable2 package used to process
|
This is a feature of the Argtable2 package used to process
|
arguments. If enabled, some debugging features are turned on in
|
arguments. If enabled, some debugging features are turned on in
|
Argtable2. It is provided for completeness, but there is no
|
Argtable2. It is provided for completeness, but there is no
|
reason why this feature should ever be needed by any Or1ksim user.
|
reason why this feature should ever be needed by any Or1ksim user.
|
|
|
`--enable-all-tests'
|
`--enable-all-tests'
|
`--disable-all-tests'
|
`--disable-all-tests'
|
Some of the tests (at the time of writing just one) will not
|
Some of the tests (at the time of writing just one) will not
|
compile without error. If enabled with this flag, all test
|
compile without error. If enabled with this flag, all test
|
programs will be compiled with `make check'.
|
programs will be compiled with `make check'.
|
|
|
This flag is intended for those working on the test package, who
|
This flag is intended for those working on the test package, who
|
wish to get the missing test(s) working.
|
wish to get the missing test(s) working.
|
|
|
|
|
A number of configuration flags have been removed since version 0.3.0,
|
A number of configuration flags have been removed since version 0.3.0,
|
because they led to invalid behavior of Or1ksim. Those removed are:
|
because they led to invalid behavior of Or1ksim. Those removed are:
|
|
|
`--enable-arith-flag'
|
`--enable-arith-flag'
|
`--disable-arith-flag'
|
`--disable-arith-flag'
|
If enabled, this option caused certain instructions to set the flag
|
If enabled, this option caused certain instructions to set the flag
|
(`F' bit) in the supervision register if the result were zero.
|
(`F' bit) in the supervision register if the result were zero.
|
The instructions affected by this were `l.add', `l.addc',
|
The instructions affected by this were `l.add', `l.addc',
|
`l.addi', `l.and' and `l.andi'.
|
`l.addi', `l.and' and `l.andi'.
|
|
|
If set, this caused incorrect behavior. Whether or not flags are
|
If set, this caused incorrect behavior. Whether or not flags are
|
set is part of the OpenRISC 1000 architectural specification. The
|
set is part of the OpenRISC 1000 architectural specification. The
|
only flags which should set this are the "set flag" instructions:
|
only flags which should set this are the "set flag" instructions:
|
`l.sfeq', `l.sfeqi', `l.sfges', `l.sfgesi', `l.sfgeu', `l.sfgeui',
|
`l.sfeq', `l.sfeqi', `l.sfges', `l.sfgesi', `l.sfgeu', `l.sfgeui',
|
`l.sfgts', `l.sfgtsi', `l.sfgtu', `l.sfgtui', `l.sfles',
|
`l.sfgts', `l.sfgtsi', `l.sfgtu', `l.sfgtui', `l.sfles',
|
`l.sflesi', `l.sfleu', `l.sfleui', `l.sflts', `l.sfltsi',
|
`l.sflesi', `l.sfleu', `l.sfleui', `l.sflts', `l.sfltsi',
|
`l.sfltu', `l.sfltui', `l.sfne' and `l.sfnei'.
|
`l.sfltu', `l.sfltui', `l.sfne' and `l.sfnei'.
|
|
|
`--enable-ov-flag'
|
`--enable-ov-flag'
|
`--disable-ov-flag'
|
`--disable-ov-flag'
|
This flag caused certain instructions to set the overflow flag.
|
This flag caused certain instructions to set the overflow flag.
|
If not, those instructions would not set the overflow flat. The
|
If not, those instructions would not set the overflow flat. The
|
instructions affected by this were `l.add', `l.addc', `l.addi',
|
instructions affected by this were `l.add', `l.addc', `l.addi',
|
`l.and', `l.andi', `l.div', `l.divu', `l.mul', `l.muli', `l.or',
|
`l.and', `l.andi', `l.div', `l.divu', `l.mul', `l.muli', `l.or',
|
`l.ori', `l.sll', `l.slli', `l.srl', `l.srli', `l.sra', `l.srai',
|
`l.ori', `l.sll', `l.slli', `l.srl', `l.srli', `l.sra', `l.srai',
|
`l.sub', `l.xor' and `l.xori'.
|
`l.sub', `l.xor' and `l.xori'.
|
|
|
This guaranteed incorrect behavior. The OpenRISC 1000 architecture
|
This guaranteed incorrect behavior. The OpenRISC 1000 architecture
|
specification defines which flags are set by which instructions.
|
specification defines which flags are set by which instructions.
|
|
|
Within the above list, the arithmetic instructions (`l.add',
|
Within the above list, the arithmetic instructions (`l.add',
|
`l.addc', `l.addi', `l.div', `l.divu', `l.mul', `l.muli' and
|
`l.addc', `l.addi', `l.div', `l.divu', `l.mul', `l.muli' and
|
`l.sub'), together with `l.addic' which is missed out, set the
|
`l.sub'), together with `l.addic' which is missed out, set the
|
overflow flag. All the others (`l.and', `l.andi', `l.or',
|
overflow flag. All the others (`l.and', `l.andi', `l.or',
|
`l.ori', `l.sll', `l.slli', `l.srl', `l.srli', `l.sra', `l.srai',
|
`l.ori', `l.sll', `l.slli', `l.srl', `l.srli', `l.sra', `l.srai',
|
`l.xor' and `l.xori') do not.
|
`l.xor' and `l.xori') do not.
|
|
|
|
|
|
|
File: or1ksim.info, Node: Build and Install, Next: Known Issues, Prev: Configuring the Build, Up: Installation
|
File: or1ksim.info, Node: Build and Install, Next: Known Issues, Prev: Configuring the Build, Up: Installation
|
|
|
1.3 Building and Installing
|
1.3 Building and Installing
|
===========================
|
===========================
|
|
|
Build the tool with:
|
Build the tool with:
|
|
|
make all
|
make all
|
|
|
If you have the OpenRISC tool chain and DejaGNU installed, you can
|
If you have the OpenRISC tool chain and DejaGNU installed, you can
|
verify the tool as follows (otherwise omit this step):
|
verify the tool as follows (otherwise omit this step):
|
|
|
make check
|
make check
|
|
|
Install the tool with:
|
Install the tool with:
|
|
|
make install
|
make install
|
|
|
This will install the three variations of the Or1ksim tool,
|
This will install the three variations of the Or1ksim tool,
|
`or32-uclinux-sim', `or32-uclinux-psim' and `or32-uclinux-mpsim', the
|
`or32-uclinux-sim', `or32-uclinux-psim' and `or32-uclinux-mpsim', the
|
Or1ksim library, `libsim', the header file, `or1ksim.h' and this
|
Or1ksim library, `libsim', the header file, `or1ksim.h' and this
|
documentation in `info' format.
|
documentation in `info' format.
|
|
|
The documentation may be created and installed in alternative formats
|
The documentation may be created and installed in alternative formats
|
(PDF, Postscript, DVI, HTML) with for example:
|
(PDF, Postscript, DVI, HTML) with for example:
|
|
|
make pdf
|
make pdf
|
make install-pdf
|
make install-pdf
|
|
|
|
|
File: or1ksim.info, Node: Known Issues, Prev: Build and Install, Up: Installation
|
File: or1ksim.info, Node: Known Issues, Prev: Build and Install, Up: Installation
|
|
|
1.4 Known Problems and Issues
|
1.4 Known Problems and Issues
|
=============================
|
=============================
|
|
|
Full details of outstanding issues may be found in the `NEWS' file in
|
Full details of outstanding issues may be found in the `NEWS' file in
|
the main directory of the distribution. The OpenRISC tracker may be
|
the main directory of the distribution. The OpenRISC tracker may be
|
used to see the current state of these issues and to raise new problems
|
used to see the current state of these issues and to raise new problems
|
and feature requests. It may be found at bugtracker.
|
and feature requests. It may be found at bugtracker.
|
|
|
The following issues are long standing and unlikely to be fixed in
|
The following issues are long standing and unlikely to be fixed in
|
Or1ksim in the near future.
|
Or1ksim in the near future.
|
|
|
* The Supervision Register Little Endian Enable (LEE) bit is
|
* The Supervision Register Little Endian Enable (LEE) bit is
|
ignored. Or1ksim can be built for either little endian or big
|
ignored. Or1ksim can be built for either little endian or big
|
endian use, but that behavior cannot be changed dynamically.
|
endian use, but that behavior cannot be changed dynamically.
|
|
|
* Or1ksim is not reentrant, so a program cannot instantiate multiple
|
* Or1ksim is not reentrant, so a program cannot instantiate multiple
|
instances using the library. This is clearly a problem when
|
instances using the library. This is clearly a problem when
|
considering multi-core applications. However it stems from the
|
considering multi-core applications. However it stems from the
|
original design, and can only be fixed by a complete rewrite. The
|
original design, and can only be fixed by a complete rewrite. The
|
entire source code uses static global constants liberally!
|
entire source code uses static global constants liberally!
|
|
|
|
|
|
|
File: or1ksim.info, Node: Usage, Next: Configuration, Prev: Installation, Up: Top
|
File: or1ksim.info, Node: Usage, Next: Configuration, Prev: Installation, Up: Top
|
|
|
2 Usage
|
2 Usage
|
*******
|
*******
|
|
|
* Menu:
|
* Menu:
|
|
|
* Standalone Simulator::
|
* Standalone Simulator::
|
* Profiling Utility::
|
* Profiling Utility::
|
* Memory Profiling Utility::
|
* Memory Profiling Utility::
|
* Simulator Library::
|
* Simulator Library::
|
|
|
|
|
File: or1ksim.info, Node: Standalone Simulator, Next: Profiling Utility, Up: Usage
|
File: or1ksim.info, Node: Standalone Simulator, Next: Profiling Utility, Up: Usage
|
|
|
2.1 Standalone Simulator
|
2.1 Standalone Simulator
|
========================
|
========================
|
|
|
The general form the standalone command is:
|
The general form the standalone command is:
|
|
|
or32-uclinux-sim [-vhiqVt] [-f FILE] [--nosrv] [--srv=[N]]
|
or32-uclinux-sim [-vhiqVt] [-f FILE] [--nosrv] [--srv=[N]]
|
[-m ][-d STR]
|
[-m ][-d STR]
|
[--enable-profile] [--enable-mprofile] [FILE]
|
[--enable-profile] [--enable-mprofile] [FILE]
|
|
|
Many of the options have both a short and a long form. For example
|
Many of the options have both a short and a long form. For example
|
`-h' or `--help'.
|
`-h' or `--help'.
|
|
|
`-v'
|
`-v'
|
`--version'
|
`--version'
|
Print out the version and copyright notice for Or1ksim and exit.
|
Print out the version and copyright notice for Or1ksim and exit.
|
|
|
`-h'
|
`-h'
|
`--help'
|
`--help'
|
Print out help about the command line options and what they mean.
|
Print out help about the command line options and what they mean.
|
|
|
`-i'
|
`-i'
|
`--interactive'
|
`--interactive'
|
After starting, drop into the Or1ksim interactive command shell.
|
After starting, drop into the Or1ksim interactive command shell.
|
|
|
`-q'
|
`-q'
|
`--quiet'
|
`--quiet'
|
Do not generate any information messages, only error messages.
|
Do not generate any information messages, only error messages.
|
|
|
`-V'
|
`-V'
|
`--verbose'
|
`--verbose'
|
Generate extra output messages (equivalent of specifying the
|
Generate extra output messages (equivalent of specifying the
|
"verbose" option in the simulator configuration section (see *note
|
"verbose" option in the simulator configuration section (see *note
|
Simulator Behavior: Simulator Behavior.).
|
Simulator Behavior: Simulator Behavior.).
|
|
|
`-t'
|
`-t'
|
`--trace'
|
`--trace'
|
Dump instruction just executed and any register/memory location
|
Dump instruction just executed and any register/memory location
|
chaged after each instruction (one line per instruction).
|
chaged after each instruction (one line per instruction).
|
|
|
`-f FILE'
|
`-f FILE'
|
`--file=FILE'
|
`--file=FILE'
|
Read configuration commands from the specified file, looking first
|
Read configuration commands from the specified file, looking first
|
in the current directory, and otherwise in the `$HOME/.or1k'
|
in the current directory, and otherwise in the `$HOME/.or1k'
|
directory. If this argument is not specified, the file `sim.cfg'
|
directory. If this argument is not specified, the file `sim.cfg'
|
in those two locations is used. Failure to find the file is a
|
in those two locations is used. Failure to find the file is a
|
fatal error. *Note Configuration: Configuration, for detailed
|
fatal error. *Note Configuration: Configuration, for detailed
|
information on configuring Or1ksim.
|
information on configuring Or1ksim.
|
|
|
`--nosrv'
|
`--nosrv'
|
Do not start up the "Remote Serial Protocol" debug server. This
|
Do not start up the "Remote Serial Protocol" debug server. This
|
overrides any setting specified in the configuration file. This
|
overrides any setting specified in the configuration file. This
|
option may not be specified with `--srv'. If it is, a rude
|
option may not be specified with `--srv'. If it is, a rude
|
message is printed and the `--nosrv' option is ignored.
|
message is printed and the `--nosrv' option is ignored.
|
|
|
`--srv'
|
`--srv'
|
|
|
`--srv=N'
|
`--srv=N'
|
Start up the "Remote Serial Protocol" debug server. This
|
Start up the "Remote Serial Protocol" debug server. This
|
overrides any setting specified in the configuration file. If the
|
overrides any setting specified in the configuration file. If the
|
parameter, N, is specified, use that as the TCP/IP port for the
|
parameter, N, is specified, use that as the TCP/IP port for the
|
server, otherwise a random value from the private port range
|
server, otherwise a random value from the private port range
|
(41920-65535) will be used. This option may not be specified with
|
(41920-65535) will be used. This option may not be specified with
|
`--nosrv'. If it is, a rude message is printed and the `--nosrv'
|
`--nosrv'. If it is, a rude message is printed and the `--nosrv'
|
option is ignored.
|
option is ignored.
|
|
|
`-m SIZE'
|
`-m SIZE'
|
`--memory=SIZE'
|
`--memory=SIZE'
|
Configure a memory block of SIZE bytes, starting at address zero.
|
Configure a memory block of SIZE bytes, starting at address zero.
|
The size may be followed by `k', `K', `m', `M', `g', `G', to
|
The size may be followed by `k', `K', `m', `M', `g', `G', to
|
indicate kilobytes (2^10 bytes), megabytes (2^20 bytes) and
|
indicate kilobytes (2^10 bytes), megabytes (2^20 bytes) and
|
gigabytes (2^30 bytes).
|
gigabytes (2^30 bytes).
|
|
|
This is mainly intended for use when Or1ksim is used without a
|
This is mainly intended for use when Or1ksim is used without a
|
configuration file, to allow just the processor and memory to be
|
configuration file, to allow just the processor and memory to be
|
set up. This is the equivalent of specifying a configuration
|
set up. This is the equivalent of specifying a configuration
|
memory section with `baseaddr = 0' and `size = SIZE' and all other
|
memory section with `baseaddr = 0' and `size = SIZE' and all other
|
parameters taking their default value.
|
parameters taking their default value.
|
|
|
If a configuration file is also used, it should be sure not to
|
If a configuration file is also used, it should be sure not to
|
specify an overlapping memory block.
|
specify an overlapping memory block.
|
|
|
`-d CONFIG_STRING'
|
`-d CONFIG_STRING'
|
`--debug-config=CONFIG_STRING'
|
`--debug-config=CONFIG_STRING'
|
Enable selected debug messages in Or1ksim. This parameter is for
|
Enable selected debug messages in Or1ksim. This parameter is for
|
use by developers only, and is not covered further here. See the
|
use by developers only, and is not covered further here. See the
|
source code for more details.
|
source code for more details.
|
|
|
`--report-memory-errors'
|
`--report-memory-errors'
|
By default all exceptions are now handled silently. If this
|
By default all exceptions are now handled silently. If this
|
option is specified, bus exceptions will be reported with a
|
option is specified, bus exceptions will be reported with a
|
message to standard error indicating the address at which the
|
message to standard error indicating the address at which the
|
exception occurred.
|
exception occurred.
|
|
|
This was the default behaviour up to Or1ksim 0.4.0. This flag is
|
This was the default behaviour up to Or1ksim 0.4.0. This flag is
|
provided for those who wish to keep that behavior.
|
provided for those who wish to keep that behavior.
|
|
|
`--strict-npc'
|
`--strict-npc'
|
In real hardware, setting the next program counter (NPC, SPR 16),
|
In real hardware, setting the next program counter (NPC, SPR 16),
|
flushes the processor pipeline. The consequence of this is that
|
flushes the processor pipeline. The consequence of this is that
|
until the pipeline refills, reading the NPC will return zero.
|
until the pipeline refills, reading the NPC will return zero.
|
This is typically the case when debugging, since the processor is
|
This is typically the case when debugging, since the processor is
|
stalled.
|
stalled.
|
|
|
Historically, Or1ksim has always returned the value of the NPC,
|
Historically, Or1ksim has always returned the value of the NPC,
|
irrespective of when it is changed. If the `--strict-npc' option
|
irrespective of when it is changed. If the `--strict-npc' option
|
is used, then Or1ksim will mirror real hardware more accurately.
|
is used, then Or1ksim will mirror real hardware more accurately.
|
If the NPC is changed while the processor is stalled, subsequent
|
If the NPC is changed while the processor is stalled, subsequent
|
reads of its value will return 0 until the processor is unstalled.
|
reads of its value will return 0 until the processor is unstalled.
|
|
|
This is not currently the default behavior, since tools such as
|
This is not currently the default behavior, since tools such as
|
GDB have been implemented assuming the historic Or1ksim behavior.
|
GDB have been implemented assuming the historic Or1ksim behavior.
|
However at some time in the future it will become the default.
|
However at some time in the future it will become the default.
|
|
|
`--enable-profile'
|
`--enable-profile'
|
Enable instruction profiling.
|
Enable instruction profiling.
|
|
|
`--enable-mprofile'
|
`--enable-mprofile'
|
Enable memory profiling.
|
Enable memory profiling.
|
|
|
|
|
|
|
File: or1ksim.info, Node: Profiling Utility, Next: Memory Profiling Utility, Prev: Standalone Simulator, Up: Usage
|
File: or1ksim.info, Node: Profiling Utility, Next: Memory Profiling Utility, Prev: Standalone Simulator, Up: Usage
|
|
|
2.2 Profiling Utility
|
2.2 Profiling Utility
|
=====================
|
=====================
|
|
|
This utility analyses instruction profile data generated by Or1ksim.
|
This utility analyses instruction profile data generated by Or1ksim.
|
It may be invoked as a standalone command, or from the Or1ksim CLI.
|
It may be invoked as a standalone command, or from the Or1ksim CLI.
|
The general form the standalone command is:
|
The general form the standalone command is:
|
|
|
or32-uclinux-profile [-vhcq] [-g=FILE]
|
or32-uclinux-profile [-vhcq] [-g=FILE]
|
|
|
Many of the options have both a short and a long form. For example
|
Many of the options have both a short and a long form. For example
|
`-h' or `--help'.
|
`-h' or `--help'.
|
|
|
`-v'
|
`-v'
|
`--version'
|
`--version'
|
Print out the version and copyright notice for the Or1ksim
|
Print out the version and copyright notice for the Or1ksim
|
profiling utility and exit.
|
profiling utility and exit.
|
|
|
`-h'
|
`-h'
|
`--help'
|
`--help'
|
Print out help about the command line options and what they mean.
|
Print out help about the command line options and what they mean.
|
|
|
`-c'
|
`-c'
|
`--cumulative'
|
`--cumulative'
|
Show cumulative sum of cycles in functions
|
Show cumulative sum of cycles in functions
|
|
|
`-q'
|
`-q'
|
`--quiet'
|
`--quiet'
|
Suppress messages
|
Suppress messages
|
|
|
`-g=FILE'
|
`-g=FILE'
|
`--generate=FILE'
|
`--generate=FILE'
|
The data file to analyse. If omitted, the default file,
|
The data file to analyse. If omitted, the default file,
|
`sim.profile' is used.
|
`sim.profile' is used.
|
|
|
|
|
|
|
File: or1ksim.info, Node: Memory Profiling Utility, Next: Simulator Library, Prev: Profiling Utility, Up: Usage
|
File: or1ksim.info, Node: Memory Profiling Utility, Next: Simulator Library, Prev: Profiling Utility, Up: Usage
|
|
|
2.3 Memory Profiling Utility
|
2.3 Memory Profiling Utility
|
============================
|
============================
|
|
|
This utility analyses memory profile data generated by Or1ksim. It may
|
This utility analyses memory profile data generated by Or1ksim. It may
|
be invoked as a standalone command, or from the Or1ksim CLI. The
|
be invoked as a standalone command, or from the Or1ksim CLI. The
|
general form the standalone command is:
|
general form the standalone command is:
|
|
|
or32-uclinux-mprofile [-vh] [-m=M] [-g=N] [-f=FILE] FROM TO
|
or32-uclinux-mprofile [-vh] [-m=M] [-g=N] [-f=FILE] FROM TO
|
|
|
Many of the options have both a short and a long form. For example
|
Many of the options have both a short and a long form. For example
|
`-h' or `--help'.
|
`-h' or `--help'.
|
|
|
`-v'
|
`-v'
|
`--version'
|
`--version'
|
Print out the version and copyright notice for the Or1ksim memory
|
Print out the version and copyright notice for the Or1ksim memory
|
profiling utility and exit.
|
profiling utility and exit.
|
|
|
`-h'
|
`-h'
|
`--help'
|
`--help'
|
Print out help about the command line options and what they mean.
|
Print out help about the command line options and what they mean.
|
|
|
`-m=M'
|
`-m=M'
|
`--mode=M'
|
`--mode=M'
|
Specify the mode out output. Permitted options are
|
Specify the mode out output. Permitted options are
|
|
|
`detailed'
|
`detailed'
|
`d'
|
`d'
|
Detailed output. This is the default if no mode is specified.
|
Detailed output. This is the default if no mode is specified.
|
|
|
`pretty'
|
`pretty'
|
`p'
|
`p'
|
Pretty printed output.
|
Pretty printed output.
|
|
|
`access'
|
`access'
|
`a'
|
`a'
|
Memory accesses only.
|
Memory accesses only.
|
|
|
`width'
|
`width'
|
`w'
|
`w'
|
Access width only.
|
Access width only.
|
|
|
|
|
`-g=N'
|
`-g=N'
|
`--group=N'
|
`--group=N'
|
Group 2^n bits of successive addresses together.
|
Group 2^n bits of successive addresses together.
|
|
|
`-f=FILE'
|
`-f=FILE'
|
`--filename=FILE'
|
`--filename=FILE'
|
The data file to analyse. If not specified, the default,
|
The data file to analyse. If not specified, the default,
|
`sim.profile' is used.
|
`sim.profile' is used.
|
|
|
`FROM'
|
`FROM'
|
`TO'
|
`TO'
|
FROM and TO are respectively the start and end address of the
|
FROM and TO are respectively the start and end address of the
|
region of memory to be analysed.
|
region of memory to be analysed.
|
|
|
|
|
|
|
File: or1ksim.info, Node: Simulator Library, Prev: Memory Profiling Utility, Up: Usage
|
File: or1ksim.info, Node: Simulator Library, Prev: Memory Profiling Utility, Up: Usage
|
|
|
2.4 Simulator Library
|
2.4 Simulator Library
|
=====================
|
=====================
|
|
|
Or1ksim may be used as a static of dynamic library, `libsim.a' or
|
Or1ksim may be used as a static of dynamic library, `libsim.a' or
|
`libsim.so'. When compiling with the static library, the flag, `-lsim'
|
`libsim.so'. When compiling with the static library, the flag, `-lsim'
|
should be added to the link command.
|
should be added to the link command.
|
|
|
The header file `or1ksim.h' contains appropriate declarations of the
|
The header file `or1ksim.h' contains appropriate declarations of the
|
functions exported by the Or1ksim library. These are:
|
functions exported by the Or1ksim library. These are:
|
|
|
-- `or1ksim.h': int or1ksim_init (int ARGC, char *ARGV, void
|
-- `or1ksim.h': int or1ksim_init (int ARGC, char *ARGV, void
|
*CLASS_PTR,
|
*CLASS_PTR,
|
int (*UPR)(void *CLASS_PTR, unsigned long int ADDR, unsigned char
|
int (*UPR)(void *CLASS_PTR, unsigned long int ADDR, unsigned char
|
MASK[], unsigned char RDATA[], int DATA_LEN), int (*UPW)(void
|
MASK[], unsigned char RDATA[], int DATA_LEN), int (*UPW)(void
|
*CLASS_PTR, unsigned long int ADDR, unsigned char MASK[], unsigned
|
*CLASS_PTR, unsigned long int ADDR, unsigned char MASK[], unsigned
|
char WDATA[], int DATA_LEN))
|
char WDATA[], int DATA_LEN))
|
|
|
The initialization function is supplied with a vector of arguments,
|
The initialization function is supplied with a vector of arguments,
|
which are interpreted as arguments to the standalone version (see
|
which are interpreted as arguments to the standalone version (see
|
*note Standalone Simulator: Standalone Simulator.), a pointer to
|
*note Standalone Simulator: Standalone Simulator.), a pointer to
|
the calling class, CLASS_PTR (since the library may be used from
|
the calling class, CLASS_PTR (since the library may be used from
|
C++) and two up-call functions, one for reads, UPR, and one for
|
C++) and two up-call functions, one for reads, UPR, and one for
|
writes, UPW.
|
writes, UPW.
|
|
|
UPW is called for any write to an address external to the model
|
UPW is called for any write to an address external to the model
|
(determined by a `generic' section in the configuration file).
|
(determined by a `generic' section in the configuration file).
|
UPR is called for any reads to an external address. The CLASS_PTR
|
UPR is called for any reads to an external address. The CLASS_PTR
|
is passed back with these upcalls, allowing the function to
|
is passed back with these upcalls, allowing the function to
|
associate the call with the class which originally initialized the
|
associate the call with the class which originally initialized the
|
library. Both UPW and UPR should return zero on success and
|
library. Both UPW and UPR should return zero on success and
|
non-zero otherwise. At the present time the meaning of non-zero
|
non-zero otherwise. At the present time the meaning of non-zero
|
values is not defined but this may change in the future.
|
values is not defined but this may change in the future.
|
|
|
MASK indicates which bytes in the data are to be written or read.
|
MASK indicates which bytes in the data are to be written or read.
|
Bytes to be read/written should have 0xff set in MASK. Otherwise
|
Bytes to be read/written should have 0xff set in MASK. Otherwise
|
the byte should be zero. The adddress, ADDR, is the _full_
|
the byte should be zero. The adddress, ADDR, is the _full_
|
address, since the upcall function must handle all generic
|
address, since the upcall function must handle all generic
|
devices, using the full address for decoding.
|
devices, using the full address for decoding.
|
|
|
Endianness is not a concern, since Or1ksim is transferring byte
|
Endianness is not a concern, since Or1ksim is transferring byte
|
vectors, not multi-byte values.
|
vectors, not multi-byte values.
|
|
|
The result indicates whether the initialization was successful.
|
The result indicates whether the initialization was successful.
|
The integer values are available as an `enum or1ksim', with
|
The integer values are available as an `enum or1ksim', with
|
possible values `OR1KSIM_RC_OK' and `OR1KSIM_RC_BADINIT'.
|
possible values `OR1KSIM_RC_OK' and `OR1KSIM_RC_BADINIT'.
|
|
|
Caution: This is a change from versions 0.3.0 and 0.4.0. It
|
Caution: This is a change from versions 0.3.0 and 0.4.0. It
|
further simplifies the interface, and makes Or1ksim more
|
further simplifies the interface, and makes Or1ksim more
|
consistent with payload representation in SystemC TLM 2.0.
|
consistent with payload representation in SystemC TLM 2.0.
|
|
|
Note: The current implementation of Or1ksim always transfers
|
Note: The current implementation of Or1ksim always transfers
|
single words (4 bytes), using masks if smaller values are
|
single words (4 bytes), using masks if smaller values are
|
required. In this it mimcs the behavior of the WishBone bus.
|
required. In this it mimcs the behavior of the WishBone bus.
|
|
|
|
|
-- `or1ksim.h': int or1ksim_run (double DURATION)
|
-- `or1ksim.h': int or1ksim_run (double DURATION)
|
Run the simulator for the simulated duration specified (in
|
Run the simulator for the simulated duration specified (in
|
seconds). A duration of -1 indicates `run forever'
|
seconds). A duration of -1 indicates `run forever'
|
|
|
The result indicates how the run terminated. The integer values
|
The result indicates how the run terminated. The integer values
|
are available as an `enum or1ksim', with possible values
|
are available as an `enum or1ksim', with possible values
|
`OR1KSIM_RC_OK' (ran for the full duration), `OR1KSIM_RC_BRKPT'
|
`OR1KSIM_RC_OK' (ran for the full duration), `OR1KSIM_RC_BRKPT'
|
(terminated early due to hitting a breakpoint) and
|
(terminated early due to hitting a breakpoint) and
|
`OR1KSIM_RC_HALTED' (terminated early due to hitting `l.nop 1').
|
`OR1KSIM_RC_HALTED' (terminated early due to hitting `l.nop 1').
|
|
|
|
|
-- `or1ksim.h': void or1ksim_reset_duration (double DURATION)
|
-- `or1ksim.h': void or1ksim_reset_duration (double DURATION)
|
Change the duration of a run specified in an earlier call to
|
Change the duration of a run specified in an earlier call to
|
`or1ksim_run'. Typically this is called from an upcall, which
|
`or1ksim_run'. Typically this is called from an upcall, which
|
realizes it needs to change the duration of the run specified in
|
realizes it needs to change the duration of the run specified in
|
the call to `or1ksim_run' that has been interrupted by the upcall.
|
the call to `or1ksim_run' that has been interrupted by the upcall.
|
|
|
The time specified is the amount of time that the run must continue
|
The time specified is the amount of time that the run must continue
|
for (i.e the duration from _now_, not the duration from the
|
for (i.e the duration from _now_, not the duration from the
|
original call to `or1ksim_run').
|
original call to `or1ksim_run').
|
|
|
|
|
-- `or1ksim.h': void or1ksim_set_time_point ()
|
-- `or1ksim.h': void or1ksim_set_time_point ()
|
Set a timing point. For use with `or1ksim_get_time_period'.
|
Set a timing point. For use with `or1ksim_get_time_period'.
|
|
|
|
|
-- `or1ksim.h': double or1ksim_get_time_period ()
|
-- `or1ksim.h': double or1ksim_get_time_period ()
|
Return the simulated time (in seconds) that has elapsed since the
|
Return the simulated time (in seconds) that has elapsed since the
|
last call to `or1ksim_set_time_point'.
|
last call to `or1ksim_set_time_point'.
|
|
|
|
|
-- `or1ksim.h': int or1ksim_is_le ()
|
-- `or1ksim.h': int or1ksim_is_le ()
|
Return 1 (logical true) if the Or1ksim simulation is
|
Return 1 (logical true) if the Or1ksim simulation is
|
little-endian, 0 otherwise.
|
little-endian, 0 otherwise.
|
|
|
|
|
-- `or1ksim.h': unsigned long int or1ksim_clock_rate ()
|
-- `or1ksim.h': unsigned long int or1ksim_clock_rate ()
|
Return the Or1ksim clock rate (in Hz). This is the value
|
Return the Or1ksim clock rate (in Hz). This is the value
|
specified in the configuration file.
|
specified in the configuration file.
|
|
|
|
|
-- `or1ksim.h': void or1ksim_interrupt (int I)
|
-- `or1ksim.h': void or1ksim_interrupt (int I)
|
Generate an edge-triggered interrupt on interrupt line I. The
|
Generate an edge-triggered interrupt on interrupt line I. The
|
interrupt is then immediately cleared automatically. A warning
|
interrupt is then immediately cleared automatically. A warning
|
will be generated and the interrupt request ignored if level
|
will be generated and the interrupt request ignored if level
|
sensitive interrupts have been configured with the programmable
|
sensitive interrupts have been configured with the programmable
|
interrupt controller (*note Interrupt Configuration: Interrupt
|
interrupt controller (*note Interrupt Configuration: Interrupt
|
Configuration.).
|
Configuration.).
|
|
|
|
|
-- `or1ksim.h': void or1ksim_interrupt_set (int I)
|
-- `or1ksim.h': void or1ksim_interrupt_set (int I)
|
Assert a level-triggered interrupt on interrupt line I. The
|
Assert a level-triggered interrupt on interrupt line I. The
|
interrupt must be cleared separately by an explicit call to
|
interrupt must be cleared separately by an explicit call to
|
`or1ksim_interrupt_clear'. A warning will be generated, and the
|
`or1ksim_interrupt_clear'. A warning will be generated, and the
|
interrupt request ignored if edge sensitive interrupts have been
|
interrupt request ignored if edge sensitive interrupts have been
|
configured with the programmable interrupt controller (*note
|
configured with the programmable interrupt controller (*note
|
Interrupt Configuration: Interrupt Configuration.).
|
Interrupt Configuration: Interrupt Configuration.).
|
|
|
|
|
-- `or1ksim.h': void or1ksim_interrupt_clear (int I)
|
-- `or1ksim.h': void or1ksim_interrupt_clear (int I)
|
Clear a level-triggered interrupt on interrupt line I, which was
|
Clear a level-triggered interrupt on interrupt line I, which was
|
previously asserted by a call to `or1ksim_interrupt_set'. A
|
previously asserted by a call to `or1ksim_interrupt_set'. A
|
warning will be generated, and the interrupt request ignored if
|
warning will be generated, and the interrupt request ignored if
|
edge sensitive interrupts have been configured with the
|
edge sensitive interrupts have been configured with the
|
programmable interrupt controller (*note Interrupt Configuration:
|
programmable interrupt controller (*note Interrupt Configuration:
|
Interrupt Configuration.).
|
Interrupt Configuration.).
|
|
|
|
|
-- `or1ksim.h': double or1ksim_jtag_reset ()
|
-- `or1ksim.h': double or1ksim_jtag_reset ()
|
Drive a reset sequence through the JTAG interface. Return the
|
Drive a reset sequence through the JTAG interface. Return the
|
(model) time taken for this action. Remember that the JTAG has
|
(model) time taken for this action. Remember that the JTAG has
|
its own clock, which can be an order of magnitude slower than the
|
its own clock, which can be an order of magnitude slower than the
|
main clock, so even a reset (5 JTAG cycles) could take 50
|
main clock, so even a reset (5 JTAG cycles) could take 50
|
processor clock cycles to complete.
|
processor clock cycles to complete.
|
|
|
|
|
-- `or1ksim.h': double or1ksim_jtag_shift_ir (unsigned
|
-- `or1ksim.h': double or1ksim_jtag_shift_ir (unsigned
|
char *JREG, int NUM_BITS)
|
char *JREG, int NUM_BITS)
|
|
|
Shift the supplied register through the JTAG instruction register.
|
Shift the supplied register through the JTAG instruction register.
|
Return the (model) time taken for this action. The register is
|
Return the (model) time taken for this action. The register is
|
supplied as a byte vector, with the least significant bits in the
|
supplied as a byte vector, with the least significant bits in the
|
least significant byte. If the total number of bits is not an
|
least significant byte. If the total number of bits is not an
|
exact number of bytes, then the odd bits are found in the least
|
exact number of bytes, then the odd bits are found in the least
|
significant end of the highest numbered byte.
|
significant end of the highest numbered byte.
|
|
|
For example a 12-bit register would have bits 0-7 in byte 0 and
|
For example a 12-bit register would have bits 0-7 in byte 0 and
|
bits 11-8 in the least significant 4 bits of byte 1.
|
bits 11-8 in the least significant 4 bits of byte 1.
|
|
|
|
|
-- `or1ksim.h': double or1ksim_jtag_shift_dr (unsigned
|
-- `or1ksim.h': double or1ksim_jtag_shift_dr (unsigned
|
char *JREG, int NUM_BITS)
|
char *JREG, int NUM_BITS)
|
|
|
Shift the supplied register through the JTAG data register.
|
Shift the supplied register through the JTAG data register.
|
Return the (model) time taken for this action. The register is
|
Return the (model) time taken for this action. The register is
|
supplied as a byte vector, with the least significant bits in the
|
supplied as a byte vector, with the least significant bits in the
|
least significant byte. If the total number of bits is not an
|
least significant byte. If the total number of bits is not an
|
exact number of bytes, then the odd bits are found in the least
|
exact number of bytes, then the odd bits are found in the least
|
significant end of the highest numbered byte.
|
significant end of the highest numbered byte.
|
|
|
For example a 12-bit register would have bits 0-7 in byte 0 and
|
For example a 12-bit register would have bits 0-7 in byte 0 and
|
bits 11-8 in the least significant 4 bits of byte 1.
|
bits 11-8 in the least significant 4 bits of byte 1.
|
|
|
|
|
-- `or1ksim.h': int or1ksim_read_mem (unsigned
|
-- `or1ksim.h': int or1ksim_read_mem (unsigned
|
long int ADDR, unsigned char *BUF, int LEN)
|
long int ADDR, unsigned char *BUF, int LEN)
|
|
|
Read LEN bytes from ADDR, placing the result in BUF. Return LEN
|
Read LEN bytes from ADDR, placing the result in BUF. Return LEN
|
on success and 0 on failure.
|
on success and 0 on failure.
|
|
|
Note: This function was added in Or1ksim 0.5.0.
|
Note: This function was added in Or1ksim 0.5.0.
|
|
|
|
|
-- `or1ksim.h': int or1ksim_write_mem (unsigned
|
-- `or1ksim.h': int or1ksim_write_mem (unsigned
|
long int ADDR, const unsigned char *BUF, int LEN)
|
long int ADDR, const unsigned char *BUF, int LEN)
|
|
|
Write LEN bytes to ADDR, taking the data from BUF. Return LEN on
|
Write LEN bytes to ADDR, taking the data from BUF. Return LEN on
|
success and 0 on failure.
|
success and 0 on failure.
|
|
|
Note: This function was added in Or1ksim 0.5.0.
|
Note: This function was added in Or1ksim 0.5.0.
|
|
|
|
|
-- `or1ksim.h': int or1ksim_read_spr (int SPRNUM, unsigned
|
-- `or1ksim.h': int or1ksim_read_spr (int SPRNUM, unsigned
|
long int *SPRVAL_PTR)
|
long int *SPRVAL_PTR)
|
|
|
Read the SPR specified by SPRNUM, placing the result in
|
Read the SPR specified by SPRNUM, placing the result in
|
SPRVAL_PTR. Return non-zero on success and 0 on failure.
|
SPRVAL_PTR. Return non-zero on success and 0 on failure.
|
|
|
Note: This function was added in Or1ksim 0.5.0.
|
Note: This function was added in Or1ksim 0.5.0.
|
|
|
|
|
-- `or1ksim.h': int or1ksim_write_spr (int SPRNUM, unsigned
|
-- `or1ksim.h': int or1ksim_write_spr (int SPRNUM, unsigned
|
long int SPRVA)
|
long int SPRVA)
|
|
|
Write SPRVAL to the SPR specified by SPRNUM. Return non-zero on
|
Write SPRVAL to the SPR specified by SPRNUM. Return non-zero on
|
success and 0 on failure.
|
success and 0 on failure.
|
|
|
Note: This function was added in Or1ksim 0.5.0.
|
Note: This function was added in Or1ksim 0.5.0.
|
|
|
|
|
-- `or1ksim.h': int or1ksim_read_reg (int REGNUM, unsigned
|
-- `or1ksim.h': int or1ksim_read_reg (int REGNUM, unsigned
|
long int *REGVAL_PTR)
|
long int *REGVAL_PTR)
|
|
|
Read the general purpose register specified by REGNUM, placing the
|
Read the general purpose register specified by REGNUM, placing the
|
result in REGVAL_PTR. Return non-zero on success and 0 on failure.
|
result in REGVAL_PTR. Return non-zero on success and 0 on failure.
|
|
|
Note: This function was added in Or1ksim 0.5.0.
|
Note: This function was added in Or1ksim 0.5.0.
|
|
|
|
|
-- `or1ksim.h': int or1ksim_write_reg (int REGNUM, unsigned
|
-- `or1ksim.h': int or1ksim_write_reg (int REGNUM, unsigned
|
long int REGVA)
|
long int REGVA)
|
|
|
Write REGVAL to the general purpose register specified by REGNUM.
|
Write REGVAL to the general purpose register specified by REGNUM.
|
Return non-zero on success and 0 on failure.
|
Return non-zero on success and 0 on failure.
|
|
|
Note: This function was added in Or1ksim 0.5.0.
|
Note: This function was added in Or1ksim 0.5.0.
|
|
|
|
|
-- `or1ksim.h': void or1ksim_set_stall_state (int
|
-- `or1ksim.h': void or1ksim_set_stall_state (int
|
STATE)
|
STATE)
|
|
|
Set the processor's state according to STATE (1 = stalled, 0 = not
|
Set the processor's state according to STATE (1 = stalled, 0 = not
|
stalled).
|
stalled).
|
|
|
Note: This function was added in Or1ksim 0.5.0.
|
Note: This function was added in Or1ksim 0.5.0.
|
|
|
|
|
The libraries will be installed in the `lib' sub-directory of the main
|
The libraries will be installed in the `lib' sub-directory of the main
|
installation directory (as specified with the `--prefix' option to the
|
installation directory (as specified with the `--prefix' option to the
|
`configure' script).
|
`configure' script).
|
|
|
For example if the main installation directory is `/opt/or1ksim', the
|
For example if the main installation directory is `/opt/or1ksim', the
|
library will be found in the `/opt/or1ksim/lib' directory. It is
|
library will be found in the `/opt/or1ksim/lib' directory. It is
|
available as both a static library (`libsim.a') and a shared object
|
available as both a static library (`libsim.a') and a shared object
|
(`libsim.so').
|
(`libsim.so').
|
|
|
To link against the library add the `-lsim' flag when linking and do
|
To link against the library add the `-lsim' flag when linking and do
|
one of the following:
|
one of the following:
|
|
|
* Add the library directory to the `LD_LIBRARY_PATH' environment
|
* Add the library directory to the `LD_LIBRARY_PATH' environment
|
variable during execution. For example:
|
variable during execution. For example:
|
|
|
export LD_LIBRARY_PATH=/opt/or1ksim/lib:$LD_LIBRARY_PATH
|
export LD_LIBRARY_PATH=/opt/or1ksim/lib:$LD_LIBRARY_PATH
|
|
|
* Add the library directory to the `LD_RUN_PATH' environment
|
* Add the library directory to the `LD_RUN_PATH' environment
|
variable during linking. For example:
|
variable during linking. For example:
|
|
|
export LD_RUN_PATH=/opt/or1ksim/lib:$LD_RUN_PATH
|
export LD_RUN_PATH=/opt/or1ksim/lib:$LD_RUN_PATH
|
|
|
* Use the linker `--rpath' option and specify the library directory
|
* Use the linker `--rpath' option and specify the library directory
|
when linking your program. For example
|
when linking your program. For example
|
|
|
gcc ... -Wl,--rpath -Wl,/opt/or1ksim/lib ...
|
gcc ... -Wl,--rpath -Wl,/opt/or1ksim/lib ...
|
|
|
* Add the library directory to `/etc/ld.so.conf'
|
* Add the library directory to `/etc/ld.so.conf'
|
|
|
|
|
|
|
File: or1ksim.info, Node: Configuration, Next: Interactive Command Line, Prev: Usage, Up: Top
|
File: or1ksim.info, Node: Configuration, Next: Interactive Command Line, Prev: Usage, Up: Top
|
|
|
3 Configuration
|
3 Configuration
|
***************
|
***************
|
|
|
Or1ksim is configured through a configuration file. This is specified
|
Or1ksim is configured through a configuration file. This is specified
|
through the `-f' parameter to the Or1ksim command, or passed as a
|
through the `-f' parameter to the Or1ksim command, or passed as a
|
string when initializing the Or1ksim library. If no file is specified,
|
string when initializing the Or1ksim library. If no file is specified,
|
the default `sim.cfg' is used. The file is looked for first in the
|
the default `sim.cfg' is used. The file is looked for first in the
|
current directory, then in the `$HOME/.or1ksim' directory of the user.
|
current directory, then in the `$HOME/.or1ksim' directory of the user.
|
|
|
* Menu:
|
* Menu:
|
|
|
* Configuration File Format::
|
* Configuration File Format::
|
* Simulator Configuration::
|
* Simulator Configuration::
|
* Core OpenRISC Configuration::
|
* Core OpenRISC Configuration::
|
* Peripheral Configuration::
|
* Peripheral Configuration::
|
|
|
|
|
File: or1ksim.info, Node: Configuration File Format, Next: Simulator Configuration, Up: Configuration
|
File: or1ksim.info, Node: Configuration File Format, Next: Simulator Configuration, Up: Configuration
|
|
|
3.1 Configuration File Format
|
3.1 Configuration File Format
|
=============================
|
=============================
|
|
|
The configuration file is a plain text file. A reference example,
|
The configuration file is a plain text file. A reference example,
|
`sim.cfg', is included in the top level directory of the distribution.
|
`sim.cfg', is included in the top level directory of the distribution.
|
|
|
* Menu:
|
* Menu:
|
|
|
* Configuration File Preprocessing::
|
* Configuration File Preprocessing::
|
* Configuration File Syntax::
|
* Configuration File Syntax::
|
|
|
|
|
File: or1ksim.info, Node: Configuration File Preprocessing, Next: Configuration File Syntax, Up: Configuration File Format
|
File: or1ksim.info, Node: Configuration File Preprocessing, Next: Configuration File Syntax, Up: Configuration File Format
|
|
|
3.1.1 Configuration File Preprocessing
|
3.1.1 Configuration File Preprocessing
|
--------------------------------------
|
--------------------------------------
|
|
|
The configuration file may include C style comments (i.e. delimited by
|
The configuration file may include C style comments (i.e. delimited by
|
`/*' and `*/').
|
`/*' and `*/').
|
|
|
|
|
File: or1ksim.info, Node: Configuration File Syntax, Prev: Configuration File Preprocessing, Up: Configuration File Format
|
File: or1ksim.info, Node: Configuration File Syntax, Prev: Configuration File Preprocessing, Up: Configuration File Format
|
|
|
3.1.2 Configuration File Syntax
|
3.1.2 Configuration File Syntax
|
-------------------------------
|
-------------------------------
|
|
|
The configuration file is divided into a series of sections, with the
|
The configuration file is divided into a series of sections, with the
|
general form:
|
general form:
|
|
|
section SECTION_NAME
|
section SECTION_NAME
|
|
|
...
|
...
|
|
|
end
|
end
|
|
|
Sections may also have sub-sections within them (currently only the
|
Sections may also have sub-sections within them (currently only the
|
ATA/ATAPI disc interface uses this).
|
ATA/ATAPI disc interface uses this).
|
|
|
Within a section, or sub-section are a series of parameter assignments,
|
Within a section, or sub-section are a series of parameter assignments,
|
one per line, withe the general form
|
one per line, withe the general form
|
|
|
PARAMETER = VALUE
|
PARAMETER = VALUE
|
|
|
Depending on the parameter, the value may be a named value (an
|
Depending on the parameter, the value may be a named value (an
|
enumeration), an integer (specified in any format acceptable in C) or a
|
enumeration), an integer (specified in any format acceptable in C) or a
|
string in doubple quotes. For flag parameters, the value 1 is used to
|
string in doubple quotes. For flag parameters, the value 1 is used to
|
mean "true" or "on" and the value "0" to mean "false" or "off". An
|
mean "true" or "on" and the value "0" to mean "false" or "off". An
|
example from a memory section shows each of these
|
example from a memory section shows each of these
|
|
|
section memory
|
section memory
|
type = random
|
type = random
|
pattern = 0x00
|
pattern = 0x00
|
name = "FLASH"
|
name = "FLASH"
|
...
|
...
|
end
|
end
|
|
|
Many parameters are optional and take reasonable default values if not
|
Many parameters are optional and take reasonable default values if not
|
specified. However there are some parameters (for example the `ce'
|
specified. However there are some parameters (for example the `ce'
|
parameter in `section memory') _must_ be specified.
|
parameter in `section memory') _must_ be specified.
|
|
|
Subsections are introduced by a keyword, with a parameter value (no `='
|
Subsections are introduced by a keyword, with a parameter value (no `='
|
sign), and end with the same keyword prefixed by `end'. Thus the
|
sign), and end with the same keyword prefixed by `end'. Thus the
|
ATA/ATAPI inteface (`section ata') has a `device' subsection, thus:
|
ATA/ATAPI inteface (`section ata') has a `device' subsection, thus:
|
|
|
section ata
|
section ata
|
...
|
...
|
device 0
|
device 0
|
type = 1
|
type = 1
|
file = "FILENAME"
|
file = "FILENAME"
|
...
|
...
|
enddevice
|
enddevice
|
...
|
...
|
end
|
end
|
|
|
Some sections (for example `section sim') should appear only once.
|
Some sections (for example `section sim') should appear only once.
|
Others (for example `section memory' may appear multiple times.
|
Others (for example `section memory' may appear multiple times.
|
|
|
Sections may be omitted, _unless they contain parameters which are
|
Sections may be omitted, _unless they contain parameters which are
|
non-optional_. If the section describes a part of the simulator which
|
non-optional_. If the section describes a part of the simulator which
|
is optional (for example whether it has a UART), then that
|
is optional (for example whether it has a UART), then that
|
functionality will not be provided. If the section describes a part of
|
functionality will not be provided. If the section describes a part of
|
the simulator which is not optional (for example the CPU), then all the
|
the simulator which is not optional (for example the CPU), then all the
|
parameters of that section will take their default values.
|
parameters of that section will take their default values.
|
|
|
All optional parts of the functionality are always described by
|
All optional parts of the functionality are always described by
|
sections including a `enabled' parameter, which can be set to 0 to
|
sections including a `enabled' parameter, which can be set to 0 to
|
ensure that functionality is explicitly omitted.
|
ensure that functionality is explicitly omitted.
|
|
|
Even if a section is disabled, all its parameters will be read and
|
Even if a section is disabled, all its parameters will be read and
|
stored. This is helpful if the section is subsequently enabled from
|
stored. This is helpful if the section is subsequently enabled from
|
the Or1ksim command line (*note Interactive Command Line: Interactive
|
the Or1ksim command line (*note Interactive Command Line: Interactive
|
Command Line.).
|
Command Line.).
|
|
|
Tip: It generally clearer to have sections describing _all_
|
Tip: It generally clearer to have sections describing _all_
|
components, with omitted functionality explicitly indicated by
|
components, with omitted functionality explicitly indicated by
|
setting the `enabled' parameter to 0
|
setting the `enabled' parameter to 0
|
|
|
The following sections describe the various configuration sections and
|
The following sections describe the various configuration sections and
|
the parameters which may be set in each.
|
the parameters which may be set in each.
|
|
|
|
|
File: or1ksim.info, Node: Simulator Configuration, Next: Core OpenRISC Configuration, Prev: Configuration File Format, Up: Configuration
|
File: or1ksim.info, Node: Simulator Configuration, Next: Core OpenRISC Configuration, Prev: Configuration File Format, Up: Configuration
|
|
|
3.2 Simulator Configuration
|
3.2 Simulator Configuration
|
===========================
|
===========================
|
|
|
* Menu:
|
* Menu:
|
|
|
* Simulator Behavior::
|
* Simulator Behavior::
|
* Verification API Configuration::
|
* Verification API Configuration::
|
* CUC Configuration::
|
* CUC Configuration::
|
|
|
|
|
File: or1ksim.info, Node: Simulator Behavior, Next: Verification API Configuration, Up: Simulator Configuration
|
File: or1ksim.info, Node: Simulator Behavior, Next: Verification API Configuration, Up: Simulator Configuration
|
|
|
3.2.1 Simulator Behavior
|
3.2.1 Simulator Behavior
|
------------------------
|
------------------------
|
|
|
Simulator behavior is described in `section sim'. This section should
|
Simulator behavior is described in `section sim'. This section should
|
appear only once. The following parameters may be specified.
|
appear only once. The following parameters may be specified.
|
|
|
`verbose = 0|1'
|
`verbose = 0|1'
|
If 1 (true), print extra messages. Default 0.
|
If 1 (true), print extra messages. Default 0.
|
|
|
`debug = 0-9'
|
`debug = 0-9'
|
0 means no debug messages. 1-9 means produce debug messages. The
|
0 means no debug messages. 1-9 means produce debug messages. The
|
higher the value the greater the number of messages. Default 0.
|
higher the value the greater the number of messages. Default 0.
|
Negative values will be treated as 0 (with a warning). Values
|
Negative values will be treated as 0 (with a warning). Values
|
that are too large will be treated as 9 (with a warning).
|
that are too large will be treated as 9 (with a warning).
|
|
|
`profile = 0|1'
|
`profile = 0|1'
|
If 1 (true) generate a profiling file using the file specified in
|
If 1 (true) generate a profiling file using the file specified in
|
the `prof_file' parameter or otherwise `sim.profile'. Default 0.
|
the `prof_file' parameter or otherwise `sim.profile'. Default 0.
|
|
|
`prof_file = ``FILENAME'''
|
`prof_file = ``FILENAME'''
|
Specifies the file to be used with the `profile' parameter.
|
Specifies the file to be used with the `profile' parameter.
|
Default `sim.profile'. For backwards compatibility, the
|
Default `sim.profile'. For backwards compatibility, the
|
alternative name `prof_fn' is supported for this parameter, but
|
alternative name `prof_fn' is supported for this parameter, but
|
deprecated. Default `sim.profile'.
|
deprecated. Default `sim.profile'.
|
|
|
`mprofile = 0|1'
|
`mprofile = 0|1'
|
If 1 (true) generate a memory profiling file using the file
|
If 1 (true) generate a memory profiling file using the file
|
specified in the `mprof_file' parameter or otherwise
|
specified in the `mprof_file' parameter or otherwise
|
`sim.mprofile'. Default 0.
|
`sim.mprofile'. Default 0.
|
|
|
`mprof_file = ``FILENAME'''
|
`mprof_file = ``FILENAME'''
|
Specifies the file to be used with the `mprofile' parameter.
|
Specifies the file to be used with the `mprofile' parameter.
|
Default `sim.mprofile'. For backwards compatibility, the
|
Default `sim.mprofile'. For backwards compatibility, the
|
alternative name `mprof_fn' is supported for this parameter, but
|
alternative name `mprof_fn' is supported for this parameter, but
|
deprecated. Default `sim.mprofile'.
|
deprecated. Default `sim.mprofile'.
|
|
|
`history = 0|1'
|
`history = 0|1'
|
If 1 (true) track execution flow. Default 0.
|
If 1 (true) track execution flow. Default 0.
|
|
|
Note: Setting this parameter seriously degrades performance.
|
Note: Setting this parameter seriously degrades performance.
|
|
|
Note: If this execution flow tracking is enabled, then
|
Note: If this execution flow tracking is enabled, then
|
`dependstats' must be enabled in the CPU configuration
|
`dependstats' must be enabled in the CPU configuration
|
section (*note CPU Configuration: CPU Configuration.).
|
section (*note CPU Configuration: CPU Configuration.).
|
|
|
`exe_log = 0|1'
|
`exe_log = 0|1'
|
If 1 (true), generate an execution log. Log is written to the
|
If 1 (true), generate an execution log. Log is written to the
|
file specified in parameter `exe_log_file'. Default 0.
|
file specified in parameter `exe_log_file'. Default 0.
|
|
|
Note: Setting this parameter seriously degrades performance.
|
Note: Setting this parameter seriously degrades performance.
|
|
|
`exe_log_type = default|hardware|simple|software'
|
`exe_log_type = default|hardware|simple|software'
|
Type of execution log to produce.
|
Type of execution log to produce.
|
|
|
`default'
|
`default'
|
Produce default output for the execution log. In the current
|
Produce default output for the execution log. In the current
|
implementation this is the equivalent of `hardware'.
|
implementation this is the equivalent of `hardware'.
|
|
|
`hardware'
|
`hardware'
|
After each instruction execution, log the number of
|
After each instruction execution, log the number of
|
instructions executed so far, the next instruction to execute
|
instructions executed so far, the next instruction to execute
|
(in hex), the general purpose registers (GPRs), status
|
(in hex), the general purpose registers (GPRs), status
|
register, exception program counter, exception, effective
|
register, exception program counter, exception, effective
|
address register and exception status register.
|
address register and exception status register.
|
|
|
`simple'
|
`simple'
|
After each instruction execution, log the number of
|
After each instruction execution, log the number of
|
instructions executed so far and the next instruction to
|
instructions executed so far and the next instruction to
|
execute, symbolically disassembled.
|
execute, symbolically disassembled.
|
|
|
`software'
|
`software'
|
After each instruction execution, log the number of
|
After each instruction execution, log the number of
|
instructions executed so far and the next instruction to
|
instructions executed so far and the next instruction to
|
execute, symbolically disassembled. Also show the value of
|
execute, symbolically disassembled. Also show the value of
|
each operand to the instruction.
|
each operand to the instruction.
|
|
|
|
|
Default value `hardware'. Any unrecognized keyword (case
|
Default value `hardware'. Any unrecognized keyword (case
|
insensitive) will be treated as the default with a warning.
|
insensitive) will be treated as the default with a warning.
|
|
|
Note: Execution logs can be _very_ big.
|
Note: Execution logs can be _very_ big.
|
|
|
`exe_log_start = VALUE'
|
`exe_log_start = VALUE'
|
Address of the first instruction to start logging. Default 0.
|
Address of the first instruction to start logging. Default 0.
|
|
|
`exe_log_end = VALUE'
|
`exe_log_end = VALUE'
|
Address of the last instruction to log. Default no limit (i.e
|
Address of the last instruction to log. Default no limit (i.e
|
once started logging will continue until the simulator exits).
|
once started logging will continue until the simulator exits).
|
|
|
`exe_log_marker = VALUE'
|
`exe_log_marker = VALUE'
|
Specifies the number of instructions between printing horizontal
|
Specifies the number of instructions between printing horizontal
|
markers. Default is to produce no markers.
|
markers. Default is to produce no markers.
|
|
|
`exe_log_file = FILENAME'
|
`exe_log_file = FILENAME'
|
Filename for the execution log filename if `exe_log' is enabled.
|
Filename for the execution log filename if `exe_log' is enabled.
|
Default `executed.log'. For backwards compatibility, the
|
Default `executed.log'. For backwards compatibility, the
|
alternative name `exe_log_fn' is supported for this parameter, but
|
alternative name `exe_log_fn' is supported for this parameter, but
|
deprecated.
|
deprecated.
|
|
|
`exe_bin_insn_log = 0|1'
|
`exe_bin_insn_log = 0|1'
|
Enable logging of executed instructions to a file in binary format.
|
Enable logging of executed instructions to a file in binary format.
|
This is helpful for off-line dynamic execution analysis.
|
This is helpful for off-line dynamic execution analysis.
|
|
|
Note: Execution logs can be _very_ big. For example, while
|
Note: Execution logs can be _very_ big. For example, while
|
booting the Linux kernel, version 2.6.34, a log file 1.2GB in
|
booting the Linux kernel, version 2.6.34, a log file 1.2GB in
|
size was generated.
|
size was generated.
|
|
|
`exe_bin_insn_log_file = FILENAME'
|
`exe_bin_insn_log_file = FILENAME'
|
Filename for the binary execution log filename if
|
Filename for the binary execution log filename if
|
`exe_bin_insn_log' is enabled. Default `exe-insn.bin'.
|
`exe_bin_insn_log' is enabled. Default `exe-insn.bin'.
|
|
|
`clkcycle = VALUE[ps|ns|us|ms]'
|
`clkcycle = VALUE[ps|ns|us|ms]'
|
Specify the time taken by one clock cycle. If no units are
|
Specify the time taken by one clock cycle. If no units are
|
specified, `ps' is assumed. Default 4000ps (250MHz).
|
specified, `ps' is assumed. Default 4000ps (250MHz).
|
|
|
|
|
|
|
File: or1ksim.info, Node: Verification API Configuration, Next: CUC Configuration, Prev: Simulator Behavior, Up: Simulator Configuration
|
File: or1ksim.info, Node: Verification API Configuration, Next: CUC Configuration, Prev: Simulator Behavior, Up: Simulator Configuration
|
|
|
3.2.2 Verification API (VAPI) Configuration
|
3.2.2 Verification API (VAPI) Configuration
|
-------------------------------------------
|
-------------------------------------------
|
|
|
The Verification API (VAPI) provides a TCP/IP interface to allow
|
The Verification API (VAPI) provides a TCP/IP interface to allow
|
components of the simulation to be controlled externally. *Note
|
components of the simulation to be controlled externally. *Note
|
Verification API: Verification API, for more details.
|
Verification API: Verification API, for more details.
|
|
|
Verification API configuration is described in `section vapi'. This
|
Verification API configuration is described in `section vapi'. This
|
section may appear at most once. The following parameters may be
|
section may appear at most once. The following parameters may be
|
specified.
|
specified.
|
|
|
`enabled = 0|1'
|
`enabled = 0|1'
|
If 1 (true), verification API is enabled and its server started.
|
If 1 (true), verification API is enabled and its server started.
|
If 0 (the default), it is disabled.
|
If 0 (the default), it is disabled.
|
|
|
`server_port = VALUE'
|
`server_port = VALUE'
|
When VAPI is enabled, communication will be via TCP/IP on the port
|
When VAPI is enabled, communication will be via TCP/IP on the port
|
specified by VALUE. The value must lie in the range 1 to 65535.
|
specified by VALUE. The value must lie in the range 1 to 65535.
|
The default value is 50000.
|
The default value is 50000.
|
|
|
Tip: There is no registered port for Or1ksim VAPI. Good
|
Tip: There is no registered port for Or1ksim VAPI. Good
|
practice suggests users should adopt port values in the
|
practice suggests users should adopt port values in the
|
"Dynamic" or "Private" port range, i.e. 49152-65535.
|
"Dynamic" or "Private" port range, i.e. 49152-65535.
|
|
|
`log_enabled = 0|1'
|
`log_enabled = 0|1'
|
If 1 (true), all VAPI requests and sent commands will be logged.
|
If 1 (true), all VAPI requests and sent commands will be logged.
|
If 0 (the default), logging is diabled. Logs are written to the
|
If 0 (the default), logging is diabled. Logs are written to the
|
file specified by the `vapi_log_file' field (see below).
|
file specified by the `vapi_log_file' field (see below).
|
|
|
Caution: This can generate a substantial amount of file I/O
|
Caution: This can generate a substantial amount of file I/O
|
and seriously degrade simulator performance.
|
and seriously degrade simulator performance.
|
|
|
`hide_device_id = 0|1'
|
`hide_device_id = 0|1'
|
If 1 (true) don't log the device ID. If 0 (the default), log the
|
If 1 (true) don't log the device ID. If 0 (the default), log the
|
device ID. This feature (when set to 1) is provided for backwards
|
device ID. This feature (when set to 1) is provided for backwards
|
compatibility with an old version of VAPI.
|
compatibility with an old version of VAPI.
|
|
|
`vapi_log_file = "FILENAME"'
|
`vapi_log_file = "FILENAME"'
|
Use `filename' as the file for logged data is logging is enabled
|
Use `filename' as the file for logged data is logging is enabled
|
(see `log_enabled' above). The default is `"vapi.log"'. For
|
(see `log_enabled' above). The default is `"vapi.log"'. For
|
backwards compatibility, the alternative name `vapi_log_fn' is
|
backwards compatibility, the alternative name `vapi_log_fn' is
|
supported for this parameter, but deprecated.
|
supported for this parameter, but deprecated.
|
|
|
|
|
|
|
File: or1ksim.info, Node: CUC Configuration, Prev: Verification API Configuration, Up: Simulator Configuration
|
File: or1ksim.info, Node: CUC Configuration, Prev: Verification API Configuration, Up: Simulator Configuration
|
|
|
3.2.3 Custom Unit Compiler (CUC) Configuration
|
3.2.3 Custom Unit Compiler (CUC) Configuration
|
----------------------------------------------
|
----------------------------------------------
|
|
|
The Custom Unit Compiler (CUC) was a project by Marko Mlinar to generate
|
The Custom Unit Compiler (CUC) was a project by Marko Mlinar to generate
|
Verilog from ANSI C functions. The project seems to not have progressed
|
Verilog from ANSI C functions. The project seems to not have progressed
|
beyond the initial prototype phase. The configuration parameters are
|
beyond the initial prototype phase. The configuration parameters are
|
described here for the record.
|
described here for the record.
|
|
|
CUC configuration is described in `section cuc'. This section may
|
CUC configuration is described in `section cuc'. This section may
|
appear at most once. The following parameters may be specified.
|
appear at most once. The following parameters may be specified.
|
|
|
`memory_order = none|weak|strong|exact'
|
`memory_order = none|weak|strong|exact'
|
This parameter specifies the memory ordering required:
|
This parameter specifies the memory ordering required:
|
|
|
`memory_order=none'
|
`memory_order=none'
|
Different memory ordering, even if there are dependencies.
|
Different memory ordering, even if there are dependencies.
|
Bursts can be made, width can change.
|
Bursts can be made, width can change.
|
|
|
`memory_order=weak'
|
`memory_order=weak'
|
Different memory ordering, even if there are dependencies. If
|
Different memory ordering, even if there are dependencies. If
|
dependencies cannot occur, then bursts can be made, width can
|
dependencies cannot occur, then bursts can be made, width can
|
change.
|
change.
|
|
|
`memory_order=strong'
|
`memory_order=strong'
|
Same memory ordering. Bursts can be made, width can change.
|
Same memory ordering. Bursts can be made, width can change.
|
|
|
`memory_order=exact'
|
`memory_order=exact'
|
Exactly the same memory ordering and widths.
|
Exactly the same memory ordering and widths.
|
|
|
|
|
The default value is `memory_order=exact'. Invalid memory
|
The default value is `memory_order=exact'. Invalid memory
|
orderings are ignored with a warning.
|
orderings are ignored with a warning.
|
|
|
`calling_convention = 0|1'
|
`calling_convention = 0|1'
|
If 1 (true), programs follow OpenRISC calling conventions. If 0
|
If 1 (true), programs follow OpenRISC calling conventions. If 0
|
(the default), they may use other convenitions.
|
(the default), they may use other convenitions.
|
|
|
`enable_bursts = 0 | 1'
|
`enable_bursts = 0 | 1'
|
If 1 (true), bursts are detected. If 0 (the default), bursts are
|
If 1 (true), bursts are detected. If 0 (the default), bursts are
|
not detected.
|
not detected.
|
|
|
`no_multicycle = 0 | 1'
|
`no_multicycle = 0 | 1'
|
If 1 (true), no multicycle logic paths will be generated. If 0
|
If 1 (true), no multicycle logic paths will be generated. If 0
|
(the default), multicycle logic paths will be generated.
|
(the default), multicycle logic paths will be generated.
|
|
|
`timings_file = "FILENAME"'
|
`timings_file = "FILENAME"'
|
FILENAME specifies a file containing timing information. The
|
FILENAME specifies a file containing timing information. The
|
default value is `"virtex.tim"'. For backwards compatibility, the
|
default value is `"virtex.tim"'. For backwards compatibility, the
|
alternative name `timings_fn' is supported for this parameter, but
|
alternative name `timings_fn' is supported for this parameter, but
|
deprecated.
|
deprecated.
|
|
|
|
|
|
|
File: or1ksim.info, Node: Core OpenRISC Configuration, Next: Peripheral Configuration, Prev: Simulator Configuration, Up: Configuration
|
File: or1ksim.info, Node: Core OpenRISC Configuration, Next: Peripheral Configuration, Prev: Simulator Configuration, Up: Configuration
|
|
|
3.3 Configuring the OpenRISC Architectural Components
|
3.3 Configuring the OpenRISC Architectural Components
|
=====================================================
|
=====================================================
|
|
|
* Menu:
|
* Menu:
|
|
|
* CPU Configuration::
|
* CPU Configuration::
|
* Memory Configuration::
|
* Memory Configuration::
|
* Memory Management Configuration::
|
* Memory Management Configuration::
|
* Cache Configuration::
|
* Cache Configuration::
|
* Interrupt Configuration::
|
* Interrupt Configuration::
|
* Power Management Configuration::
|
* Power Management Configuration::
|
* Branch Prediction Configuration::
|
* Branch Prediction Configuration::
|
* Debug Interface Configuration::
|
* Debug Interface Configuration::
|
|
|
|
|
File: or1ksim.info, Node: CPU Configuration, Next: Memory Configuration, Up: Core OpenRISC Configuration
|
File: or1ksim.info, Node: CPU Configuration, Next: Memory Configuration, Up: Core OpenRISC Configuration
|
|
|
3.3.1 CPU Configuration
|
3.3.1 CPU Configuration
|
-----------------------
|
-----------------------
|
|
|
CPU configuration is described in `section cpu'. This section should
|
CPU configuration is described in `section cpu'. This section should
|
appear only once. At present Or1ksim does not model multi-CPU systems.
|
appear only once. At present Or1ksim does not model multi-CPU systems.
|
The following parameters may be specified.
|
The following parameters may be specified.
|
|
|
`ver = VALUE'
|
`ver = VALUE'
|
|
|
`cfg = VALUE'
|
`cfg = VALUE'
|
|
|
`rev = VALUE'
|
`rev = VALUE'
|
The values are used to form the corresponding fields in the `VR'
|
The values are used to form the corresponding fields in the `VR'
|
Special Purpose Register (SPR 0). Default values 0. A warning is
|
Special Purpose Register (SPR 0). Default values 0. A warning is
|
given and the value truncated if it is too large (8 bits for `ver'
|
given and the value truncated if it is too large (8 bits for `ver'
|
and `cfg', 6 bits for `rev').
|
and `cfg', 6 bits for `rev').
|
|
|
`upr = VALUE'
|
`upr = VALUE'
|
Used as the value of the Unit Present Register (UPR) Special
|
Used as the value of the Unit Present Register (UPR) Special
|
Purpose Register (SPR 1) to VALUE. Default value is 0x0000075f,
|
Purpose Register (SPR 1) to VALUE. Default value is 0x0000075f,
|
i.e.
|
i.e.
|
* UPR present (0x00000001)
|
* UPR present (0x00000001)
|
|
|
* Data cache present (0x00000002)
|
* Data cache present (0x00000002)
|
|
|
* Instruction cache present (0x00000004)
|
* Instruction cache present (0x00000004)
|
|
|
* Data MMY present (0x00000008)
|
* Data MMY present (0x00000008)
|
|
|
* Instruction MMU present (0x00000010)
|
* Instruction MMU present (0x00000010)
|
|
|
* Debug unit present (0x00000040)
|
* Debug unit present (0x00000040)
|
|
|
* Power management unit present (0x00000100)
|
* Power management unit present (0x00000100)
|
|
|
* Programmable interrupt controller present (0x00000200)
|
* Programmable interrupt controller present (0x00000200)
|
|
|
* Tick timer present (0x00000400)
|
* Tick timer present (0x00000400)
|
|
|
However, with the exection of the UPR present (0x00000001) and tick
|
However, with the exection of the UPR present (0x00000001) and tick
|
timer present, the various fields will be modified with the values
|
timer present, the various fields will be modified with the values
|
specified in their corresponding configuration sections.
|
specified in their corresponding configuration sections.
|
|
|
`cfgr = VALUE'
|
`cfgr = VALUE'
|
Sets the CPU configuration register (Special Purpose Register 2) to
|
Sets the CPU configuration register (Special Purpose Register 2) to
|
VALUE. Default value is 0x00000020, i.e. support for the ORBIS32
|
VALUE. Default value is 0x00000020, i.e. support for the ORBIS32
|
instruction set. Attempts to set any other value are accepted, but
|
instruction set. Attempts to set any other value are accepted, but
|
issue a warning that there is no support for the instruction set.
|
issue a warning that there is no support for the instruction set.
|
|
|
`sr = VALUE'
|
`sr = VALUE'
|
Sets the supervision register Special Purpose Register (SPR 0x11)
|
Sets the supervision register Special Purpose Register (SPR 0x11)
|
to VALUE. Default value is 0x00008001, i.e. start in supervision
|
to VALUE. Default value is 0x00008001, i.e. start in supervision
|
mode (0x00000001) and set the "Fixed One" bit (0x00008000).
|
mode (0x00000001) and set the "Fixed One" bit (0x00008000).
|
|
|
Note: This is particularly useful when an image is held in
|
Note: This is particularly useful when an image is held in
|
Flash at high memory (0xf0000000). The EPH bit can be set,
|
Flash at high memory (0xf0000000). The EPH bit can be set,
|
so that interrupt vectors are basedf at 0xf0000000, rather
|
so that interrupt vectors are basedf at 0xf0000000, rather
|
than 0x0.
|
than 0x0.
|
|
|
`superscalar = 0|1'
|
`superscalar = 0|1'
|
If 1, the processor operates in superscalar mode. Default value is
|
If 1, the processor operates in superscalar mode. Default value is
|
0.
|
0.
|
|
|
In the current simulator, the only functional effect of superscalar
|
In the current simulator, the only functional effect of superscalar
|
mode is to affect the calculation of the number of cycles taken to
|
mode is to affect the calculation of the number of cycles taken to
|
execute an instruction.
|
execute an instruction.
|
|
|
Caution: The code for this does not appear to be complete or
|
Caution: The code for this does not appear to be complete or
|
well tested, so users are advised not to use this option.
|
well tested, so users are advised not to use this option.
|
|
|
`hazards = 0|1'
|
`hazards = 0|1'
|
If 1, data hazards are tracked in a superscalar CPU. Default
|
If 1, data hazards are tracked in a superscalar CPU. Default
|
value is 0.
|
value is 0.
|
|
|
In the current simulator, the only functional effect is to cause
|
In the current simulator, the only functional effect is to cause
|
logging of hazard waiting information if the CPU is superscalar.
|
logging of hazard waiting information if the CPU is superscalar.
|
However nowhere in the simulator is this data actually computed,
|
However nowhere in the simulator is this data actually computed,
|
so the net result is probably to have no effect.
|
so the net result is probably to have no effect.
|
|
|
if harzards are tracked, current hazards can be displayed using the
|
if harzards are tracked, current hazards can be displayed using the
|
simulator's `r' command.
|
simulator's `r' command.
|
|
|
Caution: The code for this does not appear to be complete or
|
Caution: The code for this does not appear to be complete or
|
well tested, so users are advised not to use this option.
|
well tested, so users are advised not to use this option.
|
|
|
`dependstats = 0|1'
|
`dependstats = 0|1'
|
If 1, inter-instruction dependencies are calculated. Default
|
If 1, inter-instruction dependencies are calculated. Default
|
value 0.
|
value 0.
|
|
|
If these values are calculated, the depencies can be displayed
|
If these values are calculated, the depencies can be displayed
|
using the simulator's `stat' command.
|
using the simulator's `stat' command.
|
|
|
Note: This field must be enabled, if execution execution flow
|
Note: This field must be enabled, if execution execution flow
|
tracking (field `history') has been requested in the simulator
|
tracking (field `history') has been requested in the simulator
|
configuration section (*note Simulator Behavior: Simulator
|
configuration section (*note Simulator Behavior: Simulator
|
Behavior.).
|
Behavior.).
|
|
|
`sbuf_len = VALUE'
|
`sbuf_len = VALUE'
|
The length of the store buffer is set to VALUE, which must be no
|
The length of the store buffer is set to VALUE, which must be no
|
greater than 256. Larger values will be truncated to 256 with a
|
greater than 256. Larger values will be truncated to 256 with a
|
warning. Negative values will be treated as 0 with a warning.
|
warning. Negative values will be treated as 0 with a warning.
|
Use 0 to disable the store buffer.
|
Use 0 to disable the store buffer.
|
|
|
When the store buffer is active, stores are accumulated and
|
When the store buffer is active, stores are accumulated and
|
committed when I/O is idle.
|
committed when I/O is idle.
|
|
|
`hardfloat = 0|1'
|
`hardfloat = 0|1'
|
If 1, hardfloat instructions are enabled. Default value 0.
|
If 1, hardfloat instructions are enabled. Default value 0.
|
|
|
|
|
|
|
File: or1ksim.info, Node: Memory Configuration, Next: Memory Management Configuration, Prev: CPU Configuration, Up: Core OpenRISC Configuration
|
File: or1ksim.info, Node: Memory Configuration, Next: Memory Management Configuration, Prev: CPU Configuration, Up: Core OpenRISC Configuration
|
|
|
3.3.2 Memory Configuration
|
3.3.2 Memory Configuration
|
--------------------------
|
--------------------------
|
|
|
Memory configuration is described in `section memory'. This section
|
Memory configuration is described in `section memory'. This section
|
may appear multiple times, specifying multiple blocks of memory.
|
may appear multiple times, specifying multiple blocks of memory.
|
|
|
Caution: The user may choose whether or not to enable a memory
|
Caution: The user may choose whether or not to enable a memory
|
controller. If a memory controller is enabled, then appropriate
|
controller. If a memory controller is enabled, then appropriate
|
initalization code must be provided. The section describing
|
initalization code must be provided. The section describing
|
memory controller configuration describes the steps necessary for
|
memory controller configuration describes the steps necessary for
|
using smaller or larger memory sections (*note Memory Controller
|
using smaller or larger memory sections (*note Memory Controller
|
Configuration: Memory Controller Configuration.).
|
Configuration: Memory Controller Configuration.).
|
|
|
The "uClibc" startup code initalizes a memory controller, assumed
|
The "uClibc" startup code initalizes a memory controller, assumed
|
to be mapped at 0x93000000. If a memory controller is _not_
|
to be mapped at 0x93000000. If a memory controller is _not_
|
enabled, then the standard C library code will generate memory
|
enabled, then the standard C library code will generate memory
|
access errors. The solution is to declare an additional writable
|
access errors. The solution is to declare an additional writable
|
memory block, mimicing the memory controller's register bank as
|
memory block, mimicing the memory controller's register bank as
|
follows.
|
follows.
|
|
|
section memory
|
section memory
|
pattern = 0x00
|
pattern = 0x00
|
type = unknown
|
type = unknown
|
name = "MC shadow"
|
name = "MC shadow"
|
baseaddr = 0x93000000
|
baseaddr = 0x93000000
|
size = 0x00000080
|
size = 0x00000080
|
delayr = 2
|
delayr = 2
|
delayw = 4
|
delayw = 4
|
end
|
end
|
|
|
|
|
The following parameters may be specified.
|
The following parameters may be specified.
|
|
|
`type=random|pattern|unknown|zero|exitnops'
|
`type=random|pattern|unknown|zero|exitnops'
|
Specifies the values to which memory should be initialized. The
|
Specifies the values to which memory should be initialized. The
|
default value is `unknown'.
|
default value is `unknown'.
|
|
|
`random'
|
`random'
|
Set the memory values to be a random value. A seed for the
|
Set the memory values to be a random value. A seed for the
|
random generator may be set using the `random_seed' field in
|
random generator may be set using the `random_seed' field in
|
this section (see below), thus ensuring the same "random"
|
this section (see below), thus ensuring the same "random"
|
values are used each time.
|
values are used each time.
|
|
|
`pattern'
|
`pattern'
|
Set the memory values to be a pattern value, which is set
|
Set the memory values to be a pattern value, which is set
|
using the `pattern' field in this section (see below).
|
using the `pattern' field in this section (see below).
|
|
|
`unknown'
|
`unknown'
|
The memory values are not initialized (i.e. left "unknown").
|
The memory values are not initialized (i.e. left "unknown").
|
This option will yield faster initialization of the
|
This option will yield faster initialization of the
|
simulator. This is the default.
|
simulator. This is the default.
|
|
|
`zero'
|
`zero'
|
Set the memory values to be 0. This is the equivalent of
|
Set the memory values to be 0. This is the equivalent of
|
`type=pattern' and a `pattern' value of 0, and implemented as
|
`type=pattern' and a `pattern' value of 0, and implemented as
|
such.
|
such.
|
|
|
Note: As a consequence, if the `pattern' field is
|
Note: As a consequence, if the `pattern' field is
|
_subsequently_ specified in this section, the value in
|
_subsequently_ specified in this section, the value in
|
that field will be used instead of zero to initialize
|
that field will be used instead of zero to initialize
|
the memory.
|
the memory.
|
|
|
`exitnops'
|
`exitnops'
|
Set the memory values to be an instruction used to signal end
|
Set the memory values to be an instruction used to signal end
|
of simulation. This is useful for causing immediate end of
|
of simulation. This is useful for causing immediate end of
|
simulation when PC corruption occurs.
|
simulation when PC corruption occurs.
|
|
|
|
|
`random_seed = VALUE'
|
`random_seed = VALUE'
|
Set the seed for the random number generator to VALUE. This only
|
Set the seed for the random number generator to VALUE. This only
|
has any effect for memory type `random'.
|
has any effect for memory type `random'.
|
|
|
The default value is -1, which means the seed will be set from a
|
The default value is -1, which means the seed will be set from a
|
call to the `time' function, thus ensuring different random values
|
call to the `time' function, thus ensuring different random values
|
are used on each run. The simulator prints out the seed used in
|
are used on each run. The simulator prints out the seed used in
|
this case, allowing repeat runs to regenerate the same random
|
this case, allowing repeat runs to regenerate the same random
|
values used in any particular run.
|
values used in any particular run.
|
|
|
`pattern = VALUE'
|
`pattern = VALUE'
|
Set the pattern to be used when initializing memory to VALUE. The
|
Set the pattern to be used when initializing memory to VALUE. The
|
default value is 0. This only has any effect for memory type
|
default value is 0. This only has any effect for memory type
|
`pattern'. The least significant 8 bits of this value is used to
|
`pattern'. The least significant 8 bits of this value is used to
|
initialize each byte. More than 8 bits can be specified, but will
|
initialize each byte. More than 8 bits can be specified, but will
|
ignored with a warning.
|
ignored with a warning.
|
|
|
Tip: The default value, is equivalent to setting the memory
|
Tip: The default value, is equivalent to setting the memory
|
`type' to be `zero'. If that is what is intended, then using
|
`type' to be `zero'. If that is what is intended, then using
|
`type=zero' explicitly is better than using `type=pattern'
|
`type=zero' explicitly is better than using `type=pattern'
|
and not specifying a value for `pattern'.
|
and not specifying a value for `pattern'.
|
|
|
`baseaddr = VALUE'
|
`baseaddr = VALUE'
|
Set the base address of the memory to VALUE. It should be aligned
|
Set the base address of the memory to VALUE. It should be aligned
|
to a multiple of the memory size rounded up to the nearest 2^n.
|
to a multiple of the memory size rounded up to the nearest 2^n.
|
The default value is 0.
|
The default value is 0.
|
|
|
`size = VALUE'
|
`size = VALUE'
|
Set the size of the memory block to be VALUE bytes. This should
|
Set the size of the memory block to be VALUE bytes. This should
|
be a multiple of 4 (i.e. word aligned). The default value is
|
be a multiple of 4 (i.e. word aligned). The default value is
|
1024.
|
1024.
|
|
|
Note: When allocating memory, the simulator will allocate the
|
Note: When allocating memory, the simulator will allocate the
|
nearest 2^n bytes greater than or equal to VALUE, and will not
|
nearest 2^n bytes greater than or equal to VALUE, and will not
|
notice memory misses in any part of the memory between VALUE
|
notice memory misses in any part of the memory between VALUE
|
and the amount allocated.
|
and the amount allocated.
|
|
|
As a consequence users are strongly recommended to specify
|
As a consequence users are strongly recommended to specify
|
memory sizes that are an exact power of 2. If some other
|
memory sizes that are an exact power of 2. If some other
|
amount of memory is required, it should be specified as
|
amount of memory is required, it should be specified as
|
separate, contiguous blocks, each of which is a power of 2 in
|
separate, contiguous blocks, each of which is a power of 2 in
|
size.
|
size.
|
|
|
`name = "TEXT"'
|
`name = "TEXT"'
|
Name the block. Typically these describe the type of memory being
|
Name the block. Typically these describe the type of memory being
|
modeled (thus `"SRAM"' or `"Flash"'. The default is
|
modeled (thus `"SRAM"' or `"Flash"'. The default is
|
`"anonymous memory block"'.
|
`"anonymous memory block"'.
|
|
|
Note: It is not clear that this information is currently ever
|
Note: It is not clear that this information is currently ever
|
used in normal operation of the simulator. Even the `info'
|
used in normal operation of the simulator. Even the `info'
|
command of the simulator ignores it.
|
command of the simulator ignores it.
|
|
|
`ce = VALUE'
|
`ce = VALUE'
|
Set the chip enable index of the memory instance. Each memory
|
Set the chip enable index of the memory instance. Each memory
|
instance should have a unique chip enable index, which should be
|
instance should have a unique chip enable index, which should be
|
greater than or equal to zero. This is used by the memory
|
greater than or equal to zero. This is used by the memory
|
controller when identifying different memory instances.
|
controller when identifying different memory instances.
|
|
|
There is no requirement to set `ce' if a memory controller is not
|
There is no requirement to set `ce' if a memory controller is not
|
enabled. The default value is -1 (invalid).
|
enabled. The default value is -1 (invalid).
|
|
|
`mc = VALUE'
|
`mc = VALUE'
|
Specifies the memory controller this memory is connected to. It
|
Specifies the memory controller this memory is connected to. It
|
should correspond to the `index' field specified in a `section mc'
|
should correspond to the `index' field specified in a `section mc'
|
for a memory controller (*note Memory Controller Configuration:
|
for a memory controller (*note Memory Controller Configuration:
|
Memory Controller Configuration.).
|
Memory Controller Configuration.).
|
|
|
There is no requirement to set `mc' if a memory controller is not
|
There is no requirement to set `mc' if a memory controller is not
|
enabled. Default value is 0, which is also the default value of a
|
enabled. Default value is 0, which is also the default value of a
|
memory controller `index' field. This is suitable therefore for
|
memory controller `index' field. This is suitable therefore for
|
designs with just one memory controller.
|
designs with just one memory controller.
|
|
|
`delayr = VALUE'
|
`delayr = VALUE'
|
The number of cycles required for a read access. Set to -1 if the
|
The number of cycles required for a read access. Set to -1 if the
|
memory does not support reading. Default value 1. The simulator
|
memory does not support reading. Default value 1. The simulator
|
will add this number of cycles to the total instruction cycle
|
will add this number of cycles to the total instruction cycle
|
count when reading from main memory.
|
count when reading from main memory.
|
|
|
`delayw = VALUE'
|
`delayw = VALUE'
|
The number of cycles required for a write access. Set to -1 if the
|
The number of cycles required for a write access. Set to -1 if the
|
memory does not support writing. Default value 1. The simulator
|
memory does not support writing. Default value 1. The simulator
|
will add this number of cycles to the total instruction cycle
|
will add this number of cycles to the total instruction cycle
|
count when writing to main memory.
|
count when writing to main memory.
|
|
|
`log = "FILE"'
|
`log = "FILE"'
|
If specified, `file' names a file for all memory accesses to be
|
If specified, `file' names a file for all memory accesses to be
|
logged. If not specified, the default value, NULL is used, meaning
|
logged. If not specified, the default value, NULL is used, meaning
|
that the memory is not logged.
|
that the memory is not logged.
|
|
|
|
|
|
|
File: or1ksim.info, Node: Memory Management Configuration, Next: Cache Configuration, Prev: Memory Configuration, Up: Core OpenRISC Configuration
|
File: or1ksim.info, Node: Memory Management Configuration, Next: Cache Configuration, Prev: Memory Configuration, Up: Core OpenRISC Configuration
|
|
|
3.3.3 Memory Management Configuration
|
3.3.3 Memory Management Configuration
|
-------------------------------------
|
-------------------------------------
|
|
|
Memory Management Unit (MMU) configuration is described in `section
|
Memory Management Unit (MMU) configuration is described in `section
|
dmmu' (for the data MMU) and `section immu' (for the instruction MMU).
|
dmmu' (for the data MMU) and `section immu' (for the instruction MMU).
|
Each section should appear at most once. The following parameters may
|
Each section should appear at most once. The following parameters may
|
be specified.
|
be specified.
|
|
|
`enabled = 0|1'
|
`enabled = 0|1'
|
If 1 (true), the data or instruction (as appropriate) MMU is
|
If 1 (true), the data or instruction (as appropriate) MMU is
|
enabled. If 0 (the default), it is disabled.
|
enabled. If 0 (the default), it is disabled.
|
|
|
`nsets = VALUE'
|
`nsets = VALUE'
|
Sets the number of data or instruction (as appropriate) TLB sets to
|
Sets the number of data or instruction (as appropriate) TLB sets to
|
VALUE, which must be a power of two, not exceeding 128. Values
|
VALUE, which must be a power of two, not exceeding 128. Values
|
which do not fit these criteria are ignored with a warning. The
|
which do not fit these criteria are ignored with a warning. The
|
default value is 1.
|
default value is 1.
|
|
|
`nways = VALUE'
|
`nways = VALUE'
|
Sets the number of data or instruction (as appropriate) TLB ways to
|
Sets the number of data or instruction (as appropriate) TLB ways to
|
VALUE. The value must be in the range 1 to 4. Values outside
|
VALUE. The value must be in the range 1 to 4. Values outside
|
this range are ignored with a warning. The default value is 1.
|
this range are ignored with a warning. The default value is 1.
|
|
|
`pagesize = VALUE'
|
`pagesize = VALUE'
|
The data or instruction (as appropriate) MMU page size is set to
|
The data or instruction (as appropriate) MMU page size is set to
|
VALUE, which must be a power of 2. Values which are not a power
|
VALUE, which must be a power of 2. Values which are not a power
|
of 2 are ignored with a warning. The default is 8192 (0x2000).
|
of 2 are ignored with a warning. The default is 8192 (0x2000).
|
|
|
`entrysize = VALUE'
|
`entrysize = VALUE'
|
The data or instruction (as appropriate) MMU entry size is set to
|
The data or instruction (as appropriate) MMU entry size is set to
|
VALUE, which must be a power of 2. Values which are not a power
|
VALUE, which must be a power of 2. Values which are not a power
|
of 2 are ignored with a warning. The default value is 1.
|
of 2 are ignored with a warning. The default value is 1.
|
|
|
Note: Or1ksim does not appear to use the `entrysize' parameter
|
Note: Or1ksim does not appear to use the `entrysize' parameter
|
in its simulation of the MMUs. Thus setting this value does
|
in its simulation of the MMUs. Thus setting this value does
|
not seem to matter.
|
not seem to matter.
|
|
|
`ustates = VALUE'
|
`ustates = VALUE'
|
The number of instruction usage states for the data or instruction
|
The number of instruction usage states for the data or instruction
|
(as appropriate) MMU is set to VALUE, which must be 2, 3 or 4.
|
(as appropriate) MMU is set to VALUE, which must be 2, 3 or 4.
|
Values outside this range are ignored with a warning. The default
|
Values outside this range are ignored with a warning. The default
|
value is 2.
|
value is 2.
|
|
|
Note: Or1ksim does not appear to use the `ustates' parameter
|
Note: Or1ksim does not appear to use the `ustates' parameter
|
in its simulation of the MMUs. Thus setting this value does
|
in its simulation of the MMUs. Thus setting this value does
|
not seem to matter.
|
not seem to matter.
|
|
|
`hitdelay = VALUE'
|
`hitdelay = VALUE'
|
Set the number of cycles a data or instruction (as appropriate) MMU
|
Set the number of cycles a data or instruction (as appropriate) MMU
|
hit costs. Default value 1.
|
hit costs. Default value 1.
|
|
|
`missdelay = VALUE'
|
`missdelay = VALUE'
|
Set the number of cycles a data or instruction (as appropriate) MMU
|
Set the number of cycles a data or instruction (as appropriate) MMU
|
miss costs. Default value 1.
|
miss costs. Default value 1.
|
|
|
|
|
|
|
File: or1ksim.info, Node: Cache Configuration, Next: Interrupt Configuration, Prev: Memory Management Configuration, Up: Core OpenRISC Configuration
|
File: or1ksim.info, Node: Cache Configuration, Next: Interrupt Configuration, Prev: Memory Management Configuration, Up: Core OpenRISC Configuration
|
|
|
3.3.4 Cache Configuration
|
3.3.4 Cache Configuration
|
-------------------------
|
-------------------------
|
|
|
Cache configuration is described in `section dc' (for the data cache)
|
Cache configuration is described in `section dc' (for the data cache)
|
and `seciton ic' (for the instruction cache). Each section should
|
and `seciton ic' (for the instruction cache). Each section should
|
appear at most once. The following parameters may be specified.
|
appear at most once. The following parameters may be specified.
|
|
|
`enabled = 0|1'
|
`enabled = 0|1'
|
If 1 (true), the data or instruction (as appropriate) cache is
|
If 1 (true), the data or instruction (as appropriate) cache is
|
enabled. If 0 (the default), it is disabled.
|
enabled. If 0 (the default), it is disabled.
|
|
|
`nsets = VALUE'
|
`nsets = VALUE'
|
Sets the number of data or instruction (as appropriate) cache sets
|
Sets the number of data or instruction (as appropriate) cache sets
|
to VALUE, which must be a power of two, not exceeding
|
to VALUE, which must be a power of two, not exceeding
|
`MAX_DC_SETS' (for the data cache) or `MAX_IC_SETS' (for the
|
`MAX_DC_SETS' (for the data cache) or `MAX_IC_SETS' (for the
|
instruction cache). At the time of writing, these constants are
|
instruction cache). At the time of writing, these constants are
|
both defined in the code to be 1024). The default value is 1.
|
both defined in the code to be 1024). The default value is 1.
|
|
|
`nways = VALUE'
|
`nways = VALUE'
|
Sets the number of data or instruction (as appropriate) cache ways
|
Sets the number of data or instruction (as appropriate) cache ways
|
to VALUE, which must be a power of two, not exceeding
|
to VALUE, which must be a power of two, not exceeding
|
`MAX_DC_WAYS' (for the data cache) or `MAX_IC_WAYS' (for the
|
`MAX_DC_WAYS' (for the data cache) or `MAX_IC_WAYS' (for the
|
instruction cache). At the time of writing, these constants are
|
instruction cache). At the time of writing, these constants are
|
both defined in the code to be 32). The default value is 1.
|
both defined in the code to be 32). The default value is 1.
|
|
|
`blocksize = VALUE'
|
`blocksize = VALUE'
|
The data or instruction (as appropriate) cache block size is set to
|
The data or instruction (as appropriate) cache block size is set to
|
VALUE bytes, which must be either 16 or 32. The default is 16.
|
VALUE bytes, which must be either 16 or 32. The default is 16.
|
|
|
`ustates = VALUE'
|
`ustates = VALUE'
|
The number of instruction usage states for the data or instruction
|
The number of instruction usage states for the data or instruction
|
(as appropriate) cache is set to VALUE, which must be 2, 3 or 4.
|
(as appropriate) cache is set to VALUE, which must be 2, 3 or 4.
|
The default value is 2.
|
The default value is 2.
|
|
|
`hitdelay = VALUE'
|
`hitdelay = VALUE'
|
_Instruction cache only_. Set the number of cycles an instruction
|
_Instruction cache only_. Set the number of cycles an instruction
|
cache hit costs. Default value 1.
|
cache hit costs. Default value 1.
|
|
|
`missdelay = VALUE'
|
`missdelay = VALUE'
|
_Instruction cache only_. Set the number of cycles an instruction
|
_Instruction cache only_. Set the number of cycles an instruction
|
cache miss costs. Default value 1.
|
cache miss costs. Default value 1.
|
|
|
`load_hitdelay = VALUE'
|
`load_hitdelay = VALUE'
|
_Data cache only_. Set the number of cycles a data load cache hit
|
_Data cache only_. Set the number of cycles a data load cache hit
|
costs. Default value 2.
|
costs. Default value 2.
|
|
|
`load_missdelay = VALUE'
|
`load_missdelay = VALUE'
|
_Data cache only_. Set the number of cycles a data load cache
|
_Data cache only_. Set the number of cycles a data load cache
|
miss costs. Default value 2.
|
miss costs. Default value 2.
|
|
|
`store_hitdelay = VALUE'
|
`store_hitdelay = VALUE'
|
_Data cache only_. Set the number of cycles a data store cache hit
|
_Data cache only_. Set the number of cycles a data store cache hit
|
costs. Default value 0.
|
costs. Default value 0.
|
|
|
`store_missdelay = VALUE'
|
`store_missdelay = VALUE'
|
_Data cache only_. Set the number of cycles a data store cache
|
_Data cache only_. Set the number of cycles a data store cache
|
miss costs. Default value 0.
|
miss costs. Default value 0.
|
|
|
|
|
|
|
File: or1ksim.info, Node: Interrupt Configuration, Next: Power Management Configuration, Prev: Cache Configuration, Up: Core OpenRISC Configuration
|
File: or1ksim.info, Node: Interrupt Configuration, Next: Power Management Configuration, Prev: Cache Configuration, Up: Core OpenRISC Configuration
|
|
|
3.3.5 Interrupt Configuration
|
3.3.5 Interrupt Configuration
|
-----------------------------
|
-----------------------------
|
|
|
Programmable Interrupt Controller (PIC) configuration is described in
|
Programmable Interrupt Controller (PIC) configuration is described in
|
`section pic'. This section may appear at most once--Or1ksim has no
|
`section pic'. This section may appear at most once--Or1ksim has no
|
mechanism for handling multiple interrupt controllers. The following
|
mechanism for handling multiple interrupt controllers. The following
|
parameters may be specified.
|
parameters may be specified.
|
|
|
`enabled = 0|1'
|
`enabled = 0|1'
|
If 1 (true), the programmable interrupt controller is enabled. If
|
If 1 (true), the programmable interrupt controller is enabled. If
|
0 (the default), it is disabled.
|
0 (the default), it is disabled.
|
|
|
`edge_trigger = 0|1'
|
`edge_trigger = 0|1'
|
If 1 (true, the default), the programmable interrupt controller is
|
If 1 (true, the default), the programmable interrupt controller is
|
edge triggered. If 0 (false), it is level triggered.
|
edge triggered. If 0 (false), it is level triggered.
|
|
|
|
Note: When configured to be edge triggered, interrupts must
|
|
be cleared in the PICSR by the processor writing a '0' to the
|
|
appropriate bit.
|
|
|
|
When configured to be level triggered, the interrupt must be
|
|
cleared by lowering the peripheral's IRQ line. Writing '0' to
|
|
the PICSR has no effect.
|
|
|
|
Peripherals can call the function `report_interrupt' to
|
|
signal an interrupt request. When configured for level
|
|
triggered interrupts, the function `clear_interrupt' will
|
|
clear the appropriate bit in the PICSR. `clear_interrupt' has
|
|
no effect when Or1ksim is configured for edge triggered
|
|
interrupts - interrupts must be cleared by the processor
|
|
writing '0' to the appropriate bit in the PICSR in this case.
|
|
|
|
|
|
|
File: or1ksim.info, Node: Power Management Configuration, Next: Branch Prediction Configuration, Prev: Interrupt Configuration, Up: Core OpenRISC Configuration
|
File: or1ksim.info, Node: Power Management Configuration, Next: Branch Prediction Configuration, Prev: Interrupt Configuration, Up: Core OpenRISC Configuration
|
|
|
3.3.6 Power Management Configuration
|
3.3.6 Power Management Configuration
|
------------------------------------
|
------------------------------------
|
|
|
Power management implementation is incomplete. At present the effect
|
Power management implementation is incomplete. At present the effect
|
(which only happens when the power management unit is enabled) of
|
(which only happens when the power management unit is enabled) of
|
setting the different bits in the power management Special Purpose
|
setting the different bits in the power management Special Purpose
|
Register (PMR, SPR 0x4000) is
|
Register (PMR, SPR 0x4000) is
|
|
|
`SDF (bit mask 0x0000000f)'
|
`SDF (bit mask 0x0000000f)'
|
No effect - these bits are ignored
|
No effect - these bits are ignored
|
|
|
`DME (bit mask 0x00000010)'
|
`DME (bit mask 0x00000010)'
|
`SME (bit mask 0x00000020)'
|
`SME (bit mask 0x00000020)'
|
Both these bits cause the processor to stop executing
|
Both these bits cause the processor to stop executing
|
instructions. However all other functions (debug interaction, CLI,
|
instructions. However all other functions (debug interaction, CLI,
|
VAPI etc) carry on as normal.
|
VAPI etc) carry on as normal.
|
|
|
`DCGE (bit mask 0x00000004)'
|
`DCGE (bit mask 0x00000004)'
|
No effect - this bit is ignored
|
No effect - this bit is ignored
|
|
|
`SUME (bit mask 0x00000008)'
|
`SUME (bit mask 0x00000008)'
|
Enabling this bit causes a message to be printed, advising that the
|
Enabling this bit causes a message to be printed, advising that the
|
processor is suspending and the simulator exits.
|
processor is suspending and the simulator exits.
|
|
|
|
|
On reset all bits are cleared.
|
On reset all bits are cleared.
|
|
|
Power management configuration is described in `section pm'. This
|
Power management configuration is described in `section pm'. This
|
section may appear at most once. The following parameter may be
|
section may appear at most once. The following parameter may be
|
specified.
|
specified.
|
|
|
`enabled = 0|1'
|
`enabled = 0|1'
|
If 1 (true), power management is enabled. If 0 (the default), it
|
If 1 (true), power management is enabled. If 0 (the default), it
|
is disabled.
|
is disabled.
|
|
|
|
|
|
|
File: or1ksim.info, Node: Branch Prediction Configuration, Next: Debug Interface Configuration, Prev: Power Management Configuration, Up: Core OpenRISC Configuration
|
File: or1ksim.info, Node: Branch Prediction Configuration, Next: Debug Interface Configuration, Prev: Power Management Configuration, Up: Core OpenRISC Configuration
|
|
|
3.3.7 Branch Prediction Configuration
|
3.3.7 Branch Prediction Configuration
|
-------------------------------------
|
-------------------------------------
|
|
|
From examining the code base, it seems the branch prediction function
|
From examining the code base, it seems the branch prediction function
|
is not fully implemented. At present the functionality seems
|
is not fully implemented. At present the functionality seems
|
restricted to collection of statistics.
|
restricted to collection of statistics.
|
|
|
Branch prediction configuration is described in `section bpb'. This
|
Branch prediction configuration is described in `section bpb'. This
|
section may appear at most once. The following parameters may be
|
section may appear at most once. The following parameters may be
|
specified.
|
specified.
|
|
|
`enabled = 0|1'
|
`enabled = 0|1'
|
If 1 (true), branch prediction is enabled. If 0 (the default), it
|
If 1 (true), branch prediction is enabled. If 0 (the default), it
|
is disabled.
|
is disabled.
|
|
|
`btic = 0|1'
|
`btic = 0|1'
|
If 1 (true), the branch target instruction cache model is enabled.
|
If 1 (true), the branch target instruction cache model is enabled.
|
If 0 (the default), it is disabled.
|
If 0 (the default), it is disabled.
|
|
|
`sbp_bf_fwd = 0|1'
|
`sbp_bf_fwd = 0|1'
|
If 1 (true), use forward prediction for the `l.bf' instruction. If
|
If 1 (true), use forward prediction for the `l.bf' instruction. If
|
0 (the default), do not use forward prediction for this
|
0 (the default), do not use forward prediction for this
|
instruction.
|
instruction.
|
|
|
`sbp_bnf_fwd = 0|1'
|
`sbp_bnf_fwd = 0|1'
|
If 1 (true), use forward prediction for the `l.bnf' instruction.
|
If 1 (true), use forward prediction for the `l.bnf' instruction.
|
If 0 (the default), do not use forward prediction for this
|
If 0 (the default), do not use forward prediction for this
|
instruction.
|
instruction.
|
|
|
`hitdelay = VALUE'
|
`hitdelay = VALUE'
|
Set the number of cycles a branch prediction hit costs. Default
|
Set the number of cycles a branch prediction hit costs. Default
|
value 0.
|
value 0.
|
|
|
`missdelay = VALUE'
|
`missdelay = VALUE'
|
Set the number of cycles a branch prediction miss costs. Default
|
Set the number of cycles a branch prediction miss costs. Default
|
value 0.
|
value 0.
|
|
|
|
|
|
|
File: or1ksim.info, Node: Debug Interface Configuration, Prev: Branch Prediction Configuration, Up: Core OpenRISC Configuration
|
File: or1ksim.info, Node: Debug Interface Configuration, Prev: Branch Prediction Configuration, Up: Core OpenRISC Configuration
|
|
|
3.3.8 Debug Interface Configuration
|
3.3.8 Debug Interface Configuration
|
-----------------------------------
|
-----------------------------------
|
|
|
The debug unit and debug interface configuration is described in
|
The debug unit and debug interface configuration is described in
|
`section debug'. This section may appear at most once. The following
|
`section debug'. This section may appear at most once. The following
|
parameters may be specified.
|
parameters may be specified.
|
|
|
`enabled = 0|1'
|
`enabled = 0|1'
|
If 1 (true), the debug unit is enabled. If 0 (the default), it is
|
If 1 (true), the debug unit is enabled. If 0 (the default), it is
|
disabled.
|
disabled.
|
|
|
Note: This enables the functionality of the debug unit (its
|
Note: This enables the functionality of the debug unit (its
|
registers etc) within the mode. It does not provide any
|
registers etc) within the mode. It does not provide any
|
external interface to the debug unit. For that, see
|
external interface to the debug unit. For that, see
|
`rsp_enabled' below.
|
`rsp_enabled' below.
|
|
|
`rsp_enabled = 0|1'
|
`rsp_enabled = 0|1'
|
If 1 (true), the GDB "Remote Serial Protocol" server is started,
|
If 1 (true), the GDB "Remote Serial Protocol" server is started,
|
provding an interface to an external GNU debugger, using the port
|
provding an interface to an external GNU debugger, using the port
|
specified in the `rsp_port' field (see below), or the
|
specified in the `rsp_port' field (see below), or the
|
`or1ksim-rsp' TCP/IP service. If 0 (the default), the server is
|
`or1ksim-rsp' TCP/IP service. If 0 (the default), the server is
|
not started, and no external interface is provided.
|
not started, and no external interface is provided.
|
|
|
For more detailed information on the interface to the GNU Debugger
|
For more detailed information on the interface to the GNU Debugger
|
see Embecosm Application Note 2, `Howto: Porting the GNU Debugger
|
see Embecosm Application Note 2, `Howto: Porting the GNU Debugger
|
Practical Experience with the OpenRISC 1000 Architecture', by
|
Practical Experience with the OpenRISC 1000 Architecture', by
|
Jeremy Bennett, published by Embecosm Limited (`www.embecosm.com').
|
Jeremy Bennett, published by Embecosm Limited (`www.embecosm.com').
|
|
|
`rsp_port = VALUE'
|
`rsp_port = VALUE'
|
VALUE specifies the port to be used for the GDB "Remote Serial
|
VALUE specifies the port to be used for the GDB "Remote Serial
|
Protocol" interface to the GNU Debugger (GDB). Default value
|
Protocol" interface to the GNU Debugger (GDB). Default value
|
51000. If the value 0 is specified, Or1ksim will instead look for
|
51000. If the value 0 is specified, Or1ksim will instead look for
|
a TCP/IP service named `or1ksim-rsp'.
|
a TCP/IP service named `or1ksim-rsp'.
|
|
|
Tip: There is no registered port for Or1ksim "Remote Serial
|
Tip: There is no registered port for Or1ksim "Remote Serial
|
Protocol" service `or1ksim-rsp'. Good practice suggests
|
Protocol" service `or1ksim-rsp'. Good practice suggests
|
users should adopt port values in the "Dynamic" or "Private"
|
users should adopt port values in the "Dynamic" or "Private"
|
port range, i.e. 49152-65535.
|
port range, i.e. 49152-65535.
|
|
|
`vapi_id = VALUE'
|
`vapi_id = VALUE'
|
VALUE specifies the value of the Verification API (VAPI) base
|
VALUE specifies the value of the Verification API (VAPI) base
|
address to be used with the debug unit. *Note Verification API:
|
address to be used with the debug unit. *Note Verification API:
|
Verification API, for more details.
|
Verification API, for more details.
|
|
|
If this is specified and VALUE is non-zero, all OpenRISC Remote
|
If this is specified and VALUE is non-zero, all OpenRISC Remote
|
JTAG protocol transactions will be logged to the VAPI log file, if
|
JTAG protocol transactions will be logged to the VAPI log file, if
|
enabled. This is the only functionality associated with VAPI for
|
enabled. This is the only functionality associated with VAPI for
|
the debug unit. No VAPI commands are sent, nor requests handled.
|
the debug unit. No VAPI commands are sent, nor requests handled.
|
|
|
|
|
|
|
File: or1ksim.info, Node: Peripheral Configuration, Prev: Core OpenRISC Configuration, Up: Configuration
|
File: or1ksim.info, Node: Peripheral Configuration, Prev: Core OpenRISC Configuration, Up: Configuration
|
|
|
3.4 Configuring Memory Mapped Peripherals
|
3.4 Configuring Memory Mapped Peripherals
|
=========================================
|
=========================================
|
|
|
All peripheral components are optional. If they are specified, then
|
All peripheral components are optional. If they are specified, then
|
(unlike other components) by default they are enabled.
|
(unlike other components) by default they are enabled.
|
|
|
* Menu:
|
* Menu:
|
|
|
* Memory Controller Configuration::
|
* Memory Controller Configuration::
|
* UART Configuration::
|
* UART Configuration::
|
* DMA Configuration::
|
* DMA Configuration::
|
* Ethernet Configuration::
|
* Ethernet Configuration::
|
* GPIO Configuration::
|
* GPIO Configuration::
|
* Display Interface Configuration::
|
* Display Interface Configuration::
|
* Frame Buffer Configuration::
|
* Frame Buffer Configuration::
|
* Keyboard Configuration::
|
* Keyboard Configuration::
|
* Disc Interface Configuration::
|
* Disc Interface Configuration::
|
* Generic Peripheral Configuration::
|
* Generic Peripheral Configuration::
|
|
|
|
|
File: or1ksim.info, Node: Memory Controller Configuration, Next: UART Configuration, Up: Peripheral Configuration
|
File: or1ksim.info, Node: Memory Controller Configuration, Next: UART Configuration, Up: Peripheral Configuration
|
|
|
3.4.1 Memory Controller Configuration
|
3.4.1 Memory Controller Configuration
|
-------------------------------------
|
-------------------------------------
|
|
|
The memory controller used in Or1ksim is the component implemented at
|
The memory controller used in Or1ksim is the component implemented at
|
OpenCores, and found in the top level SVN directory, `mem_ctrl'. It is
|
OpenCores, and found in the top level SVN directory, `mem_ctrl'. It is
|
described in the document `Memory Controller IP Core' by Rudolf
|
described in the document `Memory Controller IP Core' by Rudolf
|
Usselmann, which can be found in the `doc' subdirectory. It is a
|
Usselmann, which can be found in the `doc' subdirectory. It is a
|
memory mapped component, which resides on the main OpenRISC Wishbone
|
memory mapped component, which resides on the main OpenRISC Wishbone
|
data bus.
|
data bus.
|
|
|
The memory controller configuration is described in `section mc'. This
|
The memory controller configuration is described in `section mc'. This
|
section may appear multiple times, specifying multiple memory
|
section may appear multiple times, specifying multiple memory
|
controllers.
|
controllers.
|
|
|
Warning: There are known to be problems with the current memory
|
Warning: There are known to be problems with the current memory
|
controller, which currently is not included in the regression test
|
controller, which currently is not included in the regression test
|
suite. Users are advised not to use the memory controller in the
|
suite. Users are advised not to use the memory controller in the
|
current release.
|
current release.
|
|
|
Caution: There is no initialization code in the standard "newlib"
|
Caution: There is no initialization code in the standard "newlib"
|
library.
|
library.
|
|
|
The standard "uClibc" library assumes a memory controller mapped
|
The standard "uClibc" library assumes a memory controller mapped
|
at 0x93000000 and will initialize the memory controller to expect
|
at 0x93000000 and will initialize the memory controller to expect
|
64MB memory blocks, and any memory declarations _must_ reflect
|
64MB memory blocks, and any memory declarations _must_ reflect
|
this.
|
this.
|
|
|
If smaller memory blocks are declared with a memory controller,
|
If smaller memory blocks are declared with a memory controller,
|
then sufficient memory will not be allocated by Or1ksim, but out of
|
then sufficient memory will not be allocated by Or1ksim, but out of
|
range memory accesses will not be trapped. For example declaring a
|
range memory accesses will not be trapped. For example declaring a
|
memory section from 0-4MB with a memory controller enabled would
|
memory section from 0-4MB with a memory controller enabled would
|
mean that accesses between 4MB and 64MB would be permitted, but
|
mean that accesses between 4MB and 64MB would be permitted, but
|
having no allocated memory would likely cause a segmentation fault.
|
having no allocated memory would likely cause a segmentation fault.
|
|
|
If the user is determined to use smaller memories with the memory
|
If the user is determined to use smaller memories with the memory
|
controller, then custom initialization code must be provided, to
|
controller, then custom initialization code must be provided, to
|
ensure the memory controller traps out-of-memory accesses.
|
ensure the memory controller traps out-of-memory accesses.
|
|
|
The following parameters may be specified.
|
The following parameters may be specified.
|
|
|
`enabled = 0|1'
|
`enabled = 0|1'
|
If 1 (true, the default), this memory controller is enabled. If
|
If 1 (true, the default), this memory controller is enabled. If
|
0, it is disabled.
|
0, it is disabled.
|
|
|
Note: The memory controller can effectively also be disabled
|
Note: The memory controller can effectively also be disabled
|
by setting an appropriate power on control register value
|
by setting an appropriate power on control register value
|
(see below). However this should only be used if it is
|
(see below). However this should only be used if it is
|
desired to specifically model this behavior of the memory
|
desired to specifically model this behavior of the memory
|
controller, not as a way of disabling the memory controller
|
controller, not as a way of disabling the memory controller
|
in general.
|
in general.
|
|
|
`baseaddr = VALUE'
|
`baseaddr = VALUE'
|
Set the base address of the memory controller's memory mapped
|
Set the base address of the memory controller's memory mapped
|
registers to VALUE. The default is 0, which is probably not a
|
registers to VALUE. The default is 0, which is probably not a
|
sensible value.
|
sensible value.
|
|
|
The memory controller has a 7 bit address bus, with a total of 19
|
The memory controller has a 7 bit address bus, with a total of 19
|
32-bit registers, at addresses 0x00 through 0x4c (address 0x0c and
|
32-bit registers, at addresses 0x00 through 0x4c (address 0x0c and
|
addresses 0x50 through 0x7c are not used).
|
addresses 0x50 through 0x7c are not used).
|
|
|
`poc = VALUE'
|
`poc = VALUE'
|
Specifies the value of the power on control register, The least
|
Specifies the value of the power on control register, The least
|
signficant two bits specify the bus width (use 0 for an 8-bit bus,
|
signficant two bits specify the bus width (use 0 for an 8-bit bus,
|
1 for a 16-bit bus and 2 for a 32-bit bus) and the next two bits
|
1 for a 16-bit bus and 2 for a 32-bit bus) and the next two bits
|
the type of memory connected (use 0 for a disabled interface, 1
|
the type of memory connected (use 0 for a disabled interface, 1
|
for SSRAM, 2 for asyncrhonous devices and 3 for synchronous
|
for SSRAM, 2 for asyncrhonous devices and 3 for synchronous
|
devices).
|
devices).
|
|
|
If other bits are specified, they are ignored with a warning.
|
If other bits are specified, they are ignored with a warning.
|
|
|
Caution: The default value, 0, corresponds to a disabled
|
Caution: The default value, 0, corresponds to a disabled
|
8-bit bus, and is likely not the most suitable value
|
8-bit bus, and is likely not the most suitable value
|
|
|
`index = VALUE'
|
`index = VALUE'
|
Specify the index of this memory controller amongst all the memory
|
Specify the index of this memory controller amongst all the memory
|
controllers. This value should be unique for each memory
|
controllers. This value should be unique for each memory
|
controller, and is used to associate specific memories with the
|
controller, and is used to associate specific memories with the
|
controller, through the `mc' field in the `section memory'
|
controller, through the `mc' field in the `section memory'
|
configuration (*note Memory Configuration: Memory Configuration.).
|
configuration (*note Memory Configuration: Memory Configuration.).
|
|
|
The default value, 0, is suitable when there is only one memory
|
The default value, 0, is suitable when there is only one memory
|
controller.
|
controller.
|
|
|
|
|
|
|
File: or1ksim.info, Node: UART Configuration, Next: DMA Configuration, Prev: Memory Controller Configuration, Up: Peripheral Configuration
|
File: or1ksim.info, Node: UART Configuration, Next: DMA Configuration, Prev: Memory Controller Configuration, Up: Peripheral Configuration
|
|
|
3.4.2 UART Configuration
|
3.4.2 UART Configuration
|
------------------------
|
------------------------
|
|
|
The UART implemented in Or1ksim follows the specification of the
|
The UART implemented in Or1ksim follows the specification of the
|
National Semiconductor 16450 and 16550 parts. It is a memory mapped
|
National Semiconductor 16450 and 16550 parts. It is a memory mapped
|
component, which resides on the main OpenRISC Wishbone data bus.
|
component, which resides on the main OpenRISC Wishbone data bus.
|
|
|
The component provides a number of interfaces to emulate the behavior
|
The component provides a number of interfaces to emulate the behavior
|
of an external terminal connected to the UART.
|
of an external terminal connected to the UART.
|
|
|
UART configuration is described in `section uart'. This section may
|
UART configuration is described in `section uart'. This section may
|
appear multiple times, specifying multiple UARTs. The following
|
appear multiple times, specifying multiple UARTs. The following
|
parameters may be specified.
|
parameters may be specified.
|
|
|
`enabled = 0|1'
|
`enabled = 0|1'
|
If 1 (true, the default), this UART is enabled. If 0, it is
|
If 1 (true, the default), this UART is enabled. If 0, it is
|
disabled.
|
disabled.
|
|
|
`baseaddr = VALUE'
|
`baseaddr = VALUE'
|
Set the base address of the UART's memory mapped registers to
|
Set the base address of the UART's memory mapped registers to
|
VALUE. The default is 0, which is probably not a sensible value.
|
VALUE. The default is 0, which is probably not a sensible value.
|
|
|
The UART has a 3 bit address bus, with a total of 8 8-bit
|
The UART has a 3 bit address bus, with a total of 8 8-bit
|
registers, at addresses 0x0 through 0x7.
|
registers, at addresses 0x0 through 0x7.
|
|
|
`channel = "TYPE:ARGS"'
|
`channel = "TYPE:ARGS"'
|
Specify the channel representing the terminal connected to the UART
|
Specify the channel representing the terminal connected to the UART
|
Rx & Tx pins.
|
Rx & Tx pins.
|
|
|
`channel="file:`rxfile',`txfile'"'
|
`channel="file:`rxfile',`txfile'"'
|
Read input characters from the file `rxfile' and write output
|
Read input characters from the file `rxfile' and write output
|
characters to the file `txfile' (which will be created if
|
characters to the file `txfile' (which will be created if
|
required).
|
required).
|
|
|
`channel="xterm:ARGS"'
|
`channel="xterm:ARGS"'
|
Create an xterm on startup, write UART Tx traffic to the
|
Create an xterm on startup, write UART Tx traffic to the
|
xterm and take Rx traffic from the keyboard when the xterm
|
xterm and take Rx traffic from the keyboard when the xterm
|
window is selected. Additional arguments to the xterm
|
window is selected. Additional arguments to the xterm
|
command (for example specifying window size may be specified
|
command (for example specifying window size may be specified
|
in ARGS, or this may be left blank.
|
in ARGS, or this may be left blank.
|
|
|
`channel="tcp:VALUE"'
|
`channel="tcp:VALUE"'
|
Open the TCP/IP port specified by VALUE and read and write
|
Open the TCP/IP port specified by VALUE and read and write
|
UART traffic from and to it.
|
UART traffic from and to it.
|
|
|
Typically a telnet session is connected to the other end of
|
Typically a telnet session is connected to the other end of
|
this port.
|
this port.
|
|
|
Tip: There is no registered port for Or1ksim telnet UART
|
Tip: There is no registered port for Or1ksim telnet UART
|
connection. Priviledged access is required to read
|
connection. Priviledged access is required to read
|
traffic on the registered "well-known" telnet port (23).
|
traffic on the registered "well-known" telnet port (23).
|
Instead users should use port values in the "Dynamic" or
|
Instead users should use port values in the "Dynamic" or
|
"Private" port range, i.e. 49152-65535.
|
"Private" port range, i.e. 49152-65535.
|
|
|
`channel="fd:`rxfd',`txfd'"'
|
`channel="fd:`rxfd',`txfd'"'
|
Read and write characters from and to the existing open
|
Read and write characters from and to the existing open
|
numerical file descriptors, file `rxfd' and `txfd'.
|
numerical file descriptors, file `rxfd' and `txfd'.
|
|
|
`channel="tty:device=/dev/ttyS0,baud=9600"'
|
`channel="tty:device=/dev/ttyS0,baud=9600"'
|
Read and write characters from and to a physical serial port.
|
Read and write characters from and to a physical serial port.
|
The precise device (shown here as `/dev/ttyS0') may vary from
|
The precise device (shown here as `/dev/ttyS0') may vary from
|
machine to machine.
|
machine to machine.
|
|
|
|
|
The default value for this field is `"xterm:"'.
|
The default value for this field is `"xterm:"'.
|
|
|
`irq = VALUE'
|
`irq = VALUE'
|
Use VALUE as the IRQ number of this UART. Default value 0.
|
Use VALUE as the IRQ number of this UART. Default value 0.
|
|
|
`16550 = 0|1'
|
`16550 = 0|1'
|
If 1 (true), the UART has the functionality of a 16550. If 0 (the
|
If 1 (true), the UART has the functionality of a 16550. If 0 (the
|
default), it has the functionality of a 16450. The principal
|
default), it has the functionality of a 16450. The principal
|
difference is that the 16550 can buffer multiple characters.
|
difference is that the 16550 can buffer multiple characters.
|
|
|
`jitter = VALUE'
|
`jitter = VALUE'
|
Set the jitter, modeled as a time to block, to VALUE milliseconds.
|
Set the jitter, modeled as a time to block, to VALUE milliseconds.
|
Set to -1 to disable jitter modeling. Default value 0.
|
Set to -1 to disable jitter modeling. Default value 0.
|
|
|
Note: This functionality has yet to be implemented, so this
|
Note: This functionality has yet to be implemented, so this
|
parameter has no effect.
|
parameter has no effect.
|
|
|
`vapi_id = VALUE'
|
`vapi_id = VALUE'
|
VALUE specifies the value of the Verification API (VAPI) base
|
VALUE specifies the value of the Verification API (VAPI) base
|
address to be used with the UART. *Note Verification API:
|
address to be used with the UART. *Note Verification API:
|
Verification API, for more details, which details the use of the
|
Verification API, for more details, which details the use of the
|
VAPI with the UART.
|
VAPI with the UART.
|
|
|
|
|
|
|
File: or1ksim.info, Node: DMA Configuration, Next: Ethernet Configuration, Prev: UART Configuration, Up: Peripheral Configuration
|
File: or1ksim.info, Node: DMA Configuration, Next: Ethernet Configuration, Prev: UART Configuration, Up: Peripheral Configuration
|
|
|
3.4.3 DMA Configuration
|
3.4.3 DMA Configuration
|
-----------------------
|
-----------------------
|
|
|
The DMA controller used in Or1ksim is the component implemented at
|
The DMA controller used in Or1ksim is the component implemented at
|
OpenCores, and found in the top level SVN directory, `wb_dma'. It is
|
OpenCores, and found in the top level SVN directory, `wb_dma'. It is
|
described in the document `Wishbone DMA/Bridge IP Core' by Rudolf
|
described in the document `Wishbone DMA/Bridge IP Core' by Rudolf
|
Usselmann, which can be found in the `doc' subdirectory. It is a
|
Usselmann, which can be found in the `doc' subdirectory. It is a
|
memory mapped component, which resides on the main OpenRISC Wishbone
|
memory mapped component, which resides on the main OpenRISC Wishbone
|
data bus. The present implementation is incomplete, intended only to
|
data bus. The present implementation is incomplete, intended only to
|
support the Ethernet interface (*note Ethernet Configuration::),
|
support the Ethernet interface (*note Ethernet Configuration::),
|
although the Ethernet interface is not yet completed.
|
although the Ethernet interface is not yet completed.
|
|
|
DMA configuration is described in `section dma'. This section may
|
DMA configuration is described in `section dma'. This section may
|
appear multiple times, specifying multiple DMA controllers. The
|
appear multiple times, specifying multiple DMA controllers. The
|
following parameters may be specified.
|
following parameters may be specified.
|
|
|
`enabled = 0|1'
|
`enabled = 0|1'
|
If 1 (true, the default), this DMA controller is enabled. If 0,
|
If 1 (true, the default), this DMA controller is enabled. If 0,
|
it is disabled.
|
it is disabled.
|
|
|
`baseaddr = VALUE'
|
`baseaddr = VALUE'
|
Set the base address of the DMA's memory mapped registers to
|
Set the base address of the DMA's memory mapped registers to
|
VALUE. The default is 0, which is probably not a sensible value.
|
VALUE. The default is 0, which is probably not a sensible value.
|
|
|
The DMA controller has a 10 bit address bus, with a total of 253
|
The DMA controller has a 10 bit address bus, with a total of 253
|
32-bit registers. The first 5 registers at addresses 0x000 through
|
32-bit registers. The first 5 registers at addresses 0x000 through
|
0x010 control the overall behavior of the DMA controller. There
|
0x010 control the overall behavior of the DMA controller. There
|
are then 31 blocks of 8 registers, controlling each of the 31 DMA
|
are then 31 blocks of 8 registers, controlling each of the 31 DMA
|
channels available. Addresses 0x014 through 0x01c are not used.
|
channels available. Addresses 0x014 through 0x01c are not used.
|
|
|
`irq = VALUE'
|
`irq = VALUE'
|
Use VALUE as the IRQ number of this DMA controller. Default value
|
Use VALUE as the IRQ number of this DMA controller. Default value
|
0.
|
0.
|
|
|
`vapi_id = VALUE'
|
`vapi_id = VALUE'
|
VALUE specifies the value of the Verification API (VAPI) base
|
VALUE specifies the value of the Verification API (VAPI) base
|
address to be used with the DMA controller. *Note Verification
|
address to be used with the DMA controller. *Note Verification
|
API: Verification API, for more details, which details the use of
|
API: Verification API, for more details, which details the use of
|
the VAPI with the DMA controller.
|
the VAPI with the DMA controller.
|
|
|
|
|
|
|
File: or1ksim.info, Node: Ethernet Configuration, Next: GPIO Configuration, Prev: DMA Configuration, Up: Peripheral Configuration
|
File: or1ksim.info, Node: Ethernet Configuration, Next: GPIO Configuration, Prev: DMA Configuration, Up: Peripheral Configuration
|
|
|
3.4.4 Ethernet Configuration
|
3.4.4 Ethernet Configuration
|
----------------------------
|
----------------------------
|
|
|
The Ethernet MAC used in Or1ksim is the component implemented at
|
The Ethernet MAC used in Or1ksim is the component implemented at
|
OpenCores, and found in the top level SVN directory, `ethmac'. It also
|
OpenCores, and found in the top level SVN directory, `ethmac'. It also
|
forms part of the OpenRISC SoC, ORPSoC. It is described in the
|
forms part of the OpenRISC SoC, ORPSoC. It is described in the
|
document `Ethernet IP Core Specification' by Igor Mohor, which can be
|
document `Ethernet IP Core Specification' by Igor Mohor, which can be
|
found in the `doc' subdirectory. It is a memory mapped component,
|
found in the `doc' subdirectory. It is a memory mapped component,
|
which resides on the main OpenRISC Wishbone data bus.
|
which resides on the main OpenRISC Wishbone data bus.
|
|
|
Ethernet configuration is described in `section ethernet'. This
|
Ethernet configuration is described in `section ethernet'. This
|
section may appear multiple times, specifying multiple Ethernet
|
section may appear multiple times, specifying multiple Ethernet
|
interfaces. The following parameters may be specified.
|
interfaces. The following parameters may be specified.
|
|
|
`enabled = 0|1'
|
`enabled = 0|1'
|
If 1 (true, the default), this Ethernet MAC is enabled. If 0, it
|
If 1 (true, the default), this Ethernet MAC is enabled. If 0, it
|
is disabled.
|
is disabled.
|
|
|
`baseaddr = VALUE'
|
`baseaddr = VALUE'
|
Set the base address of the MAC's memory mapped registers to
|
Set the base address of the MAC's memory mapped registers to
|
VALUE. The default is 0, which is probably not a sensible value.
|
VALUE. The default is 0, which is probably not a sensible value.
|
|
|
The Ethernet MAC has a 7-bit address bus, with a total of 21
|
The Ethernet MAC has a 7-bit address bus, with a total of 21
|
32-bit registers. Addresses 0x54 through 0x7c are not used.
|
32-bit registers. Addresses 0x54 through 0x7c are not used.
|
|
|
Note: The Ethernet specification describes a Tx control
|
Note: The Ethernet specification describes a Tx control
|
register, `TXCTRL', at address 0x50. However this register
|
register, `TXCTRL', at address 0x50. However this register
|
is not implemented in the Or1ksim model.
|
is not implemented in the Or1ksim model.
|
|
|
`dma = VALUE'
|
`dma = VALUE'
|
VALUE specifies the DMA controller with which this Ethernet is
|
VALUE specifies the DMA controller with which this Ethernet is
|
associated. The default value is 0.
|
associated. The default value is 0.
|
|
|
Note: Support for external DMA is not provided in the current
|
Note: Support for external DMA is not provided in the current
|
implementation, and this value is ignored. In any case there
|
implementation, and this value is ignored. In any case there
|
is no equivalent field to which this can be matched in the
|
is no equivalent field to which this can be matched in the
|
current DMA component implementation (*note DMA
|
current DMA component implementation (*note DMA
|
Configuration: DMA Configuration.).
|
Configuration: DMA Configuration.).
|
|
|
`irq = VALUE'
|
`irq = VALUE'
|
Use VALUE as the IRQ number of this Ethernet MAC. Default value 0.
|
Use VALUE as the IRQ number of this Ethernet MAC. Default value 0.
|
|
|
`rtx_type = 0|1'
|
`rtx_type = 0|1'
|
If 1 (true) use a socket interface to the Ethernet (see parameter
|
If 1 (true) use a socket interface to the Ethernet (see parameter
|
`sockif' below). If 0 (the default), use a file interface,
|
`sockif' below). If 0 (the default), use a file interface,
|
reading and writing from and to the files specified in the
|
reading and writing from and to the files specified in the
|
`rxfile' and `txfile' parameters (see below).
|
`rxfile' and `txfile' parameters (see below).
|
|
|
Note: By default the socket interface is not provided in
|
Note: By default the socket interface is not provided in
|
Or1ksim. If it is required, this must be requested when
|
Or1ksim. If it is required, this must be requested when
|
configuring, by use of the `--enable-ethphy' option to
|
configuring, by use of the `--enable-ethphy' option to
|
`configure'.
|
`configure'.
|
|
|
configure --target=or32-uclinux --enable-ethphy ...
|
configure --target=or32-uclinux --enable-ethphy ...
|
|
|
`rx_channel = RXVALUE'
|
`rx_channel = RXVALUE'
|
`tx_channel = TXVALUE'
|
`tx_channel = TXVALUE'
|
RXVALUE specifies the DMA channel to use for receive and TXVALUE
|
RXVALUE specifies the DMA channel to use for receive and TXVALUE
|
the DMA channel to use for transmit. Both default to 0.
|
the DMA channel to use for transmit. Both default to 0.
|
|
|
Note: As noted above, support for external DMA is not
|
Note: As noted above, support for external DMA is not
|
provided in the current implementation, and so these values
|
provided in the current implementation, and so these values
|
are ignored.
|
are ignored.
|
|
|
`rxfile = "RXFILE"'
|
`rxfile = "RXFILE"'
|
`txfile = "TXFILE"'
|
`txfile = "TXFILE"'
|
When `rtx_type' is 0 (see above), RXFILE specifies the file to use
|
When `rtx_type' is 0 (see above), RXFILE specifies the file to use
|
as input and TXFILE specifies the fie to use as output.
|
as input and TXFILE specifies the fie to use as output.
|
|
|
The file contains a sequence of packets. Each packet consists of a
|
The file contains a sequence of packets. Each packet consists of a
|
packet length (32 bits), followed by that many bytes of data.
|
packet length (32 bits), followed by that many bytes of data.
|
Once the input file is empty, the Ethernet MAC behaves as though
|
Once the input file is empty, the Ethernet MAC behaves as though
|
there were no data on the Ethernet. The default values of these
|
there were no data on the Ethernet. The default values of these
|
parameters are `"eth_rx"' and `"eth_tx"' respectively.
|
parameters are `"eth_rx"' and `"eth_tx"' respectively.
|
|
|
The input file must exist and be readable. The output file must be
|
The input file must exist and be readable. The output file must be
|
writable and will be created if necessary. If either of these
|
writable and will be created if necessary. If either of these
|
conditions is not met, a warning will be given.
|
conditions is not met, a warning will be given.
|
|
|
`sockif = "SERVICE"'
|
`sockif = "SERVICE"'
|
When `rtx_type' is 1 (see above), SERVICE specifies the service to
|
When `rtx_type' is 1 (see above), SERVICE specifies the service to
|
use for communication. This may be TCP/IP or UDP/IP. The default
|
use for communication. This may be TCP/IP or UDP/IP. The default
|
value of this parameter is `"or1ksim_eth"'.
|
value of this parameter is `"or1ksim_eth"'.
|
|
|
`vapi_id = VALUE'
|
`vapi_id = VALUE'
|
VALUE specifies the value of the Verification API (VAPI) base
|
VALUE specifies the value of the Verification API (VAPI) base
|
address to be used with the Ethernet PHY. *Note Verification API:
|
address to be used with the Ethernet PHY. *Note Verification API:
|
Verification API, for more details, which details the use of the
|
Verification API, for more details, which details the use of the
|
VAPI with the DMA controller.
|
VAPI with the DMA controller.
|
|
|
`phy_addr = VALUE'
|
`phy_addr = VALUE'
|
VALUE specifies address for emulated ethernet PHY. Defaults to 0
|
VALUE specifies address for emulated ethernet PHY. Defaults to 0
|
otherwise.
|
otherwise.
|
|
|
|
|
|
|
File: or1ksim.info, Node: GPIO Configuration, Next: Display Interface Configuration, Prev: Ethernet Configuration, Up: Peripheral Configuration
|
File: or1ksim.info, Node: GPIO Configuration, Next: Display Interface Configuration, Prev: Ethernet Configuration, Up: Peripheral Configuration
|
|
|
3.4.5 GPIO Configuration
|
3.4.5 GPIO Configuration
|
------------------------
|
------------------------
|
|
|
The GPIO used in Or1ksim is the component implemented at OpenCores, and
|
The GPIO used in Or1ksim is the component implemented at OpenCores, and
|
found in the top level SVN directory, `gpio'. It is described in the
|
found in the top level SVN directory, `gpio'. It is described in the
|
document `GPIO IP Core Specification' by Damjan Lampret and Goran
|
document `GPIO IP Core Specification' by Damjan Lampret and Goran
|
Djakovic, which can be found in the `doc' subdirectory. It is a memory
|
Djakovic, which can be found in the `doc' subdirectory. It is a memory
|
mapped component, which resides on the main OpenRISC Wishbone data bus.
|
mapped component, which resides on the main OpenRISC Wishbone data bus.
|
|
|
GPIO configuration is described in `section gpio'. This section may
|
GPIO configuration is described in `section gpio'. This section may
|
appear multiple times, specifying multiple GPIO devices. The following
|
appear multiple times, specifying multiple GPIO devices. The following
|
parameters may be specified.
|
parameters may be specified.
|
|
|
`enabled = 0|1'
|
`enabled = 0|1'
|
If 1 (true, the default), this GPIO is enabled. If 0, it is
|
If 1 (true, the default), this GPIO is enabled. If 0, it is
|
disabled.
|
disabled.
|
|
|
`baseaddr = VALUE'
|
`baseaddr = VALUE'
|
Set the base address of the GPIO's memory mapped registers to
|
Set the base address of the GPIO's memory mapped registers to
|
VALUE. The default is 0, which is probably not a sensible value.
|
VALUE. The default is 0, which is probably not a sensible value.
|
|
|
The GPIO has a 6 bit address bus, with a total of 10 32-bit
|
The GPIO has a 6 bit address bus, with a total of 10 32-bit
|
registers, although the number of bits that are actively used
|
registers, although the number of bits that are actively used
|
varies. Addresses 0x28 through 0x3c are not used.
|
varies. Addresses 0x28 through 0x3c are not used.
|
|
|
`irq = VALUE'
|
`irq = VALUE'
|
Use VALUE as the IRQ number of this GPIO. Default value 0.
|
Use VALUE as the IRQ number of this GPIO. Default value 0.
|
|
|
`vapi_id = VALUE'
|
`vapi_id = VALUE'
|
VALUE specifies the value of the Verification API (VAPI) base
|
VALUE specifies the value of the Verification API (VAPI) base
|
address to be used with the GPIO. *Note Verification API:
|
address to be used with the GPIO. *Note Verification API:
|
Verification API, for more details, which details the use of the
|
Verification API, for more details, which details the use of the
|
VAPI with the GPIO controller. For backwards compatibility, the
|
VAPI with the GPIO controller. For backwards compatibility, the
|
alternative name `base_vapi_id' is supported for this parameter,
|
alternative name `base_vapi_id' is supported for this parameter,
|
but deprecated.
|
but deprecated.
|
|
|
|
|
|
|
File: or1ksim.info, Node: Display Interface Configuration, Next: Frame Buffer Configuration, Prev: GPIO Configuration, Up: Peripheral Configuration
|
File: or1ksim.info, Node: Display Interface Configuration, Next: Frame Buffer Configuration, Prev: GPIO Configuration, Up: Peripheral Configuration
|
|
|
3.4.6 Display Interface Configuration
|
3.4.6 Display Interface Configuration
|
-------------------------------------
|
-------------------------------------
|
|
|
Or1ksim models a VGA interface to an external monitor. The VGA
|
Or1ksim models a VGA interface to an external monitor. The VGA
|
controller used in Or1ksim is the component implemented at OpenCores,
|
controller used in Or1ksim is the component implemented at OpenCores,
|
and found in the top level SVN directory, `vga_lcd', with no support
|
and found in the top level SVN directory, `vga_lcd', with no support
|
for the optional hardware cursors. It is described in the document
|
for the optional hardware cursors. It is described in the document
|
`VGA/LCD Core v2.0 Specifications' by Richard Herveille, which can be
|
`VGA/LCD Core v2.0 Specifications' by Richard Herveille, which can be
|
found in the `doc' subdirectory. It is a memory mapped component,
|
found in the `doc' subdirectory. It is a memory mapped component,
|
which resides on the main OpenRISC Wishbone data bus.
|
which resides on the main OpenRISC Wishbone data bus.
|
|
|
The current implementation provides only functionality to dump the
|
The current implementation provides only functionality to dump the
|
screen to a file at intervals.
|
screen to a file at intervals.
|
|
|
VGA controller configuration is described in `section vga'. This
|
VGA controller configuration is described in `section vga'. This
|
section may appear multiple times, specifying multiple VGA controllers.
|
section may appear multiple times, specifying multiple VGA controllers.
|
The following parameters may be specified.
|
The following parameters may be specified.
|
|
|
`enabled = 0|1'
|
`enabled = 0|1'
|
If 1 (true, the default), this VGA is enabled. If 0, it is
|
If 1 (true, the default), this VGA is enabled. If 0, it is
|
disabled.
|
disabled.
|
|
|
`baseaddr = VALUE'
|
`baseaddr = VALUE'
|
Set the base address of the VGA controller's memory mapped
|
Set the base address of the VGA controller's memory mapped
|
registers to VALUE. The default is 0, which is probably not a
|
registers to VALUE. The default is 0, which is probably not a
|
sensible value.
|
sensible value.
|
|
|
The VGA controller has a 12-bit address bus, with 7 32-bit
|
The VGA controller has a 12-bit address bus, with 7 32-bit
|
registers, at addresses 0x000 through 0x018, and two color lookup
|
registers, at addresses 0x000 through 0x018, and two color lookup
|
tables at addresses 0x800 through 0xfff. The hardware cursor
|
tables at addresses 0x800 through 0xfff. The hardware cursor
|
registers are not implemented, so addresses 0x01c through 0x7fc
|
registers are not implemented, so addresses 0x01c through 0x7fc
|
are not used.
|
are not used.
|
|
|
`irq = VALUE'
|
`irq = VALUE'
|
Use VALUE as the IRQ number of this VGA controller. Default value
|
Use VALUE as the IRQ number of this VGA controller. Default value
|
0.
|
0.
|
|
|
`refresh_rate = VALUE'
|
`refresh_rate = VALUE'
|
VALUE specifies number of cycles between screen dumps. Default
|
VALUE specifies number of cycles between screen dumps. Default
|
value is derived from the simulation clock cycle time (*note
|
value is derived from the simulation clock cycle time (*note
|
Simulator Behavior: Simulator Behavior.), to correspond to dumping
|
Simulator Behavior: Simulator Behavior.), to correspond to dumping
|
50 times per simulated second.
|
50 times per simulated second.
|
|
|
`txfile = "FILE"'
|
`txfile = "FILE"'
|
FILE specifies the base of the filename for screen dumps.
|
FILE specifies the base of the filename for screen dumps.
|
Successive screen dumps will be in BMP format, in files with the
|
Successive screen dumps will be in BMP format, in files with the
|
name `FILENNNN.bmp', where NNNN is a sequential count of the
|
name `FILENNNN.bmp', where NNNN is a sequential count of the
|
screen dumps starting at zero. The default value is `"vga_out"'.
|
screen dumps starting at zero. The default value is `"vga_out"'.
|
For backwards compatibility, the alternative name `filename' is
|
For backwards compatibility, the alternative name `filename' is
|
supported for this parameter, but deprecated.
|
supported for this parameter, but deprecated.
|
|
|
|
|
|
|
File: or1ksim.info, Node: Frame Buffer Configuration, Next: Keyboard Configuration, Prev: Display Interface Configuration, Up: Peripheral Configuration
|
File: or1ksim.info, Node: Frame Buffer Configuration, Next: Keyboard Configuration, Prev: Display Interface Configuration, Up: Peripheral Configuration
|
|
|
3.4.7 Frame Buffer Configuration
|
3.4.7 Frame Buffer Configuration
|
--------------------------------
|
--------------------------------
|
|
|
Caution: The frame buffer is only partially implemented. Its
|
Caution: The frame buffer is only partially implemented. Its
|
configuration fields are described here, but the component should
|
configuration fields are described here, but the component should
|
not be used at this time. Like the VGA controller, it is designed
|
not be used at this time. Like the VGA controller, it is designed
|
to make screen dumps to file.
|
to make screen dumps to file.
|
|
|
Frame buffer configuration is described in `section fb'. This section
|
Frame buffer configuration is described in `section fb'. This section
|
may appear multiple times, specifying multiple frame buffers. The
|
may appear multiple times, specifying multiple frame buffers. The
|
following parameters may be specified.
|
following parameters may be specified.
|
|
|
`enabled = 0|1'
|
`enabled = 0|1'
|
If 1 (true, the default), this frame buffer is enabled. If 0, it
|
If 1 (true, the default), this frame buffer is enabled. If 0, it
|
is disabled.
|
is disabled.
|
|
|
`baseaddr = VALUE'
|
`baseaddr = VALUE'
|
Set the base address of the frame buffer's memory mapped registers
|
Set the base address of the frame buffer's memory mapped registers
|
to VALUE. The default is 0, which is probably not a sensible
|
to VALUE. The default is 0, which is probably not a sensible
|
value.
|
value.
|
|
|
The frame buffer has an 121-bit address bus, with 4 32-bit
|
The frame buffer has an 121-bit address bus, with 4 32-bit
|
registers, at addresses 0x000 through 0x00c, and a PAL lookup
|
registers, at addresses 0x000 through 0x00c, and a PAL lookup
|
table at addresses 0x400 through 0x4ff. Addresses 0x010 through
|
table at addresses 0x400 through 0x4ff. Addresses 0x010 through
|
0x3fc and addresses 0x500 through 0x7ff are not used.
|
0x3fc and addresses 0x500 through 0x7ff are not used.
|
|
|
`refresh_rate = VALUE'
|
`refresh_rate = VALUE'
|
VALUE specifies number of cycles between screen dumps. Default
|
VALUE specifies number of cycles between screen dumps. Default
|
value is derived from the simulation clock cycle time (*note
|
value is derived from the simulation clock cycle time (*note
|
Simulator Behavior: Simulator Behavior.), to correspond to dumping
|
Simulator Behavior: Simulator Behavior.), to correspond to dumping
|
50 times per simulated second.
|
50 times per simulated second.
|
|
|
`txfile = "FILE"'
|
`txfile = "FILE"'
|
FILE specifies the base of the filename for screen dumps.
|
FILE specifies the base of the filename for screen dumps.
|
Successive screen dumps will be in BMP format, in files with the
|
Successive screen dumps will be in BMP format, in files with the
|
name `FILENNNN.bmp', where NNNN is a sequential count of the
|
name `FILENNNN.bmp', where NNNN is a sequential count of the
|
screen dumps starting at zero. The default value is `"fb_out"'.
|
screen dumps starting at zero. The default value is `"fb_out"'.
|
For backwards compatibility, the alternative name `filename' is
|
For backwards compatibility, the alternative name `filename' is
|
supported for this parameter, but deprecated.
|
supported for this parameter, but deprecated.
|
|
|
|
|
|
|
File: or1ksim.info, Node: Keyboard Configuration, Next: Disc Interface Configuration, Prev: Frame Buffer Configuration, Up: Peripheral Configuration
|
File: or1ksim.info, Node: Keyboard Configuration, Next: Disc Interface Configuration, Prev: Frame Buffer Configuration, Up: Peripheral Configuration
|
|
|
3.4.8 Keyboard Configuration (PS2)
|
3.4.8 Keyboard Configuration (PS2)
|
----------------------------------
|
----------------------------------
|
|
|
The PS2 interface provided by Or1ksim is not documented. It may be
|
The PS2 interface provided by Or1ksim is not documented. It may be
|
based on the PS2 project at OpenCores, and found in the top level SVN
|
based on the PS2 project at OpenCores, and found in the top level SVN
|
directory, `ps2'. However this project lacks any documentation beyond
|
directory, `ps2'. However this project lacks any documentation beyond
|
its project webpage. Since most PS2 interfaces follow the Intel i8042
|
its project webpage. Since most PS2 interfaces follow the Intel i8042
|
standard, this is presumably what is expected with this device.
|
standard, this is presumably what is expected with this device.
|
|
|
The implementation only provides for keyboard support, which is
|
The implementation only provides for keyboard support, which is
|
modelled as a file of keystrokes. There is no mouse support.
|
modelled as a file of keystrokes. There is no mouse support.
|
|
|
Caution: A standard i8042 device has two registers at addresses
|
Caution: A standard i8042 device has two registers at addresses
|
0x60 (command) and 0x64 (status). Inspection of the code,
|
0x60 (command) and 0x64 (status). Inspection of the code,
|
suggests that the Or1ksim component places these registers at
|
suggests that the Or1ksim component places these registers at
|
addresses 0x00 and 0x04.
|
addresses 0x00 and 0x04.
|
|
|
The port of Linux for the OpenRISC 1000, which runs on Or1ksim
|
The port of Linux for the OpenRISC 1000, which runs on Or1ksim
|
implements the i8042 device driver, anticipating these registers
|
implements the i8042 device driver, anticipating these registers
|
reside at their conventional address. It seems unlikel that this
|
reside at their conventional address. It seems unlikel that this
|
code will work.
|
code will work.
|
|
|
This component should be used with caution.
|
This component should be used with caution.
|
|
|
Keyboard configuration is described in `section kbd'. This section may
|
Keyboard configuration is described in `section kbd'. This section may
|
appear multiple times, specifying multiple keyboard interfaces. The
|
appear multiple times, specifying multiple keyboard interfaces. The
|
following parameters may be specified.
|
following parameters may be specified.
|
|
|
`enabled = 0|1'
|
`enabled = 0|1'
|
If 1 (true, the default), this keyboard is enabled. If 0, it is
|
If 1 (true, the default), this keyboard is enabled. If 0, it is
|
disabled.
|
disabled.
|
|
|
`baseaddr = VALUE'
|
`baseaddr = VALUE'
|
Set the base address of the keyboard's memory mapped registers to
|
Set the base address of the keyboard's memory mapped registers to
|
VALUE. The default is 0, which is probably not a sensible value.
|
VALUE. The default is 0, which is probably not a sensible value.
|
|
|
The keyboard PS/2 interface has an 3-bit address bus, with 2 8-bit
|
The keyboard PS/2 interface has an 3-bit address bus, with 2 8-bit
|
registers, at addresses 0x000 and 0x004.
|
registers, at addresses 0x000 and 0x004.
|
|
|
Caution: As noted above, a standard Intel 8042 interface
|
Caution: As noted above, a standard Intel 8042 interface
|
would expect to find these registers at locations 0x60 and
|
would expect to find these registers at locations 0x60 and
|
0x64, thus requiring at least a 7-bit bus.
|
0x64, thus requiring at least a 7-bit bus.
|
|
|
`irq = VALUE'
|
`irq = VALUE'
|
Use VALUE as the IRQ number of this Keyboard interface. Default
|
Use VALUE as the IRQ number of this Keyboard interface. Default
|
value 0.
|
value 0.
|
|
|
`rxfile = "FILE"'
|
`rxfile = "FILE"'
|
`file' specifies a file containing raw key stroke data, which
|
`file' specifies a file containing raw key stroke data, which
|
models the input from a physical keyboard. The default value is
|
models the input from a physical keyboard. The default value is
|
`"kbd_in"'.
|
`"kbd_in"'.
|
|
|
|
|
|
|
File: or1ksim.info, Node: Disc Interface Configuration, Next: Generic Peripheral Configuration, Prev: Keyboard Configuration, Up: Peripheral Configuration
|
File: or1ksim.info, Node: Disc Interface Configuration, Next: Generic Peripheral Configuration, Prev: Keyboard Configuration, Up: Peripheral Configuration
|
|
|
3.4.9 Disc Interface Configuration
|
3.4.9 Disc Interface Configuration
|
----------------------------------
|
----------------------------------
|
|
|
The ATA/ATAPI disc controller used in Or1ksim is the OCIDEC (OpenCores
|
The ATA/ATAPI disc controller used in Or1ksim is the OCIDEC (OpenCores
|
IDE Controller) component implemented at OpenCores, and found in the
|
IDE Controller) component implemented at OpenCores, and found in the
|
top level SVN directory, `ata'. It is described in the document
|
top level SVN directory, `ata'. It is described in the document
|
`ATA/ATAPI-5 Core Specification' by Richard Herveille, which can be
|
`ATA/ATAPI-5 Core Specification' by Richard Herveille, which can be
|
found in the `doc' subdirectory. It is a memory mapped component,
|
found in the `doc' subdirectory. It is a memory mapped component,
|
which resides on the main OpenRISC Wishbone data bus.
|
which resides on the main OpenRISC Wishbone data bus.
|
|
|
Warning: In the current release of Or1ksim, parsing of the ATA
|
Warning: In the current release of Or1ksim, parsing of the ATA
|
section is broken. Users should not configure the disc interface
|
section is broken. Users should not configure the disc interface
|
in this release.
|
in this release.
|
|
|
ATA/ATAPI configuration is described in `section ata'. This section
|
ATA/ATAPI configuration is described in `section ata'. This section
|
may appear multiple times, specifying multiple disc controllers. The
|
may appear multiple times, specifying multiple disc controllers. The
|
following parameters may be specified.
|
following parameters may be specified.
|
|
|
`enabled = 0|1'
|
`enabled = 0|1'
|
If 1 (true, the default), this ATA/ATAPI interface is enabled. If
|
If 1 (true, the default), this ATA/ATAPI interface is enabled. If
|
0, it is disabled.
|
0, it is disabled.
|
|
|
`baseaddr = VALUE'
|
`baseaddr = VALUE'
|
Set the base address of the ATA/ATAPI interface's memory mapped
|
Set the base address of the ATA/ATAPI interface's memory mapped
|
registers to VALUE. The default is 0, which is probably not a
|
registers to VALUE. The default is 0, which is probably not a
|
sensible value.
|
sensible value.
|
|
|
The ATA/ATAPI PS/2 interface has an 5-bit address bus, with 8
|
The ATA/ATAPI PS/2 interface has an 5-bit address bus, with 8
|
32-bit registers. Depending on the version of the OCIDEC
|
32-bit registers. Depending on the version of the OCIDEC
|
ATA/ATAPI interface selected (see `dev_id' below), not all
|
ATA/ATAPI interface selected (see `dev_id' below), not all
|
registers will be available.
|
registers will be available.
|
|
|
`irq = VALUE'
|
`irq = VALUE'
|
Use VALUE as the IRQ number of this ATA/ATAPI interface. Default
|
Use VALUE as the IRQ number of this ATA/ATAPI interface. Default
|
value 0.
|
value 0.
|
|
|
`dev_id = 1|2|3'
|
`dev_id = 1|2|3'
|
This parameter specifies which version of the OCIDEC ATA/ATAPI
|
This parameter specifies which version of the OCIDEC ATA/ATAPI
|
interface to model. The default value is 1.
|
interface to model. The default value is 1.
|
|
|
Version 1 supports only the `CTRL', `STAT' and `PCTR' registers.
|
Version 1 supports only the `CTRL', `STAT' and `PCTR' registers.
|
Versions 2 & 3 add the `FCTR' registers, Version 3 adds the `DTR'
|
Versions 2 & 3 add the `FCTR' registers, Version 3 adds the `DTR'
|
registers and the `RXD'/`TXD' registers.
|
registers and the `RXD'/`TXD' registers.
|
|
|
`rev = VALUE'
|
`rev = VALUE'
|
Set the VALUE as the revision of the OCIDEC ATA/ATAPI interface.
|
Set the VALUE as the revision of the OCIDEC ATA/ATAPI interface.
|
The default value is 1. The default value is 0. Its value should
|
The default value is 1. The default value is 0. Its value should
|
be in the range 0-15. Larger values are truncated with a warning.
|
be in the range 0-15. Larger values are truncated with a warning.
|
This only affects the reset value of the `STAT' register, where it
|
This only affects the reset value of the `STAT' register, where it
|
forms bits 24-27.
|
forms bits 24-27.
|
|
|
`pio_mode0_t1 = VALUE'
|
`pio_mode0_t1 = VALUE'
|
`pio_mode0_t2 = VALUE'
|
`pio_mode0_t2 = VALUE'
|
`pio_mode0_t4 = VALUE'
|
`pio_mode0_t4 = VALUE'
|
`pio_mode0_teoc = VALUE'
|
`pio_mode0_teoc = VALUE'
|
These parameters specify the timings for use with Programmed
|
These parameters specify the timings for use with Programmed
|
Input/Output (PIO) transfers. They are specified as the number of
|
Input/Output (PIO) transfers. They are specified as the number of
|
clock cycles - 2, rounded up to the next highest integer, or zero
|
clock cycles - 2, rounded up to the next highest integer, or zero
|
if that would be negative. The values should not exceed 255. If
|
if that would be negative. The values should not exceed 255. If
|
they do, they will be ignored with a warning.
|
they do, they will be ignored with a warning.
|
|
|
See the ATA/ATAPI-5 specification for explanations of each of these
|
See the ATA/ATAPI-5 specification for explanations of each of these
|
timing parameters. The default values are:
|
timing parameters. The default values are:
|
|
|
pio_mode0_t1 = 6
|
pio_mode0_t1 = 6
|
pio_mode0_t2 = 28
|
pio_mode0_t2 = 28
|
pio_mode0_t4 = 2
|
pio_mode0_t4 = 2
|
pio_mode0_teoc = 23
|
pio_mode0_teoc = 23
|
|
|
`dma_mode0_tm = VALUE'
|
`dma_mode0_tm = VALUE'
|
`dma_mode0_td = VALUE'
|
`dma_mode0_td = VALUE'
|
`dma_mode0_teoc = VALUE'
|
`dma_mode0_teoc = VALUE'
|
These parameters specify the timings for use with DMA transfers.
|
These parameters specify the timings for use with DMA transfers.
|
They are specified as the number of clock cycles - 2, rounded up
|
They are specified as the number of clock cycles - 2, rounded up
|
to the next highest integer, or zero if that would be negative.
|
to the next highest integer, or zero if that would be negative.
|
The values should not exceed 255. If they do, they will be
|
The values should not exceed 255. If they do, they will be
|
ignored with a warning.
|
ignored with a warning.
|
|
|
See the ATA/ATAPI-5 specification for explanations of each of these
|
See the ATA/ATAPI-5 specification for explanations of each of these
|
timing parameters. The default values are:
|
timing parameters. The default values are:
|
|
|
dma_mode0_tm = 4
|
dma_mode0_tm = 4
|
dma_mode0_td = 21
|
dma_mode0_td = 21
|
dma_mode0_teoc = 21
|
dma_mode0_teoc = 21
|
|
|
|
|
3.4.9.1 ATA/ATAPI Device Configuration
|
3.4.9.1 ATA/ATAPI Device Configuration
|
......................................
|
......................................
|
|
|
Within the `section ata', each device is specified separately. The
|
Within the `section ata', each device is specified separately. The
|
device subsection is introduced by
|
device subsection is introduced by
|
|
|
device VALUE
|
device VALUE
|
|
|
VALUE is the device number, which should be 0 or 1. The subsection
|
VALUE is the device number, which should be 0 or 1. The subsection
|
ends with `enddevice'. Note that if the same device number is
|
ends with `enddevice'. Note that if the same device number is
|
specified more than once, the previous values will be overwritten.
|
specified more than once, the previous values will be overwritten.
|
Within the `device' subsection, the following parameters may appear:
|
Within the `device' subsection, the following parameters may appear:
|
|
|
`type = VALUE'
|
`type = VALUE'
|
VALUEspecifies the type of device: 0 (the default) for "not
|
VALUEspecifies the type of device: 0 (the default) for "not
|
connected", 1 for hard disk simulated in a file and 2 for local
|
connected", 1 for hard disk simulated in a file and 2 for local
|
system hard disk.
|
system hard disk.
|
|
|
`file = "FILENAME"'
|
`file = "FILENAME"'
|
`filename' specifies the file to be used for a simulated ATA
|
`filename' specifies the file to be used for a simulated ATA
|
device if the file type (see `type' above) is 1. Default value
|
device if the file type (see `type' above) is 1. Default value
|
`"ata_fileN"', where N is the device number.
|
`"ata_fileN"', where N is the device number.
|
|
|
`size = VALUE'
|
`size = VALUE'
|
VALUE specifies the size of a simulated ATA device if the file
|
VALUE specifies the size of a simulated ATA device if the file
|
type (see `type' above) is 1. The default value is zero.
|
type (see `type' above) is 1. The default value is zero.
|
|
|
`packet = 0|1'
|
`packet = 0|1'
|
If 1 (true), implement the PACKET command feature set. If 0 (the
|
If 1 (true), implement the PACKET command feature set. If 0 (the
|
default), do not implement the PACKET command feature set.
|
default), do not implement the PACKET command feature set.
|
|
|
`firmware = "STR"'
|
`firmware = "STR"'
|
Firmware to report in response to the "Identify Device" command.
|
Firmware to report in response to the "Identify Device" command.
|
Default `"02207031"'.
|
Default `"02207031"'.
|
|
|
`heads = VALUE'
|
`heads = VALUE'
|
Number of heads in the device. Default 7, use -1 to disable all
|
Number of heads in the device. Default 7, use -1 to disable all
|
heads.
|
heads.
|
|
|
`sectors = VALUE'
|
`sectors = VALUE'
|
Number of sectors per track in the device. Default 32.
|
Number of sectors per track in the device. Default 32.
|
|
|
`mwdma = 0|1|2|-1'
|
`mwdma = 0|1|2|-1'
|
Highest multi-word DMA mode supported. Default 2, use -1 to
|
Highest multi-word DMA mode supported. Default 2, use -1 to
|
disable.
|
disable.
|
|
|
`pio = 0|1|2|3|4'
|
`pio = 0|1|2|3|4'
|
Highest PIO mode supported. Default 4.
|
Highest PIO mode supported. Default 4.
|
|
|
|
|
|
|
File: or1ksim.info, Node: Generic Peripheral Configuration, Prev: Disc Interface Configuration, Up: Peripheral Configuration
|
File: or1ksim.info, Node: Generic Peripheral Configuration, Prev: Disc Interface Configuration, Up: Peripheral Configuration
|
|
|
3.4.10 Generic Peripheral Configuration
|
3.4.10 Generic Peripheral Configuration
|
---------------------------------------
|
---------------------------------------
|
|
|
When used as a library (*note Simulator Library: Simulator Library.),
|
When used as a library (*note Simulator Library: Simulator Library.),
|
Or1ksim makes provision for any additional peripheral to be implemented
|
Or1ksim makes provision for any additional peripheral to be implemented
|
externally. Any read or write access to this peripheral's memory map
|
externally. Any read or write access to this peripheral's memory map
|
generates "upcall"s to an external handler. This interface can support
|
generates "upcall"s to an external handler. This interface can support
|
either C or C++, and was particularly designed to facilitate support
|
either C or C++, and was particularly designed to facilitate support
|
for OSCI SystemC (see `http://www.systemc.org').
|
for OSCI SystemC (see `http://www.systemc.org').
|
|
|
Generic peripheral configuration is described in `section generic'.
|
Generic peripheral configuration is described in `section generic'.
|
This section may appear multiple times, specifying multiple external
|
This section may appear multiple times, specifying multiple external
|
peripherals. The following parameters may be specified.
|
peripherals. The following parameters may be specified.
|
|
|
`enabled = 0|1'
|
`enabled = 0|1'
|
If 1 (true, the default), this ATA/ATAPI interface is enabled. If
|
If 1 (true, the default), this ATA/ATAPI interface is enabled. If
|
0, it is disabled.
|
0, it is disabled.
|
|
|
`baseaddr = VALUE'
|
`baseaddr = VALUE'
|
Set the base address of the generic peripheral's memory mapped
|
Set the base address of the generic peripheral's memory mapped
|
registers to VALUE. The default is 0, which is probably not a
|
registers to VALUE. The default is 0, which is probably not a
|
sensible value.
|
sensible value.
|
|
|
The size of the memory mapped register space is controlled by the
|
The size of the memory mapped register space is controlled by the
|
`size' paramter, described below.
|
`size' paramter, described below.
|
|
|
`size = VALUE'
|
`size = VALUE'
|
Set the size of the generic peripheral's memory mapped register
|
Set the size of the generic peripheral's memory mapped register
|
space to VALUE bytes. Any read or write accesses to addresses with
|
space to VALUE bytes. Any read or write accesses to addresses with
|
offsets of 0 to VALUE-1 bytes from the base address specified in
|
offsets of 0 to VALUE-1 bytes from the base address specified in
|
parameter `baseaddr' (see above) will be directed to the external
|
parameter `baseaddr' (see above) will be directed to the external
|
interface.
|
interface.
|
|
|
VALUE will be rounded up the nearest power of 2. It's default
|
VALUE will be rounded up the nearest power of 2. It's default
|
value is zero. If VALUE is not an exact power of two, accesses to
|
value is zero. If VALUE is not an exact power of two, accesses to
|
address offsets of VALUE or above up to the next power of 2 will
|
address offsets of VALUE or above up to the next power of 2 will
|
generate a warning, and have no effect (reads will return zero).
|
generate a warning, and have no effect (reads will return zero).
|
|
|
`name = "STR"'
|
`name = "STR"'
|
This gives the peripheral the name `"STR"'. This is used to
|
This gives the peripheral the name `"STR"'. This is used to
|
identify the peripheral in error messages and warnings, and when
|
identify the peripheral in error messages and warnings, and when
|
reporting its status. The default value is
|
reporting its status. The default value is
|
`"anonymous external peripheral"'.
|
`"anonymous external peripheral"'.
|
|
|
`byte_enabled = 0|1'
|
`byte_enabled = 0|1'
|
`hw_enabled = 0|1'
|
`hw_enabled = 0|1'
|
`word_enabled = 0|1'
|
`word_enabled = 0|1'
|
If 1 (true, the default), these parameters respectively enable the
|
If 1 (true, the default), these parameters respectively enable the
|
device for byte wide, half-word wide and word wide accesses. If 0,
|
device for byte wide, half-word wide and word wide accesses. If 0,
|
accesses of that width will fail.
|
accesses of that width will fail.
|
|
|
|
|
|
|
File: or1ksim.info, Node: Interactive Command Line, Next: Verification API, Prev: Configuration, Up: Top
|
File: or1ksim.info, Node: Interactive Command Line, Next: Verification API, Prev: Configuration, Up: Top
|
|
|
4 Interactive Command Line
|
4 Interactive Command Line
|
**************************
|
**************************
|
|
|
If started with the `-f' flag, or if interrupted with `ctrl-C', Or1ksim
|
If started with the `-f' flag, or if interrupted with `ctrl-C', Or1ksim
|
provides the user with an interactive command line. The commands
|
provides the user with an interactive command line. The commands
|
available, which may not be abbreviated, are:
|
available, which may not be abbreviated, are:
|
|
|
`q'
|
`q'
|
Exit the simulator
|
Exit the simulator
|
|
|
`r'
|
`r'
|
Display all the General Purpose Registers (GPRs). Also shows the
|
Display all the General Purpose Registers (GPRs). Also shows the
|
just executed and next to be executed instructions symbolically
|
just executed and next to be executed instructions symbolically
|
and the state of the flag in the Supervision Register.
|
and the state of the flag in the Supervision Register.
|
|
|
`t'
|
`t'
|
Execute the next instruction and then display register/instruction
|
Execute the next instruction and then display register/instruction
|
information as with the `r' command (see above).
|
information as with the `r' command (see above).
|
|
|
`run NUM [ hush ]'
|
`run NUM [ hush ]'
|
Execute NUM instructions. The register/instruction information is
|
Execute NUM instructions. The register/instruction information is
|
displayed after each instruction, as with the `r' command (see
|
displayed after each instruction, as with the `r' command (see
|
above) _unless_ `hush' is specified.
|
above) _unless_ `hush' is specified.
|
|
|
`pr REG VALUE'
|
`pr REG VALUE'
|
Patch register REG with VALUE.
|
Patch register REG with VALUE.
|
|
|
`dm FROMADDR [ TOADDR ]'
|
`dm FROMADDR [ TOADDR ]'
|
Display memory bytes between FROMADDR and TOADDR. If TOADDR is
|
Display memory bytes between FROMADDR and TOADDR. If TOADDR is
|
not given, 64 bytes are displayed, starting at FROMADDR.
|
not given, 64 bytes are displayed, starting at FROMADDR.
|
|
|
Caution: The output from this command is broken (a bug).
|
Caution: The output from this command is broken (a bug).
|
Or1ksim attempts to print out 16 bytes per row. However,
|
Or1ksim attempts to print out 16 bytes per row. However,
|
instead of printing out the address at the start of each row,
|
instead of printing out the address at the start of each row,
|
it prints the address (of the first of the 16 bytes) before
|
it prints the address (of the first of the 16 bytes) before
|
_each_ byte.
|
_each_ byte.
|
|
|
`de FROMADDR [ TOADDR ]'
|
`de FROMADDR [ TOADDR ]'
|
Disassemble code between FROMADDR and TOADDR. If TOADDR is not
|
Disassemble code between FROMADDR and TOADDR. If TOADDR is not
|
given, 16 instructions are disassembled.
|
given, 16 instructions are disassembled.
|
|
|
The disassembly is entirely numerical, and gives no symbolic
|
The disassembly is entirely numerical, and gives no symbolic
|
information.
|
information.
|
|
|
`pm ADDR VALUE'
|
`pm ADDR VALUE'
|
Patch the 4 bytes in memory starting at ADDR with the 32-bit VALUE.
|
Patch the 4 bytes in memory starting at ADDR with the 32-bit VALUE.
|
|
|
`pc VALUE'
|
`pc VALUE'
|
Patch the program counter with VALUE.
|
Patch the program counter with VALUE.
|
|
|
`cm FROMADDR TOADDR SIZE'
|
`cm FROMADDR TOADDR SIZE'
|
Copy SIZE bytes in memory from FROMADDR to TOADDR.
|
Copy SIZE bytes in memory from FROMADDR to TOADDR.
|
|
|
`break ADDR'
|
`break ADDR'
|
Toggle the breakpoint set at ADDR.
|
Toggle the breakpoint set at ADDR.
|
|
|
`breaks'
|
`breaks'
|
List all set breakpoints
|
List all set breakpoints
|
|
|
`reset'
|
`reset'
|
Reset the simulator. Includes modeling a reset of the processor,
|
Reset the simulator. Includes modeling a reset of the processor,
|
so execution will restart from the reset vector location, 0x100.
|
so execution will restart from the reset vector location, 0x100.
|
|
|
`hist'
|
`hist'
|
If saving the execution history has been configured (*note
|
If saving the execution history has been configured (*note
|
Simulator Behavior: Simulator Behavior.), display the execution
|
Simulator Behavior: Simulator Behavior.), display the execution
|
history.
|
history.
|
|
|
`stall'
|
`stall'
|
Stall the processor, so that control is passed to the debug unit.
|
Stall the processor, so that control is passed to the debug unit.
|
When stalled, the processor can execute no instructions. This
|
When stalled, the processor can execute no instructions. This
|
command is useful when debugging the JTAG interface, used by
|
command is useful when debugging the JTAG interface, used by
|
debuggers such as GDB.
|
debuggers such as GDB.
|
|
|
`unstall'
|
`unstall'
|
Unstall the processor, so that normal execution can continue.
|
Unstall the processor, so that normal execution can continue.
|
This command is useful when debugging the JTAG interface, used by
|
This command is useful when debugging the JTAG interface, used by
|
debuggers such as GDB.
|
debuggers such as GDB.
|
|
|
`stats CATEGORY | clear'
|
`stats CATEGORY | clear'
|
Print the statistics for the given CATEGORY, if available, or
|
Print the statistics for the given CATEGORY, if available, or
|
clear if `clear' is specified. The categories are:
|
clear if `clear' is specified. The categories are:
|
|
|
1
|
1
|
Miscellaneous statistics: branch predictions (if branch
|
Miscellaneous statistics: branch predictions (if branch
|
predictions are enabled), branch target cache model (if
|
predictions are enabled), branch target cache model (if
|
enabled), cache (if enbaled), MMU (if enabled) and number of
|
enabled), cache (if enbaled), MMU (if enabled) and number of
|
addtional load & store cycles.
|
addtional load & store cycles.
|
|
|
*Note Configuring the OpenRisc Achitectural Components: Core
|
*Note Configuring the OpenRisc Achitectural Components: Core
|
OpenRISC Configuration, for details of how to enable these
|
OpenRISC Configuration, for details of how to enable these
|
various features.
|
various features.
|
|
|
2
|
2
|
Instruction usage statistics. Requires hazard analysis to be
|
Instruction usage statistics. Requires hazard analysis to be
|
enabled (*note CPU Configuration: CPU Configuration.).
|
enabled (*note CPU Configuration: CPU Configuration.).
|
|
|
3
|
3
|
Instruction dependency statistics. Requires hazard analysis
|
Instruction dependency statistics. Requires hazard analysis
|
to be enabled (*note CPU Configuration: CPU Configuration.).
|
to be enabled (*note CPU Configuration: CPU Configuration.).
|
|
|
4
|
4
|
Functional unit dependency statistics. Requires hazard
|
Functional unit dependency statistics. Requires hazard
|
analysis to be enabled (*note CPU Configuration: CPU
|
analysis to be enabled (*note CPU Configuration: CPU
|
Configuration.).
|
Configuration.).
|
|
|
5
|
5
|
Raw register usage over time. Requires hazard analysis to be
|
Raw register usage over time. Requires hazard analysis to be
|
enabled (*note CPU Configuration: CPU Configuration.).
|
enabled (*note CPU Configuration: CPU Configuration.).
|
|
|
6
|
6
|
Store buffer statistics. Requires the store buffer to be
|
Store buffer statistics. Requires the store buffer to be
|
enabled (*note CPU Configuration: CPU Configuration.).
|
enabled (*note CPU Configuration: CPU Configuration.).
|
|
|
|
|
`info'
|
`info'
|
Display detailed information about the simulator configuration.
|
Display detailed information about the simulator configuration.
|
This is quite a lengthy about, because all MMU TLB information is
|
This is quite a lengthy about, because all MMU TLB information is
|
displayed.
|
displayed.
|
|
|
`dv FROMADDR [ TOADDR ] [ MODULE ]'
|
`dv FROMADDR [ TOADDR ] [ MODULE ]'
|
Dump the area of memory between FROMADDR and TOADDR as Verilog
|
Dump the area of memory between FROMADDR and TOADDR as Verilog
|
code for a synchronous, 23-bit wide SRAM module, named MODULE. If
|
code for a synchronous, 23-bit wide SRAM module, named MODULE. If
|
TOADDR is not specified, then 64 bytes are dumped (as 16 32-bit
|
TOADDR is not specified, then 64 bytes are dumped (as 16 32-bit
|
words). If MODULE is not specified, `or1k_mem' is used.
|
words). If MODULE is not specified, `or1k_mem' is used.
|
|
|
To save to a file, use the redirection function (described after
|
To save to a file, use the redirection function (described after
|
this table, below).
|
this table, below).
|
|
|
`dh FROMADDR [ TOADDR ]'
|
`dh FROMADDR [ TOADDR ]'
|
Dump the area of memory between FROMADDR and TOADDR as 32-bit hex
|
Dump the area of memory between FROMADDR and TOADDR as 32-bit hex
|
numbers (no `0x', or `32'h' prefix). If TOADDR is not specified,
|
numbers (no `0x', or `32'h' prefix). If TOADDR is not specified,
|
then 64 bytes are dumped (as 16 32-bit words).
|
then 64 bytes are dumped (as 16 32-bit words).
|
|
|
To save to a file, use the redirection function (described after
|
To save to a file, use the redirection function (described after
|
this table, below).
|
this table, below).
|
|
|
`setdbch'
|
`setdbch'
|
Toggle debug channels on/off. *Note Standalone Simulator:
|
Toggle debug channels on/off. *Note Standalone Simulator:
|
Standalone Simulator, for a description of specifying debug
|
Standalone Simulator, for a description of specifying debug
|
channels on the command line.
|
channels on the command line.
|
|
|
`set SECTION PARAM = VALUE'
|
`set SECTION PARAM = VALUE'
|
Set the configuration parameter PARA in section SECTION to VALUE.
|
Set the configuration parameter PARA in section SECTION to VALUE.
|
*Note Configuration: Configuration, for details of configuration
|
*Note Configuration: Configuration, for details of configuration
|
parameters and their settings.
|
parameters and their settings.
|
|
|
`debug'
|
`debug'
|
Toggle the simulator debug mode. *Note Debug Interface
|
Toggle the simulator debug mode. *Note Debug Interface
|
Configuration: Debug Interface Configuration, for information on
|
Configuration: Debug Interface Configuration, for information on
|
this parameter.
|
this parameter.
|
|
|
Caution: This is effectively enabling or disabling the debug
|
Caution: This is effectively enabling or disabling the debug
|
unit. It does not effect the remote GDB debug interface.
|
unit. It does not effect the remote GDB debug interface.
|
However using the remote debug interface while the debug unit
|
However using the remote debug interface while the debug unit
|
is disabled will lead to undefined behavior and likely crash
|
is disabled will lead to undefined behavior and likely crash
|
Or1ksim
|
Or1ksim
|
|
|
`cuc'
|
`cuc'
|
Enter the the Custom Unit Compiler command prompt (*note CUC
|
Enter the the Custom Unit Compiler command prompt (*note CUC
|
Configuration: CUC Configuration.).
|
Configuration: CUC Configuration.).
|
|
|
Caution: The CUC must be properly configured, for this to
|
Caution: The CUC must be properly configured, for this to
|
succeed. In particular a timing file must be available and
|
succeed. In particular a timing file must be available and
|
readable. Otherwise Or1ksim will crash.
|
readable. Otherwise Or1ksim will crash.
|
|
|
`help'
|
`help'
|
Print out brief information about each command available.
|
Print out brief information about each command available.
|
|
|
`mprofile [-vh] [-m M] [-g N] [-f FILE] FROM TO'
|
`mprofile [-vh] [-m M] [-g N] [-f FILE] FROM TO'
|
Run the memory profiling utility. This follows the same usage as
|
Run the memory profiling utility. This follows the same usage as
|
the standalone command (*note Memory Profiling Utility: Memory
|
the standalone command (*note Memory Profiling Utility: Memory
|
Profiling Utility.).
|
Profiling Utility.).
|
|
|
`profile [-vhcq] [-g FILE]'
|
`profile [-vhcq] [-g FILE]'
|
Run the instruction profiling utility. This follows the same
|
Run the instruction profiling utility. This follows the same
|
usage as the standalone command (*note Profiling Utility:
|
usage as the standalone command (*note Profiling Utility:
|
Profiling Utility.).
|
Profiling Utility.).
|
|
|
|
|
For all commands, it is possible to redirect the output to a file, by
|
For all commands, it is possible to redirect the output to a file, by
|
using the redirection operator, `>'.
|
using the redirection operator, `>'.
|
|
|
COMMAND > FILENAME
|
COMMAND > FILENAME
|
|
|
This is particularly useful for commands dumping a large amount of
|
This is particularly useful for commands dumping a large amount of
|
output, such as `dv'.
|
output, such as `dv'.
|
|
|
Caution: Unfortunately there is a serious bug with the redirection
|
Caution: Unfortunately there is a serious bug with the redirection
|
operator. It does not return output to standard output after the
|
operator. It does not return output to standard output after the
|
command completes. Until this bug is fixed, file redirection
|
command completes. Until this bug is fixed, file redirection
|
should not be used.
|
should not be used.
|
|
|
|
|
File: or1ksim.info, Node: Verification API, Next: Code Internals, Prev: Interactive Command Line, Up: Top
|
File: or1ksim.info, Node: Verification API, Next: Code Internals, Prev: Interactive Command Line, Up: Top
|
|
|
5 Verification API (VAPI)
|
5 Verification API (VAPI)
|
*************************
|
*************************
|
|
|
The Verification API (VAPI) provides a TCP/IP interface to allow
|
The Verification API (VAPI) provides a TCP/IP interface to allow
|
components of the simulation to be controlled externally. The
|
components of the simulation to be controlled externally. The
|
interface is polled for new requests on each simulated clock cycle.
|
interface is polled for new requests on each simulated clock cycle.
|
Components within the simulator may send responses to such requests.
|
Components within the simulator may send responses to such requests.
|
|
|
The inteface is an asynchronous duplex protocol. On the request side
|
The inteface is an asynchronous duplex protocol. On the request side
|
it provides for simple commands, known as VAPI IDs (a 32 bit integer),
|
it provides for simple commands, known as VAPI IDs (a 32 bit integer),
|
with a single piece of data (also a 32 bit integer). On the send side,
|
with a single piece of data (also a 32 bit integer). On the send side,
|
it provides for sending a single VAPI ID and data. However there is no
|
it provides for sending a single VAPI ID and data. However there is no
|
explicit command-response structure. Some components just accept
|
explicit command-response structure. Some components just accept
|
requests (e.g. to set values), some just generate sends (to report
|
requests (e.g. to set values), some just generate sends (to report
|
values), and some do both.
|
values), and some do both.
|
|
|
Each component has a base ID (32 bit) and its commands will start from
|
Each component has a base ID (32 bit) and its commands will start from
|
that base ID. This provides a simple partitioning of the command space
|
that base ID. This provides a simple partitioning of the command space
|
amongst components. Request commands will be directed to the component
|
amongst components. Request commands will be directed to the component
|
with the closest base ID lower than the VAPI ID of the command.
|
with the closest base ID lower than the VAPI ID of the command.
|
|
|
Thus if there are two components with base IDs of 0x200 and 0x300, and
|
Thus if there are two components with base IDs of 0x200 and 0x300, and
|
a request with VAPI ID of 0x203 is received, it will be directed to the
|
a request with VAPI ID of 0x203 is received, it will be directed to the
|
first component as its command #3.
|
first component as its command #3.
|
|
|
The results of VAPI interactions are logged (by default in `vapi.log'
|
The results of VAPI interactions are logged (by default in `vapi.log'
|
unless an alternative is specified in `section vapi').
|
unless an alternative is specified in `section vapi').
|
|
|
Currently the following components support VAPI:
|
Currently the following components support VAPI:
|
|
|
Debug Unit
|
Debug Unit
|
Although the Debug Unit can specify a base VAPI ID, it is not used
|
Although the Debug Unit can specify a base VAPI ID, it is not used
|
to send commands or receive requests.
|
to send commands or receive requests.
|
|
|
Instead, if the base VAPI ID is set, all remote JTAG protocol
|
Instead, if the base VAPI ID is set, all remote JTAG protocol
|
exchanges are logged in the VAPI log file.
|
exchanges are logged in the VAPI log file.
|
|
|
UART
|
UART
|
If a base VAPI ID is specified, the UART sends details of any
|
If a base VAPI ID is specified, the UART sends details of any
|
chars or break characters sent, with dteails of the line control
|
chars or break characters sent, with dteails of the line control
|
register etc encoded in the data packet sent.
|
register etc encoded in the data packet sent.
|
|
|
This supports a single VAPI command request, but encodes a
|
This supports a single VAPI command request, but encodes a
|
sub-command in the top 8 bits of the associated data.
|
sub-command in the top 8 bits of the associated data.
|
|
|
`0x00'
|
`0x00'
|
This stuffs the least significant 8 bits of the data into the
|
This stuffs the least significant 8 bits of the data into the
|
serial register of the UART and the next 8 bits into the line
|
serial register of the UART and the next 8 bits into the line
|
control register, effectively providing control of the next
|
control register, effectively providing control of the next
|
character to be sent or received.
|
character to be sent or received.
|
|
|
`0x01'
|
`0x01'
|
The divisor latch bytes are set from the least significant 16
|
The divisor latch bytes are set from the least significant 16
|
bits of the data.
|
bits of the data.
|
|
|
`0x02'
|
`0x02'
|
The line control register is set from bits 15-8 of the data.
|
The line control register is set from bits 15-8 of the data.
|
|
|
`0x03'
|
`0x03'
|
The UART skew is set from the least significant 16 bits of
|
The UART skew is set from the least significant 16 bits of
|
the data
|
the data
|
|
|
`0x04'
|
`0x04'
|
If the 16th most significant bit of the data is 1, start
|
If the 16th most significant bit of the data is 1, start
|
sending breaks, otherwise stop sending breaks. The breaks
|
sending breaks, otherwise stop sending breaks. The breaks
|
are sent or cleared after the number of UART clock divider
|
are sent or cleared after the number of UART clock divider
|
ticks specified by the data (immediately if the data is zero).
|
ticks specified by the data (immediately if the data is zero).
|
|
|
|
|
DMA
|
DMA
|
Although the DMA unit supports a base VAPI ID in its configuration
|
Although the DMA unit supports a base VAPI ID in its configuration
|
(`section dma'), no VAPI data is sent, nor VAPI requests currently
|
(`section dma'), no VAPI data is sent, nor VAPI requests currently
|
implemented.
|
implemented.
|
|
|
Ethernet
|
Ethernet
|
The following requests are handled by the Ethernet. Specified
|
The following requests are handled by the Ethernet. Specified
|
symbolically, these are the increments from the base VAPI ID of the
|
symbolically, these are the increments from the base VAPI ID of the
|
Ethernet. At present no implementation is provided behind these
|
Ethernet. At present no implementation is provided behind these
|
VAPI requests.
|
VAPI requests.
|
|
|
`ETH_VAPI_DATA (0)'
|
`ETH_VAPI_DATA (0)'
|
|
|
`ETH_VAPI_CTRL (0)'
|
`ETH_VAPI_CTRL (0)'
|
|
|
GPIO
|
GPIO
|
If a base VAPI ID is specified, the GPIO sends out on its base
|
If a base VAPI ID is specified, the GPIO sends out on its base
|
VAPI ID (symbolically, GPIO_VAPI_DATA (0) offset from the base
|
VAPI ID (symbolically, GPIO_VAPI_DATA (0) offset from the base
|
VAPI ID) any changes in outputs.
|
VAPI ID) any changes in outputs.
|
|
|
The following requests are handled by the GPIO. Specified
|
The following requests are handled by the GPIO. Specified
|
symbolically, these are the increments from the VAPI base ID of the
|
symbolically, these are the increments from the VAPI base ID of the
|
GPIO.
|
GPIO.
|
|
|
`GPIO_VAPI_DATA (0)'
|
`GPIO_VAPI_DATA (0)'
|
Set the next input to the commands data field
|
Set the next input to the commands data field
|
|
|
`GPIO_VAPI_AUX (1)'
|
`GPIO_VAPI_AUX (1)'
|
Set the GPIO auxiliary inputs to the data field
|
Set the GPIO auxiliary inputs to the data field
|
|
|
`GPIO_VAPI_CLOCK (2)'
|
`GPIO_VAPI_CLOCK (2)'
|
Add an external GPIO clock trigger of period specified in the
|
Add an external GPIO clock trigger of period specified in the
|
data field.
|
data field.
|
|
|
`GPIO_VAPI_RGPIO_OE (3)'
|
`GPIO_VAPI_RGPIO_OE (3)'
|
Set the GPIO output enable to the data field
|
Set the GPIO output enable to the data field
|
|
|
`GPIO_VAPI_RGPIO_INTE (4)'
|
`GPIO_VAPI_RGPIO_INTE (4)'
|
Set the next interrupt to the data field
|
Set the next interrupt to the data field
|
|
|
`GPIO_VAPI_RGPIO_PTRIG (5)'
|
`GPIO_VAPI_RGPIO_PTRIG (5)'
|
Set the next trigger to the data field
|
Set the next trigger to the data field
|
|
|
`GPIO_VAPI_RGPIO_AUX (6)'
|
`GPIO_VAPI_RGPIO_AUX (6)'
|
Set the next auxiliary input to the data field
|
Set the next auxiliary input to the data field
|
|
|
`GPIO_VAPI_RGPIO_CTRL (7)'
|
`GPIO_VAPI_RGPIO_CTRL (7)'
|
Set th next control input to the data field
|
Set th next control input to the data field
|
|
|
|
|
|
|
|
|
File: or1ksim.info, Node: Code Internals, Next: GNU Free Documentation License, Prev: Verification API, Up: Top
|
File: or1ksim.info, Node: Code Internals, Next: GNU Free Documentation License, Prev: Verification API, Up: Top
|
|
|
6 A Guide to Or1ksim Internals
|
6 A Guide to Or1ksim Internals
|
******************************
|
******************************
|
|
|
These are notes to help those wanting to extend Or1ksim. This section
|
These are notes to help those wanting to extend Or1ksim. This section
|
assumes the use of a tag file, so file locations of entities'
|
assumes the use of a tag file, so file locations of entities'
|
definitions are not in general provided. For more on tags, see the
|
definitions are not in general provided. For more on tags, see the
|
Linux manual page for `etags'. A tag file can be created with:
|
Linux manual page for `etags'. A tag file can be created with:
|
|
|
make tags
|
make tags
|
|
|
* Menu:
|
* Menu:
|
|
|
* Coding Conventions::
|
* Coding Conventions::
|
* Global Data Structures::
|
* Global Data Structures::
|
* Concepts::
|
* Concepts::
|
* Internal Debugging::
|
* Internal Debugging::
|
* Regression Testing::
|
* Regression Testing::
|
|
|
|
|
File: or1ksim.info, Node: Coding Conventions, Next: Global Data Structures, Up: Code Internals
|
File: or1ksim.info, Node: Coding Conventions, Next: Global Data Structures, Up: Code Internals
|
|
|
6.1 Coding Conventions for Or1ksim
|
6.1 Coding Conventions for Or1ksim
|
==================================
|
==================================
|
|
|
This chapter provides some guidelines for coding, to facilitate
|
This chapter provides some guidelines for coding, to facilitate
|
extensions to Or1ksim
|
extensions to Or1ksim
|
|
|
_GNU Coding Standard_
|
_GNU Coding Standard_
|
Code should follow the GNU coding standard for C
|
Code should follow the GNU coding standard for C
|
(`http://www.gnu.org/prep/standards/'. If in doubt, put your code
|
(`http://www.gnu.org/prep/standards/'. If in doubt, put your code
|
through the `indent' program.
|
through the `indent' program.
|
|
|
_`#include' headers_
|
_`#include' headers_
|
All C source code files should include `config.h' before any other
|
All C source code files should include `config.h' before any other
|
file.
|
file.
|
|
|
This should be followed by inclusion of any system headers (but see
|
This should be followed by inclusion of any system headers (but see
|
the comments about portability and `port.h' below) and then by any
|
the comments about portability and `port.h' below) and then by any
|
Or1ksim package headers.
|
Or1ksim package headers.
|
|
|
If `port.h' is required, it should be the first package header to
|
If `port.h' is required, it should be the first package header to
|
be included after the system headers.
|
be included after the system headers.
|
|
|
All C source code and header files should directly include any
|
All C source code and header files should directly include any
|
system or package header they depend on, i.e. not rely on any
|
system or package header they depend on, i.e. not rely on any
|
other header having already included it. The two exceptions are
|
other header having already included it. The two exceptions are
|
|
|
1. All header files may assume that `config.h' has already been
|
1. All header files may assume that `config.h' has already been
|
included.
|
included.
|
|
|
2. System headers which impose portability problems should be
|
2. System headers which impose portability problems should be
|
included by using the package header `port.h', rather than
|
included by using the package header `port.h', rather than
|
the system headers themselves. This is the case for code
|
the system headers themselves. This is the case for code
|
requiring
|
requiring
|
|
|
* `strndup' (from `string.h')
|
* `strndup' (from `string.h')
|
|
|
* Integer types (`intN_t', `uintN_t') (from `inttypes.h').
|
* Integer types (`intN_t', `uintN_t') (from `inttypes.h').
|
|
|
* `isblank' (from `ctype.h')
|
* `isblank' (from `ctype.h')
|
|
|
|
|
|
|
_`#include' files once only_
|
_`#include' files once only_
|
All include files should be protected by `#ifndef' to ensure their
|
All include files should be protected by `#ifndef' to ensure their
|
definitions are only included once. For instance a header file
|
definitions are only included once. For instance a header file
|
`X-Y.H' should surround its contents with:
|
`X-Y.H' should surround its contents with:
|
|
|
#ifndef X_Y__H
|
#ifndef X_Y__H
|
#define X_Y__H
|
#define X_Y__H
|
|
|
|
|
|
|
#endif /* X_Y__H */
|
#endif /* X_Y__H */
|
|
|
_Avoid `typedef'_
|
_Avoid `typedef'_
|
The GNU coding style for C does not have a clear way to distinguish
|
The GNU coding style for C does not have a clear way to distinguish
|
between user type name and user variables. For this reason
|
between user type name and user variables. For this reason
|
`typedef' should be avoided except for the most ubiquitous user
|
`typedef' should be avoided except for the most ubiquitous user
|
defined types. This makes the code much easier to read.
|
defined types. This makes the code much easier to read.
|
|
|
There are some `typedef' declarations in the `argtable2' library
|
There are some `typedef' declarations in the `argtable2' library
|
and the ELF and COFF headers, because this code is taken from
|
and the ELF and COFF headers, because this code is taken from
|
other places.
|
other places.
|
|
|
Within Or1ksim legacy uses of `typedef' have largely been purged,
|
Within Or1ksim legacy uses of `typedef' have largely been purged,
|
except in the Custom Unit Compiler (*note Custom Unit Compiler
|
except in the Custom Unit Compiler (*note Custom Unit Compiler
|
(CUC) Configuration: CUC Configuration.).
|
(CUC) Configuration: CUC Configuration.).
|
|
|
The remaining uses of `typedef' occur in two places:
|
The remaining uses of `typedef' occur in two places:
|
|
|
* `port/port.h' defines types to replace those in header files
|
* `port/port.h' defines types to replace those in header files
|
that are not available (character functions, string
|
that are not available (character functions, string
|
duplication, integer types).
|
duplication, integer types).
|
|
|
`cpu/or1k/arch.h' defines types for the key Or1ksim entities:
|
`cpu/or1k/arch.h' defines types for the key Or1ksim entities:
|
addresses (`oraddr_t'), unsigned register values (`uorreg_t')
|
addresses (`oraddr_t'), unsigned register values (`uorreg_t')
|
and signed register (`orreg_t') values.
|
and signed register (`orreg_t') values.
|
|
|
|
|
Where new types are defined, they should appear in one of these two
|
Where new types are defined, they should appear in one of these two
|
files as appropriate. Or1ksim specific types appearing in
|
files as appropriate. Or1ksim specific types appearing in
|
`arch.h' should always have the suffix `_h'.
|
`arch.h' should always have the suffix `_h'.
|
|
|
_Don't begin names with underscore_
|
_Don't begin names with underscore_
|
Names beginning with `_' are intended to be part of the C
|
Names beginning with `_' are intended to be part of the C
|
infrastructure. They should not be used in the simulator code.
|
infrastructure. They should not be used in the simulator code.
|
|
|
_Keep Non-global top level entities static_
|
_Keep Non-global top level entities static_
|
All top level entities (functions, variables), which are not
|
All top level entities (functions, variables), which are not
|
explicitly part of a global interface should be declared static.
|
explicitly part of a global interface should be declared static.
|
This ensures that unwanted connections are not inadvertently built
|
This ensures that unwanted connections are not inadvertently built
|
across the program.
|
across the program.
|
|
|
_Use of `inline'_
|
_Use of `inline'_
|
Code should not be declared `inline'. Modern compilers can work
|
Code should not be declared `inline'. Modern compilers can work
|
out for themselves what is best in this respect.
|
out for themselves what is best in this respect.
|
|
|
_Initialization_
|
_Initialization_
|
All data structures should be explicitly initialized. In
|
All data structures should be explicitly initialized. In
|
particular code should not rely on static data structures being
|
particular code should not rely on static data structures being
|
initialized to zero.
|
initialized to zero.
|
|
|
The rationale is that in future static data structures may become
|
The rationale is that in future static data structures may become
|
dynamic. This has been a particular source of bugs in Or1ksim
|
dynamic. This has been a particular source of bugs in Or1ksim
|
historically.
|
historically.
|
|
|
A specific case is with new peripherals, which should always
|
A specific case is with new peripherals, which should always
|
include a `start' function to pre-initialize all configuration
|
include a `start' function to pre-initialize all configuration
|
parameters to sensible defaults
|
parameters to sensible defaults
|
|
|
_Configuration Validation_
|
_Configuration Validation_
|
All configuration values should be validated, preferably when
|
All configuration values should be validated, preferably when
|
encountered, if not when the `section' is closed, or otherwise at
|
encountered, if not when the `section' is closed, or otherwise at
|
run time when the parameter is first used.
|
run time when the parameter is first used.
|
|
|
|
|
|
|
File: or1ksim.info, Node: Global Data Structures, Next: Concepts, Prev: Coding Conventions, Up: Code Internals
|
File: or1ksim.info, Node: Global Data Structures, Next: Concepts, Prev: Coding Conventions, Up: Code Internals
|
|
|
6.2 Global Data Structures
|
6.2 Global Data Structures
|
==========================
|
==========================
|
|
|
`config'
|
`config'
|
The global variable `config' of type `struct config' holds the
|
The global variable `config' of type `struct config' holds the
|
configuration data for some of the Or1ksim components which are
|
configuration data for some of the Or1ksim components which are
|
always present. At present the components are:
|
always present. At present the components are:
|
|
|
* The simulator defined in `section sim' (*note Simulator
|
* The simulator defined in `section sim' (*note Simulator
|
Configuration: Simulator Configuration.).
|
Configuration: Simulator Configuration.).
|
|
|
* The Verification API (VAPI) defined in `section vapi' (*note
|
* The Verification API (VAPI) defined in `section vapi' (*note
|
Verification API (VAPI) Configuration: Verification API
|
Verification API (VAPI) Configuration: Verification API
|
Configuration.).
|
Configuration.).
|
|
|
* The Custom Unit Compiler (CUC), defined in `section cuc'
|
* The Custom Unit Compiler (CUC), defined in `section cuc'
|
(*note Custom Unit Compiler (CUC) Configuration: CUC
|
(*note Custom Unit Compiler (CUC) Configuration: CUC
|
Configuration.).
|
Configuration.).
|
|
|
* The CPU, defined in `section cpu' (*note CPU Configuration:
|
* The CPU, defined in `section cpu' (*note CPU Configuration:
|
CPU Configuration.).
|
CPU Configuration.).
|
|
|
* The data cache (but not the instruction cache), defined in
|
* The data cache (but not the instruction cache), defined in
|
`section dc' (*note Cache Configuration: Cache
|
`section dc' (*note Cache Configuration: Cache
|
Configuration.).
|
Configuration.).
|
|
|
* The power management unit, defined in `section pm' (*note
|
* The power management unit, defined in `section pm' (*note
|
Power Management Configuration: Power Management
|
Power Management Configuration: Power Management
|
Configuration.).
|
Configuration.).
|
|
|
* The programmable interrupt controller, defined in
|
* The programmable interrupt controller, defined in
|
`section pic' (*note Interrupt Configuration: Interrupt
|
`section pic' (*note Interrupt Configuration: Interrupt
|
Configuration.).
|
Configuration.).
|
|
|
* Branch prediciton, defined in `section bpb' (*note Branch
|
* Branch prediciton, defined in `section bpb' (*note Branch
|
Prediction Configuration: Branch Prediction Configuration.).
|
Prediction Configuration: Branch Prediction Configuration.).
|
|
|
* The debug unit, defined in `section debug' (*note Debug
|
* The debug unit, defined in `section debug' (*note Debug
|
Interface Configuration: Debug Interface Configuration.).
|
Interface Configuration: Debug Interface Configuration.).
|
|
|
|
|
This struct is made of a collection of structs, one for each
|
This struct is made of a collection of structs, one for each
|
component. For example the simulator configuration is held in
|
component. For example the simulator configuration is held in
|
`config.sim'.
|
`config.sim'.
|
|
|
`config'
|
`config'
|
This is a linked list of data structures holding configuration data
|
This is a linked list of data structures holding configuration data
|
for all sections which are not held in the main `config' data
|
for all sections which are not held in the main `config' data
|
structure. In general these are components (such as peripherals
|
structure. In general these are components (such as peripherals
|
and memory) which may occur multiple times. However it also
|
and memory) which may occur multiple times. However it also
|
handles some architectural components which may occur only once,
|
handles some architectural components which may occur only once,
|
such as the memory management units, the instruction cache, the
|
such as the memory management units, the instruction cache, the
|
interrupt controller and branch prediction.
|
interrupt controller and branch prediction.
|
|
|
`runtime'
|
`runtime'
|
The global variable `runtime' of type `struct runtime' holds all
|
The global variable `runtime' of type `struct runtime' holds all
|
the runtime information about the simulation. To access this
|
the runtime information about the simulation. To access this
|
variable, `sim-config.h' must be included.
|
variable, `sim-config.h' must be included.
|
|
|
This struct is itself made of 3 other structs, `cpu' (for CPU run
|
This struct is itself made of 3 other structs, `cpu' (for CPU run
|
time state), `vapi' (for Verification API state) and `cuc' (for
|
time state), `vapi' (for Verification API state) and `cuc' (for
|
Custom Unit Compiler state).
|
Custom Unit Compiler state).
|
|
|
|
|
|
|
File: or1ksim.info, Node: Concepts, Next: Internal Debugging, Prev: Global Data Structures, Up: Code Internals
|
File: or1ksim.info, Node: Concepts, Next: Internal Debugging, Prev: Global Data Structures, Up: Code Internals
|
|
|
6.3 Concepts
|
6.3 Concepts
|
============
|
============
|
|
|
_Output Redirection_
|
_Output Redirection_
|
The current output stream is held in `runtime.cpu.fout'. Output
|
The current output stream is held in `runtime.cpu.fout'. Output
|
should be explicitly written to this stream, or may use the
|
should be explicitly written to this stream, or may use the
|
`PRINTF' macro, which will write its arguments to this output
|
`PRINTF' macro, which will write its arguments to this output
|
stream.
|
stream.
|
|
|
_Reset Hooks_
|
_Reset Hooks_
|
Any peripheral may register a routine to be called when the the
|
Any peripheral may register a routine to be called when the the
|
processor is reset by calling `reg_sim_reset', providing a
|
processor is reset by calling `reg_sim_reset', providing a
|
function and pointer to a data structure as arguments. On reset
|
function and pointer to a data structure as arguments. On reset
|
that function will be called with the data stucture pointer as
|
that function will be called with the data stucture pointer as
|
argument.
|
argument.
|
|
|
|
|
|
|
File: or1ksim.info, Node: Internal Debugging, Next: Regression Testing, Prev: Concepts, Up: Code Internals
|
File: or1ksim.info, Node: Internal Debugging, Next: Regression Testing, Prev: Concepts, Up: Code Internals
|
|
|
6.4 Internal Debugging
|
6.4 Internal Debugging
|
======================
|
======================
|
|
|
The function `debug' is like `printf', but with an extra first
|
The function `debug' is like `printf', but with an extra first
|
argument, which is the debug level. If the debug level specified in
|
argument, which is the debug level. If the debug level specified in
|
the simulator configuration (*note Simulator Behavior: Simulator
|
the simulator configuration (*note Simulator Behavior: Simulator
|
Behavior.) is greater than or equal to this value, the remaining
|
Behavior.) is greater than or equal to this value, the remaining
|
arguments are printed to the current output stream (*note Output
|
arguments are printed to the current output stream (*note Output
|
Redirection: Output Redirection.).
|
Redirection: Output Redirection.).
|
|
|
|
|
File: or1ksim.info, Node: Regression Testing, Prev: Internal Debugging, Up: Code Internals
|
File: or1ksim.info, Node: Regression Testing, Prev: Internal Debugging, Up: Code Internals
|
|
|
6.5 Regression Testing
|
6.5 Regression Testing
|
======================
|
======================
|
|
|
Or1ksim now includes a regression test suite for both standalone and
|
Or1ksim now includes a regression test suite for both standalone and
|
library usage as described earlier (*note Building and Installing:
|
library usage as described earlier (*note Building and Installing:
|
Build and Install.). Running the tests requires that the OpenRISC
|
Build and Install.). Running the tests requires that the OpenRISC
|
toolchain and DejaGNU are both installed.
|
toolchain and DejaGNU are both installed.
|
|
|
Tests are written using `expect', a derivative of TCL. Documentation
|
Tests are written using `expect', a derivative of TCL. Documentation
|
of DejaGnu, `expect' and TCL are freely available on the Web. The
|
of DejaGnu, `expect' and TCL are freely available on the Web. The
|
Embecosm Application Note 8, `Howto: Using DejaGnu for Testing: A
|
Embecosm Application Note 8, `Howto: Using DejaGnu for Testing: A
|
Simple Introduction' (`http://www.embecosm.com/download/ean8.html')
|
Simple Introduction' (`http://www.embecosm.com/download/ean8.html')
|
provides a concise introduction.
|
provides a concise introduction.
|
|
|
All test code is found in the `testsuite' directory. The key files and
|
All test code is found in the `testsuite' directory. The key files and
|
directories used are as follows.
|
directories used are as follows.
|
|
|
`global-conf.exp'
|
`global-conf.exp'
|
This is the global DejaGNU configuration file used to set up
|
This is the global DejaGNU configuration file used to set up
|
parameters common to all tests. If the user has the environment
|
parameters common to all tests. If the user has the environment
|
varialbe `DEJAGNU' defined, it will be used instead, but this is
|
varialbe `DEJAGNU' defined, it will be used instead, but this is
|
not recommended.
|
not recommended.
|
|
|
`Makefile.am'
|
`Makefile.am'
|
This is the top level `automake' file for the testsuite. The only
|
This is the top level `automake' file for the testsuite. The only
|
changes likely to be needed here is additional local cleanup of
|
changes likely to be needed here is additional local cleanup of
|
files created by new tests.
|
files created by new tests.
|
|
|
`README'
|
`README'
|
This contains details of all the tests
|
This contains details of all the tests
|
|
|
`config'
|
`config'
|
This contains DejaGnu board configurations. Since the tests are
|
This contains DejaGnu board configurations. Since the tests are
|
generally run on a Unix host, this should just contain `Unix.exp'.
|
generally run on a Unix host, this should just contain `Unix.exp'.
|
|
|
`lib'
|
`lib'
|
This contains DejaGnu tool specific configurations. "Tool" has a
|
This contains DejaGnu tool specific configurations. "Tool" has a
|
specific meaning in DejaGNU, referring just to a grouping of
|
specific meaning in DejaGNU, referring just to a grouping of
|
tests. In this case there are two such "tools", "or1ksim" and
|
tests. In this case there are two such "tools", "or1ksim" and
|
"libsim" for tests of the standalone tool and tests of the library.
|
"libsim" for tests of the standalone tool and tests of the library.
|
|
|
Corresponding to this, there are two tool specific configuration
|
Corresponding to this, there are two tool specific configuration
|
files, `or1ksim.exp' and `libsim.exp'. These contain `expect'/TCL
|
files, `or1ksim.exp' and `libsim.exp'. These contain `expect'/TCL
|
procedures for common use among the tests.
|
procedures for common use among the tests.
|
|
|
`libsim.tests'
|
`libsim.tests'
|
`or1ksim.tests'
|
`or1ksim.tests'
|
These are the directories of tests of the Or1ksim library. They
|
These are the directories of tests of the Or1ksim library. They
|
also include Or1ksim configuration files and each has a
|
also include Or1ksim configuration files and each has a
|
`Makefile.am' file. `Makefile.am' should be updated whenever
|
`Makefile.am' file. `Makefile.am' should be updated whenever
|
files are added to this directory, to ensure they are included in
|
files are added to this directory, to ensure they are included in
|
the distribution.
|
the distribution.
|
|
|
`test-code'
|
`test-code'
|
These are all the test programs to be compiled on the host (each
|
These are all the test programs to be compiled on the host (each
|
in its own directory). In general these are programs to support
|
in its own directory). In general these are programs to support
|
testing of the library, and build various programs linking in the
|
testing of the library, and build various programs linking in the
|
library.
|
library.
|
|
|
`test-code'
|
`test-code'
|
These are all the test programs to be compiled with the OpenRISC
|
These are all the test programs to be compiled with the OpenRISC
|
tool chain to run with either standalone Or1ksim or the library.
|
tool chain to run with either standalone Or1ksim or the library.
|
This directory includes its own `configure.ac', since it must set
|
This directory includes its own `configure.ac', since it must set
|
up a separate tool chain based on the target, not the host.
|
up a separate tool chain based on the target, not the host.
|
|
|
|
|
To add a new test needs the following steps.
|
To add a new test needs the following steps.
|
|
|
* Put new host C code in its own directory within `test-code'. Add
|
* Put new host C code in its own directory within `test-code'. Add
|
the directory to the existing `Makefile.am' in the `test-code'
|
the directory to the existing `Makefile.am' in the `test-code'
|
directory and create a `Makefile.am' in the new directory to drive
|
directory and create a `Makefile.am' in the new directory to drive
|
building the test program(s). Don't forget to add the new
|
building the test program(s). Don't forget to add the new
|
`Makefile' to the top level `configure.ac' so it gets generated.
|
`Makefile' to the top level `configure.ac' so it gets generated.
|
Not all tests require code here.
|
Not all tests require code here.
|
|
|
* Put new target C code in its own directory within `test-code-or1k'.
|
* Put new target C code in its own directory within `test-code-or1k'.
|
Once again modify & create `Makefile.am'. This time modify the
|
Once again modify & create `Makefile.am'. This time modify the
|
`configure.ac' in the `test-code-or1k' so the `Makefile' gets
|
`configure.ac' in the `test-code-or1k' so the `Makefile' gets
|
generated. The existing programs provide examples to start from,
|
generated. The existing programs provide examples to start from,
|
including custom linker scripts where needed.
|
including custom linker scripts where needed.
|
|
|
* Add one or more tests and configuration files to the relevant
|
* Add one or more tests and configuration files to the relevant
|
"tool" test directory. Use the existing tests as templates. They
|
"tool" test directory. Use the existing tests as templates. They
|
make heavy use of the `expect'/TCL procedures in the `config'
|
make heavy use of the `expect'/TCL procedures in the `config'
|
directory to facilitate driving the tests.
|
directory to facilitate driving the tests.
|
|
|
|
|
|
|
File: or1ksim.info, Node: GNU Free Documentation License, Next: Index, Prev: Code Internals, Up: Top
|
File: or1ksim.info, Node: GNU Free Documentation License, Next: Index, Prev: Code Internals, Up: Top
|
|
|
7 GNU Free Documentation License
|
7 GNU Free Documentation License
|
********************************
|
********************************
|
|
|
Version 1.2, November 2002
|
Version 1.2, November 2002
|
|
|
Copyright (C) 2000,2001,2002 Free Software Foundation, Inc.
|
Copyright (C) 2000,2001,2002 Free Software Foundation, Inc.
|
51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
|
51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
|
|
|
Everyone is permitted to copy and distribute verbatim copies
|
Everyone is permitted to copy and distribute verbatim copies
|
of this license document, but changing it is not allowed.
|
of this license document, but changing it is not allowed.
|
|
|
0. PREAMBLE
|
0. PREAMBLE
|
|
|
The purpose of this License is to make a manual, textbook, or other
|
The purpose of this License is to make a manual, textbook, or other
|
functional and useful document "free" in the sense of freedom: to
|
functional and useful document "free" in the sense of freedom: to
|
assure everyone the effective freedom to copy and redistribute it,
|
assure everyone the effective freedom to copy and redistribute it,
|
with or without modifying it, either commercially or
|
with or without modifying it, either commercially or
|
noncommercially. Secondarily, this License preserves for the
|
noncommercially. Secondarily, this License preserves for the
|
author and publisher a way to get credit for their work, while not
|
author and publisher a way to get credit for their work, while not
|
being considered responsible for modifications made by others.
|
being considered responsible for modifications made by others.
|
|
|
This License is a kind of "copyleft", which means that derivative
|
This License is a kind of "copyleft", which means that derivative
|
works of the document must themselves be free in the same sense.
|
works of the document must themselves be free in the same sense.
|
It complements the GNU General Public License, which is a copyleft
|
It complements the GNU General Public License, which is a copyleft
|
license designed for free software.
|
license designed for free software.
|
|
|
We have designed this License in order to use it for manuals for
|
We have designed this License in order to use it for manuals for
|
free software, because free software needs free documentation: a
|
free software, because free software needs free documentation: a
|
free program should come with manuals providing the same freedoms
|
free program should come with manuals providing the same freedoms
|
that the software does. But this License is not limited to
|
that the software does. But this License is not limited to
|
software manuals; it can be used for any textual work, regardless
|
software manuals; it can be used for any textual work, regardless
|
of subject matter or whether it is published as a printed book.
|
of subject matter or whether it is published as a printed book.
|
We recommend this License principally for works whose purpose is
|
We recommend this License principally for works whose purpose is
|
instruction or reference.
|
instruction or reference.
|
|
|
1. APPLICABILITY AND DEFINITIONS
|
1. APPLICABILITY AND DEFINITIONS
|
|
|
This License applies to any manual or other work, in any medium,
|
This License applies to any manual or other work, in any medium,
|
that contains a notice placed by the copyright holder saying it
|
that contains a notice placed by the copyright holder saying it
|
can be distributed under the terms of this License. Such a notice
|
can be distributed under the terms of this License. Such a notice
|
grants a world-wide, royalty-free license, unlimited in duration,
|
grants a world-wide, royalty-free license, unlimited in duration,
|
to use that work under the conditions stated herein. The
|
to use that work under the conditions stated herein. The
|
"Document", below, refers to any such manual or work. Any member
|
"Document", below, refers to any such manual or work. Any member
|
of the public is a licensee, and is addressed as "you". You
|
of the public is a licensee, and is addressed as "you". You
|
accept the license if you copy, modify or distribute the work in a
|
accept the license if you copy, modify or distribute the work in a
|
way requiring permission under copyright law.
|
way requiring permission under copyright law.
|
|
|
A "Modified Version" of the Document means any work containing the
|
A "Modified Version" of the Document means any work containing the
|
Document or a portion of it, either copied verbatim, or with
|
Document or a portion of it, either copied verbatim, or with
|
modifications and/or translated into another language.
|
modifications and/or translated into another language.
|
|
|
A "Secondary Section" is a named appendix or a front-matter section
|
A "Secondary Section" is a named appendix or a front-matter section
|
of the Document that deals exclusively with the relationship of the
|
of the Document that deals exclusively with the relationship of the
|
publishers or authors of the Document to the Document's overall
|
publishers or authors of the Document to the Document's overall
|
subject (or to related matters) and contains nothing that could
|
subject (or to related matters) and contains nothing that could
|
fall directly within that overall subject. (Thus, if the Document
|
fall directly within that overall subject. (Thus, if the Document
|
is in part a textbook of mathematics, a Secondary Section may not
|
is in part a textbook of mathematics, a Secondary Section may not
|
explain any mathematics.) The relationship could be a matter of
|
explain any mathematics.) The relationship could be a matter of
|
historical connection with the subject or with related matters, or
|
historical connection with the subject or with related matters, or
|
of legal, commercial, philosophical, ethical or political position
|
of legal, commercial, philosophical, ethical or political position
|
regarding them.
|
regarding them.
|
|
|
The "Invariant Sections" are certain Secondary Sections whose
|
The "Invariant Sections" are certain Secondary Sections whose
|
titles are designated, as being those of Invariant Sections, in
|
titles are designated, as being those of Invariant Sections, in
|
the notice that says that the Document is released under this
|
the notice that says that the Document is released under this
|
License. If a section does not fit the above definition of
|
License. If a section does not fit the above definition of
|
Secondary then it is not allowed to be designated as Invariant.
|
Secondary then it is not allowed to be designated as Invariant.
|
The Document may contain zero Invariant Sections. If the Document
|
The Document may contain zero Invariant Sections. If the Document
|
does not identify any Invariant Sections then there are none.
|
does not identify any Invariant Sections then there are none.
|
|
|
The "Cover Texts" are certain short passages of text that are
|
The "Cover Texts" are certain short passages of text that are
|
listed, as Front-Cover Texts or Back-Cover Texts, in the notice
|
listed, as Front-Cover Texts or Back-Cover Texts, in the notice
|
that says that the Document is released under this License. A
|
that says that the Document is released under this License. A
|
Front-Cover Text may be at most 5 words, and a Back-Cover Text may
|
Front-Cover Text may be at most 5 words, and a Back-Cover Text may
|
be at most 25 words.
|
be at most 25 words.
|
|
|
A "Transparent" copy of the Document means a machine-readable copy,
|
A "Transparent" copy of the Document means a machine-readable copy,
|
represented in a format whose specification is available to the
|
represented in a format whose specification is available to the
|
general public, that is suitable for revising the document
|
general public, that is suitable for revising the document
|
straightforwardly with generic text editors or (for images
|
straightforwardly with generic text editors or (for images
|
composed of pixels) generic paint programs or (for drawings) some
|
composed of pixels) generic paint programs or (for drawings) some
|
widely available drawing editor, and that is suitable for input to
|
widely available drawing editor, and that is suitable for input to
|
text formatters or for automatic translation to a variety of
|
text formatters or for automatic translation to a variety of
|
formats suitable for input to text formatters. A copy made in an
|
formats suitable for input to text formatters. A copy made in an
|
otherwise Transparent file format whose markup, or absence of
|
otherwise Transparent file format whose markup, or absence of
|
markup, has been arranged to thwart or discourage subsequent
|
markup, has been arranged to thwart or discourage subsequent
|
modification by readers is not Transparent. An image format is
|
modification by readers is not Transparent. An image format is
|
not Transparent if used for any substantial amount of text. A
|
not Transparent if used for any substantial amount of text. A
|
copy that is not "Transparent" is called "Opaque".
|
copy that is not "Transparent" is called "Opaque".
|
|
|
Examples of suitable formats for Transparent copies include plain
|
Examples of suitable formats for Transparent copies include plain
|
ASCII without markup, Texinfo input format, LaTeX input format,
|
ASCII without markup, Texinfo input format, LaTeX input format,
|
SGML or XML using a publicly available DTD, and
|
SGML or XML using a publicly available DTD, and
|
standard-conforming simple HTML, PostScript or PDF designed for
|
standard-conforming simple HTML, PostScript or PDF designed for
|
human modification. Examples of transparent image formats include
|
human modification. Examples of transparent image formats include
|
PNG, XCF and JPG. Opaque formats include proprietary formats that
|
PNG, XCF and JPG. Opaque formats include proprietary formats that
|
can be read and edited only by proprietary word processors, SGML or
|
can be read and edited only by proprietary word processors, SGML or
|
XML for which the DTD and/or processing tools are not generally
|
XML for which the DTD and/or processing tools are not generally
|
available, and the machine-generated HTML, PostScript or PDF
|
available, and the machine-generated HTML, PostScript or PDF
|
produced by some word processors for output purposes only.
|
produced by some word processors for output purposes only.
|
|
|
The "Title Page" means, for a printed book, the title page itself,
|
The "Title Page" means, for a printed book, the title page itself,
|
plus such following pages as are needed to hold, legibly, the
|
plus such following pages as are needed to hold, legibly, the
|
material this License requires to appear in the title page. For
|
material this License requires to appear in the title page. For
|
works in formats which do not have any title page as such, "Title
|
works in formats which do not have any title page as such, "Title
|
Page" means the text near the most prominent appearance of the
|
Page" means the text near the most prominent appearance of the
|
work's title, preceding the beginning of the body of the text.
|
work's title, preceding the beginning of the body of the text.
|
|
|
A section "Entitled XYZ" means a named subunit of the Document
|
A section "Entitled XYZ" means a named subunit of the Document
|
whose title either is precisely XYZ or contains XYZ in parentheses
|
whose title either is precisely XYZ or contains XYZ in parentheses
|
following text that translates XYZ in another language. (Here XYZ
|
following text that translates XYZ in another language. (Here XYZ
|
stands for a specific section name mentioned below, such as
|
stands for a specific section name mentioned below, such as
|
"Acknowledgements", "Dedications", "Endorsements", or "History".)
|
"Acknowledgements", "Dedications", "Endorsements", or "History".)
|
To "Preserve the Title" of such a section when you modify the
|
To "Preserve the Title" of such a section when you modify the
|
Document means that it remains a section "Entitled XYZ" according
|
Document means that it remains a section "Entitled XYZ" according
|
to this definition.
|
to this definition.
|
|
|
The Document may include Warranty Disclaimers next to the notice
|
The Document may include Warranty Disclaimers next to the notice
|
which states that this License applies to the Document. These
|
which states that this License applies to the Document. These
|
Warranty Disclaimers are considered to be included by reference in
|
Warranty Disclaimers are considered to be included by reference in
|
this License, but only as regards disclaiming warranties: any other
|
this License, but only as regards disclaiming warranties: any other
|
implication that these Warranty Disclaimers may have is void and
|
implication that these Warranty Disclaimers may have is void and
|
has no effect on the meaning of this License.
|
has no effect on the meaning of this License.
|
|
|
2. VERBATIM COPYING
|
2. VERBATIM COPYING
|
|
|
You may copy and distribute the Document in any medium, either
|
You may copy and distribute the Document in any medium, either
|
commercially or noncommercially, provided that this License, the
|
commercially or noncommercially, provided that this License, the
|
copyright notices, and the license notice saying this License
|
copyright notices, and the license notice saying this License
|
applies to the Document are reproduced in all copies, and that you
|
applies to the Document are reproduced in all copies, and that you
|
add no other conditions whatsoever to those of this License. You
|
add no other conditions whatsoever to those of this License. You
|
may not use technical measures to obstruct or control the reading
|
may not use technical measures to obstruct or control the reading
|
or further copying of the copies you make or distribute. However,
|
or further copying of the copies you make or distribute. However,
|
you may accept compensation in exchange for copies. If you
|
you may accept compensation in exchange for copies. If you
|
distribute a large enough number of copies you must also follow
|
distribute a large enough number of copies you must also follow
|
the conditions in section 3.
|
the conditions in section 3.
|
|
|
You may also lend copies, under the same conditions stated above,
|
You may also lend copies, under the same conditions stated above,
|
and you may publicly display copies.
|
and you may publicly display copies.
|
|
|
3. COPYING IN QUANTITY
|
3. COPYING IN QUANTITY
|
|
|
If you publish printed copies (or copies in media that commonly
|
If you publish printed copies (or copies in media that commonly
|
have printed covers) of the Document, numbering more than 100, and
|
have printed covers) of the Document, numbering more than 100, and
|
the Document's license notice requires Cover Texts, you must
|
the Document's license notice requires Cover Texts, you must
|
enclose the copies in covers that carry, clearly and legibly, all
|
enclose the copies in covers that carry, clearly and legibly, all
|
these Cover Texts: Front-Cover Texts on the front cover, and
|
these Cover Texts: Front-Cover Texts on the front cover, and
|
Back-Cover Texts on the back cover. Both covers must also clearly
|
Back-Cover Texts on the back cover. Both covers must also clearly
|
and legibly identify you as the publisher of these copies. The
|
and legibly identify you as the publisher of these copies. The
|
front cover must present the full title with all words of the
|
front cover must present the full title with all words of the
|
title equally prominent and visible. You may add other material
|
title equally prominent and visible. You may add other material
|
on the covers in addition. Copying with changes limited to the
|
on the covers in addition. Copying with changes limited to the
|
covers, as long as they preserve the title of the Document and
|
covers, as long as they preserve the title of the Document and
|
satisfy these conditions, can be treated as verbatim copying in
|
satisfy these conditions, can be treated as verbatim copying in
|
other respects.
|
other respects.
|
|
|
If the required texts for either cover are too voluminous to fit
|
If the required texts for either cover are too voluminous to fit
|
legibly, you should put the first ones listed (as many as fit
|
legibly, you should put the first ones listed (as many as fit
|
reasonably) on the actual cover, and continue the rest onto
|
reasonably) on the actual cover, and continue the rest onto
|
adjacent pages.
|
adjacent pages.
|
|
|
If you publish or distribute Opaque copies of the Document
|
If you publish or distribute Opaque copies of the Document
|
numbering more than 100, you must either include a
|
numbering more than 100, you must either include a
|
machine-readable Transparent copy along with each Opaque copy, or
|
machine-readable Transparent copy along with each Opaque copy, or
|
state in or with each Opaque copy a computer-network location from
|
state in or with each Opaque copy a computer-network location from
|
which the general network-using public has access to download
|
which the general network-using public has access to download
|
using public-standard network protocols a complete Transparent
|
using public-standard network protocols a complete Transparent
|
copy of the Document, free of added material. If you use the
|
copy of the Document, free of added material. If you use the
|
latter option, you must take reasonably prudent steps, when you
|
latter option, you must take reasonably prudent steps, when you
|
begin distribution of Opaque copies in quantity, to ensure that
|
begin distribution of Opaque copies in quantity, to ensure that
|
this Transparent copy will remain thus accessible at the stated
|
this Transparent copy will remain thus accessible at the stated
|
location until at least one year after the last time you
|
location until at least one year after the last time you
|
distribute an Opaque copy (directly or through your agents or
|
distribute an Opaque copy (directly or through your agents or
|
retailers) of that edition to the public.
|
retailers) of that edition to the public.
|
|
|
It is requested, but not required, that you contact the authors of
|
It is requested, but not required, that you contact the authors of
|
the Document well before redistributing any large number of
|
the Document well before redistributing any large number of
|
copies, to give them a chance to provide you with an updated
|
copies, to give them a chance to provide you with an updated
|
version of the Document.
|
version of the Document.
|
|
|
4. MODIFICATIONS
|
4. MODIFICATIONS
|
|
|
You may copy and distribute a Modified Version of the Document
|
You may copy and distribute a Modified Version of the Document
|
under the conditions of sections 2 and 3 above, provided that you
|
under the conditions of sections 2 and 3 above, provided that you
|
release the Modified Version under precisely this License, with
|
release the Modified Version under precisely this License, with
|
the Modified Version filling the role of the Document, thus
|
the Modified Version filling the role of the Document, thus
|
licensing distribution and modification of the Modified Version to
|
licensing distribution and modification of the Modified Version to
|
whoever possesses a copy of it. In addition, you must do these
|
whoever possesses a copy of it. In addition, you must do these
|
things in the Modified Version:
|
things in the Modified Version:
|
|
|
A. Use in the Title Page (and on the covers, if any) a title
|
A. Use in the Title Page (and on the covers, if any) a title
|
distinct from that of the Document, and from those of
|
distinct from that of the Document, and from those of
|
previous versions (which should, if there were any, be listed
|
previous versions (which should, if there were any, be listed
|
in the History section of the Document). You may use the
|
in the History section of the Document). You may use the
|
same title as a previous version if the original publisher of
|
same title as a previous version if the original publisher of
|
that version gives permission.
|
that version gives permission.
|
|
|
B. List on the Title Page, as authors, one or more persons or
|
B. List on the Title Page, as authors, one or more persons or
|
entities responsible for authorship of the modifications in
|
entities responsible for authorship of the modifications in
|
the Modified Version, together with at least five of the
|
the Modified Version, together with at least five of the
|
principal authors of the Document (all of its principal
|
principal authors of the Document (all of its principal
|
authors, if it has fewer than five), unless they release you
|
authors, if it has fewer than five), unless they release you
|
from this requirement.
|
from this requirement.
|
|
|
C. State on the Title page the name of the publisher of the
|
C. State on the Title page the name of the publisher of the
|
Modified Version, as the publisher.
|
Modified Version, as the publisher.
|
|
|
D. Preserve all the copyright notices of the Document.
|
D. Preserve all the copyright notices of the Document.
|
|
|
E. Add an appropriate copyright notice for your modifications
|
E. Add an appropriate copyright notice for your modifications
|
adjacent to the other copyright notices.
|
adjacent to the other copyright notices.
|
|
|
F. Include, immediately after the copyright notices, a license
|
F. Include, immediately after the copyright notices, a license
|
notice giving the public permission to use the Modified
|
notice giving the public permission to use the Modified
|
Version under the terms of this License, in the form shown in
|
Version under the terms of this License, in the form shown in
|
the Addendum below.
|
the Addendum below.
|
|
|
G. Preserve in that license notice the full lists of Invariant
|
G. Preserve in that license notice the full lists of Invariant
|
Sections and required Cover Texts given in the Document's
|
Sections and required Cover Texts given in the Document's
|
license notice.
|
license notice.
|
|
|
H. Include an unaltered copy of this License.
|
H. Include an unaltered copy of this License.
|
|
|
I. Preserve the section Entitled "History", Preserve its Title,
|
I. Preserve the section Entitled "History", Preserve its Title,
|
and add to it an item stating at least the title, year, new
|
and add to it an item stating at least the title, year, new
|
authors, and publisher of the Modified Version as given on
|
authors, and publisher of the Modified Version as given on
|
the Title Page. If there is no section Entitled "History" in
|
the Title Page. If there is no section Entitled "History" in
|
the Document, create one stating the title, year, authors,
|
the Document, create one stating the title, year, authors,
|
and publisher of the Document as given on its Title Page,
|
and publisher of the Document as given on its Title Page,
|
then add an item describing the Modified Version as stated in
|
then add an item describing the Modified Version as stated in
|
the previous sentence.
|
the previous sentence.
|
|
|
J. Preserve the network location, if any, given in the Document
|
J. Preserve the network location, if any, given in the Document
|
for public access to a Transparent copy of the Document, and
|
for public access to a Transparent copy of the Document, and
|
likewise the network locations given in the Document for
|
likewise the network locations given in the Document for
|
previous versions it was based on. These may be placed in
|
previous versions it was based on. These may be placed in
|
the "History" section. You may omit a network location for a
|
the "History" section. You may omit a network location for a
|
work that was published at least four years before the
|
work that was published at least four years before the
|
Document itself, or if the original publisher of the version
|
Document itself, or if the original publisher of the version
|
it refers to gives permission.
|
it refers to gives permission.
|
|
|
K. For any section Entitled "Acknowledgements" or "Dedications",
|
K. For any section Entitled "Acknowledgements" or "Dedications",
|
Preserve the Title of the section, and preserve in the
|
Preserve the Title of the section, and preserve in the
|
section all the substance and tone of each of the contributor
|
section all the substance and tone of each of the contributor
|
acknowledgements and/or dedications given therein.
|
acknowledgements and/or dedications given therein.
|
|
|
L. Preserve all the Invariant Sections of the Document,
|
L. Preserve all the Invariant Sections of the Document,
|
unaltered in their text and in their titles. Section numbers
|
unaltered in their text and in their titles. Section numbers
|
or the equivalent are not considered part of the section
|
or the equivalent are not considered part of the section
|
titles.
|
titles.
|
|
|
M. Delete any section Entitled "Endorsements". Such a section
|
M. Delete any section Entitled "Endorsements". Such a section
|
may not be included in the Modified Version.
|
may not be included in the Modified Version.
|
|
|
N. Do not retitle any existing section to be Entitled
|
N. Do not retitle any existing section to be Entitled
|
"Endorsements" or to conflict in title with any Invariant
|
"Endorsements" or to conflict in title with any Invariant
|
Section.
|
Section.
|
|
|
O. Preserve any Warranty Disclaimers.
|
O. Preserve any Warranty Disclaimers.
|
|
|
If the Modified Version includes new front-matter sections or
|
If the Modified Version includes new front-matter sections or
|
appendices that qualify as Secondary Sections and contain no
|
appendices that qualify as Secondary Sections and contain no
|
material copied from the Document, you may at your option
|
material copied from the Document, you may at your option
|
designate some or all of these sections as invariant. To do this,
|
designate some or all of these sections as invariant. To do this,
|
add their titles to the list of Invariant Sections in the Modified
|
add their titles to the list of Invariant Sections in the Modified
|
Version's license notice. These titles must be distinct from any
|
Version's license notice. These titles must be distinct from any
|
other section titles.
|
other section titles.
|
|
|
You may add a section Entitled "Endorsements", provided it contains
|
You may add a section Entitled "Endorsements", provided it contains
|
nothing but endorsements of your Modified Version by various
|
nothing but endorsements of your Modified Version by various
|
parties--for example, statements of peer review or that the text
|
parties--for example, statements of peer review or that the text
|
has been approved by an organization as the authoritative
|
has been approved by an organization as the authoritative
|
definition of a standard.
|
definition of a standard.
|
|
|
You may add a passage of up to five words as a Front-Cover Text,
|
You may add a passage of up to five words as a Front-Cover Text,
|
and a passage of up to 25 words as a Back-Cover Text, to the end
|
and a passage of up to 25 words as a Back-Cover Text, to the end
|
of the list of Cover Texts in the Modified Version. Only one
|
of the list of Cover Texts in the Modified Version. Only one
|
passage of Front-Cover Text and one of Back-Cover Text may be
|
passage of Front-Cover Text and one of Back-Cover Text may be
|
added by (or through arrangements made by) any one entity. If the
|
added by (or through arrangements made by) any one entity. If the
|
Document already includes a cover text for the same cover,
|
Document already includes a cover text for the same cover,
|
previously added by you or by arrangement made by the same entity
|
previously added by you or by arrangement made by the same entity
|
you are acting on behalf of, you may not add another; but you may
|
you are acting on behalf of, you may not add another; but you may
|
replace the old one, on explicit permission from the previous
|
replace the old one, on explicit permission from the previous
|
publisher that added the old one.
|
publisher that added the old one.
|
|
|
The author(s) and publisher(s) of the Document do not by this
|
The author(s) and publisher(s) of the Document do not by this
|
License give permission to use their names for publicity for or to
|
License give permission to use their names for publicity for or to
|
assert or imply endorsement of any Modified Version.
|
assert or imply endorsement of any Modified Version.
|
|
|
5. COMBINING DOCUMENTS
|
5. COMBINING DOCUMENTS
|
|
|
You may combine the Document with other documents released under
|
You may combine the Document with other documents released under
|
this License, under the terms defined in section 4 above for
|
this License, under the terms defined in section 4 above for
|
modified versions, provided that you include in the combination
|
modified versions, provided that you include in the combination
|
all of the Invariant Sections of all of the original documents,
|
all of the Invariant Sections of all of the original documents,
|
unmodified, and list them all as Invariant Sections of your
|
unmodified, and list them all as Invariant Sections of your
|
combined work in its license notice, and that you preserve all
|
combined work in its license notice, and that you preserve all
|
their Warranty Disclaimers.
|
their Warranty Disclaimers.
|
|
|
The combined work need only contain one copy of this License, and
|
The combined work need only contain one copy of this License, and
|
multiple identical Invariant Sections may be replaced with a single
|
multiple identical Invariant Sections may be replaced with a single
|
copy. If there are multiple Invariant Sections with the same name
|
copy. If there are multiple Invariant Sections with the same name
|
but different contents, make the title of each such section unique
|
but different contents, make the title of each such section unique
|
by adding at the end of it, in parentheses, the name of the
|
by adding at the end of it, in parentheses, the name of the
|
original author or publisher of that section if known, or else a
|
original author or publisher of that section if known, or else a
|
unique number. Make the same adjustment to the section titles in
|
unique number. Make the same adjustment to the section titles in
|
the list of Invariant Sections in the license notice of the
|
the list of Invariant Sections in the license notice of the
|
combined work.
|
combined work.
|
|
|
In the combination, you must combine any sections Entitled
|
In the combination, you must combine any sections Entitled
|
"History" in the various original documents, forming one section
|
"History" in the various original documents, forming one section
|
Entitled "History"; likewise combine any sections Entitled
|
Entitled "History"; likewise combine any sections Entitled
|
"Acknowledgements", and any sections Entitled "Dedications". You
|
"Acknowledgements", and any sections Entitled "Dedications". You
|
must delete all sections Entitled "Endorsements."
|
must delete all sections Entitled "Endorsements."
|
|
|
6. COLLECTIONS OF DOCUMENTS
|
6. COLLECTIONS OF DOCUMENTS
|
|
|
You may make a collection consisting of the Document and other
|
You may make a collection consisting of the Document and other
|
documents released under this License, and replace the individual
|
documents released under this License, and replace the individual
|
copies of this License in the various documents with a single copy
|
copies of this License in the various documents with a single copy
|
that is included in the collection, provided that you follow the
|
that is included in the collection, provided that you follow the
|
rules of this License for verbatim copying of each of the
|
rules of this License for verbatim copying of each of the
|
documents in all other respects.
|
documents in all other respects.
|
|
|
You may extract a single document from such a collection, and
|
You may extract a single document from such a collection, and
|
distribute it individually under this License, provided you insert
|
distribute it individually under this License, provided you insert
|
a copy of this License into the extracted document, and follow
|
a copy of this License into the extracted document, and follow
|
this License in all other respects regarding verbatim copying of
|
this License in all other respects regarding verbatim copying of
|
that document.
|
that document.
|
|
|
7. AGGREGATION WITH INDEPENDENT WORKS
|
7. AGGREGATION WITH INDEPENDENT WORKS
|
|
|
A compilation of the Document or its derivatives with other
|
A compilation of the Document or its derivatives with other
|
separate and independent documents or works, in or on a volume of
|
separate and independent documents or works, in or on a volume of
|
a storage or distribution medium, is called an "aggregate" if the
|
a storage or distribution medium, is called an "aggregate" if the
|
copyright resulting from the compilation is not used to limit the
|
copyright resulting from the compilation is not used to limit the
|
legal rights of the compilation's users beyond what the individual
|
legal rights of the compilation's users beyond what the individual
|
works permit. When the Document is included in an aggregate, this
|
works permit. When the Document is included in an aggregate, this
|
License does not apply to the other works in the aggregate which
|
License does not apply to the other works in the aggregate which
|
are not themselves derivative works of the Document.
|
are not themselves derivative works of the Document.
|
|
|
If the Cover Text requirement of section 3 is applicable to these
|
If the Cover Text requirement of section 3 is applicable to these
|
copies of the Document, then if the Document is less than one half
|
copies of the Document, then if the Document is less than one half
|
of the entire aggregate, the Document's Cover Texts may be placed
|
of the entire aggregate, the Document's Cover Texts may be placed
|
on covers that bracket the Document within the aggregate, or the
|
on covers that bracket the Document within the aggregate, or the
|
electronic equivalent of covers if the Document is in electronic
|
electronic equivalent of covers if the Document is in electronic
|
form. Otherwise they must appear on printed covers that bracket
|
form. Otherwise they must appear on printed covers that bracket
|
the whole aggregate.
|
the whole aggregate.
|
|
|
8. TRANSLATION
|
8. TRANSLATION
|
|
|
Translation is considered a kind of modification, so you may
|
Translation is considered a kind of modification, so you may
|
distribute translations of the Document under the terms of section
|
distribute translations of the Document under the terms of section
|
4. Replacing Invariant Sections with translations requires special
|
4. Replacing Invariant Sections with translations requires special
|
permission from their copyright holders, but you may include
|
permission from their copyright holders, but you may include
|
translations of some or all Invariant Sections in addition to the
|
translations of some or all Invariant Sections in addition to the
|
original versions of these Invariant Sections. You may include a
|
original versions of these Invariant Sections. You may include a
|
translation of this License, and all the license notices in the
|
translation of this License, and all the license notices in the
|
Document, and any Warranty Disclaimers, provided that you also
|
Document, and any Warranty Disclaimers, provided that you also
|
include the original English version of this License and the
|
include the original English version of this License and the
|
original versions of those notices and disclaimers. In case of a
|
original versions of those notices and disclaimers. In case of a
|
disagreement between the translation and the original version of
|
disagreement between the translation and the original version of
|
this License or a notice or disclaimer, the original version will
|
this License or a notice or disclaimer, the original version will
|
prevail.
|
prevail.
|
|
|
If a section in the Document is Entitled "Acknowledgements",
|
If a section in the Document is Entitled "Acknowledgements",
|
"Dedications", or "History", the requirement (section 4) to
|
"Dedications", or "History", the requirement (section 4) to
|
Preserve its Title (section 1) will typically require changing the
|
Preserve its Title (section 1) will typically require changing the
|
actual title.
|
actual title.
|
|
|
9. TERMINATION
|
9. TERMINATION
|
|
|
You may not copy, modify, sublicense, or distribute the Document
|
You may not copy, modify, sublicense, or distribute the Document
|
except as expressly provided for under this License. Any other
|
except as expressly provided for under this License. Any other
|
attempt to copy, modify, sublicense or distribute the Document is
|
attempt to copy, modify, sublicense or distribute the Document is
|
void, and will automatically terminate your rights under this
|
void, and will automatically terminate your rights under this
|
License. However, parties who have received copies, or rights,
|
License. However, parties who have received copies, or rights,
|
from you under this License will not have their licenses
|
from you under this License will not have their licenses
|
terminated so long as such parties remain in full compliance.
|
terminated so long as such parties remain in full compliance.
|
|
|
10. FUTURE REVISIONS OF THIS LICENSE
|
10. FUTURE REVISIONS OF THIS LICENSE
|
|
|
The Free Software Foundation may publish new, revised versions of
|
The Free Software Foundation may publish new, revised versions of
|
the GNU Free Documentation License from time to time. Such new
|
the GNU Free Documentation License from time to time. Such new
|
versions will be similar in spirit to the present version, but may
|
versions will be similar in spirit to the present version, but may
|
differ in detail to address new problems or concerns. See
|
differ in detail to address new problems or concerns. See
|
`http://www.gnu.org/copyleft/'.
|
`http://www.gnu.org/copyleft/'.
|
|
|
Each version of the License is given a distinguishing version
|
Each version of the License is given a distinguishing version
|
number. If the Document specifies that a particular numbered
|
number. If the Document specifies that a particular numbered
|
version of this License "or any later version" applies to it, you
|
version of this License "or any later version" applies to it, you
|
have the option of following the terms and conditions either of
|
have the option of following the terms and conditions either of
|
that specified version or of any later version that has been
|
that specified version or of any later version that has been
|
published (not as a draft) by the Free Software Foundation. If
|
published (not as a draft) by the Free Software Foundation. If
|
the Document does not specify a version number of this License,
|
the Document does not specify a version number of this License,
|
you may choose any version ever published (not as a draft) by the
|
you may choose any version ever published (not as a draft) by the
|
Free Software Foundation.
|
Free Software Foundation.
|
|
|
ADDENDUM: How to use this License for your documents
|
ADDENDUM: How to use this License for your documents
|
====================================================
|
====================================================
|
|
|
To use this License in a document you have written, include a copy of
|
To use this License in a document you have written, include a copy of
|
the License in the document and put the following copyright and license
|
the License in the document and put the following copyright and license
|
notices just after the title page:
|
notices just after the title page:
|
|
|
Copyright (C) YEAR YOUR NAME.
|
Copyright (C) YEAR YOUR NAME.
|
Permission is granted to copy, distribute and/or modify this document
|
Permission is granted to copy, distribute and/or modify this document
|
under the terms of the GNU Free Documentation License, Version 1.2
|
under the terms of the GNU Free Documentation License, Version 1.2
|
or any later version published by the Free Software Foundation;
|
or any later version published by the Free Software Foundation;
|
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
|
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
|
Texts. A copy of the license is included in the section entitled ``GNU
|
Texts. A copy of the license is included in the section entitled ``GNU
|
Free Documentation License''.
|
Free Documentation License''.
|
|
|
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
|
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
|
replace the "with...Texts." line with this:
|
replace the "with...Texts." line with this:
|
|
|
with the Invariant Sections being LIST THEIR TITLES, with
|
with the Invariant Sections being LIST THEIR TITLES, with
|
the Front-Cover Texts being LIST, and with the Back-Cover Texts
|
the Front-Cover Texts being LIST, and with the Back-Cover Texts
|
being LIST.
|
being LIST.
|
|
|
If you have Invariant Sections without Cover Texts, or some other
|
If you have Invariant Sections without Cover Texts, or some other
|
combination of the three, merge those two alternatives to suit the
|
combination of the three, merge those two alternatives to suit the
|
situation.
|
situation.
|
|
|
If your document contains nontrivial examples of program code, we
|
If your document contains nontrivial examples of program code, we
|
recommend releasing these examples in parallel under your choice of
|
recommend releasing these examples in parallel under your choice of
|
free software license, such as the GNU General Public License, to
|
free software license, such as the GNU General Public License, to
|
permit their use in free software.
|
permit their use in free software.
|
|
|
|
|
File: or1ksim.info, Node: Index, Prev: GNU Free Documentation License, Up: Top
|
File: or1ksim.info, Node: Index, Prev: GNU Free Documentation License, Up: Top
|
|
|
Index
|
Index
|
*****
|
*****
|
|
|
[index ]
|
[index ]
|
* Menu:
|
* Menu:
|
|
|
* --cumulative: Profiling Utility. (line 26)
|
* --cumulative: Profiling Utility. (line 26)
|
* --debug-config: Standalone Simulator.
|
* --debug-config: Standalone Simulator.
|
(line 86)
|
(line 86)
|
* --disable-all-tests: Configuring the Build.
|
* --disable-all-tests: Configuring the Build.
|
(line 105)
|
(line 105)
|
* --disable-arith-flag: Configuring the Build.
|
* --disable-arith-flag: Configuring the Build.
|
(line 118)
|
(line 118)
|
* --disable-debug: Configuring the Build.
|
* --disable-debug: Configuring the Build.
|
(line 98)
|
(line 98)
|
* --disable-ethphy: Configuring the Build.
|
* --disable-ethphy: Configuring the Build.
|
(line 59)
|
(line 59)
|
* --disable-ov-flag: Configuring the Build.
|
* --disable-ov-flag: Configuring the Build.
|
(line 133)
|
(line 133)
|
* --disable-profiling: Configuring the Build.
|
* --disable-profiling: Configuring the Build.
|
(line 30)
|
(line 30)
|
* --disable-range-stats: Configuring the Build.
|
* --disable-range-stats: Configuring the Build.
|
(line 92)
|
(line 92)
|
* --disable-unsigned-xori: Configuring the Build.
|
* --disable-unsigned-xori: Configuring the Build.
|
(line 69)
|
(line 69)
|
* --enable-all-tests: Configuring the Build.
|
* --enable-all-tests: Configuring the Build.
|
(line 104)
|
(line 104)
|
* --enable-arith-flag: Configuring the Build.
|
* --enable-arith-flag: Configuring the Build.
|
(line 117)
|
(line 117)
|
* --enable-debug: Configuring the Build.
|
* --enable-debug: Configuring the Build.
|
(line 97)
|
(line 97)
|
* --enable-ethphy: Configuring the Build.
|
* --enable-ethphy: Configuring the Build.
|
(line 58)
|
(line 58)
|
* --enable-execution: Configuring the Build.
|
* --enable-execution: Configuring the Build.
|
(line 37)
|
(line 37)
|
* --enable-mprofile: Standalone Simulator.
|
* --enable-mprofile: Standalone Simulator.
|
(line 120)
|
(line 120)
|
* --enable-ov-flag: Configuring the Build.
|
* --enable-ov-flag: Configuring the Build.
|
(line 132)
|
(line 132)
|
* --enable-profile: Standalone Simulator.
|
* --enable-profile: Standalone Simulator.
|
(line 117)
|
(line 117)
|
* --enable-profiling: Configuring the Build.
|
* --enable-profiling: Configuring the Build.
|
(line 29)
|
(line 29)
|
* --enable-range-stats: Configuring the Build.
|
* --enable-range-stats: Configuring the Build.
|
(line 91)
|
(line 91)
|
* --enable-unsigned-xori: Configuring the Build.
|
* --enable-unsigned-xori: Configuring the Build.
|
(line 68)
|
(line 68)
|
* --file: Standalone Simulator.
|
* --file: Standalone Simulator.
|
(line 44)
|
(line 44)
|
* --filename: Memory Profiling Utility.
|
* --filename: Memory Profiling Utility.
|
(line 51)
|
(line 51)
|
* --generate: Profiling Utility. (line 34)
|
* --generate: Profiling Utility. (line 34)
|
* --group: Memory Profiling Utility.
|
* --group: Memory Profiling Utility.
|
(line 47)
|
(line 47)
|
* --help: Standalone Simulator.
|
* --help: Standalone Simulator.
|
(line 21)
|
(line 21)
|
* --help (memory profiling utility): Memory Profiling Utility.
|
* --help (memory profiling utility): Memory Profiling Utility.
|
(line 22)
|
(line 22)
|
* --help (profiling utility): Profiling Utility. (line 22)
|
* --help (profiling utility): Profiling Utility. (line 22)
|
* --interactive: Standalone Simulator.
|
* --interactive: Standalone Simulator.
|
(line 25)
|
(line 25)
|
* --memory: Standalone Simulator.
|
* --memory: Standalone Simulator.
|
(line 70)
|
(line 70)
|
* --mode: Memory Profiling Utility.
|
* --mode: Memory Profiling Utility.
|
(line 26)
|
(line 26)
|
* --nosrv: Standalone Simulator.
|
* --nosrv: Standalone Simulator.
|
(line 52)
|
(line 52)
|
* --quiet <1>: Profiling Utility. (line 30)
|
* --quiet <1>: Profiling Utility. (line 30)
|
* --quiet: Standalone Simulator.
|
* --quiet: Standalone Simulator.
|
(line 29)
|
(line 29)
|
* --report-memory-errors: Standalone Simulator.
|
* --report-memory-errors: Standalone Simulator.
|
(line 91)
|
(line 91)
|
* --srv: Standalone Simulator.
|
* --srv: Standalone Simulator.
|
(line 60)
|
(line 60)
|
* --strict-npc: Standalone Simulator.
|
* --strict-npc: Standalone Simulator.
|
(line 100)
|
(line 100)
|
* --trace: Standalone Simulator.
|
* --trace: Standalone Simulator.
|
(line 39)
|
(line 39)
|
* --verbose: Standalone Simulator.
|
* --verbose: Standalone Simulator.
|
(line 33)
|
(line 33)
|
* --version: Standalone Simulator.
|
* --version: Standalone Simulator.
|
(line 17)
|
(line 17)
|
* --version (memory profiling utility): Memory Profiling Utility.
|
* --version (memory profiling utility): Memory Profiling Utility.
|
(line 17)
|
(line 17)
|
* --version (profiling utility): Profiling Utility. (line 17)
|
* --version (profiling utility): Profiling Utility. (line 17)
|
* -c: Profiling Utility. (line 26)
|
* -c: Profiling Utility. (line 26)
|
* -d: Standalone Simulator.
|
* -d: Standalone Simulator.
|
(line 86)
|
(line 86)
|
* -f <1>: Memory Profiling Utility.
|
* -f <1>: Memory Profiling Utility.
|
(line 51)
|
(line 51)
|
* -f: Standalone Simulator.
|
* -f: Standalone Simulator.
|
(line 44)
|
(line 44)
|
* -g <1>: Memory Profiling Utility.
|
* -g <1>: Memory Profiling Utility.
|
(line 47)
|
(line 47)
|
* -g: Profiling Utility. (line 34)
|
* -g: Profiling Utility. (line 34)
|
* -h: Standalone Simulator.
|
* -h: Standalone Simulator.
|
(line 21)
|
(line 21)
|
* -h (memory profiling utility): Memory Profiling Utility.
|
* -h (memory profiling utility): Memory Profiling Utility.
|
(line 22)
|
(line 22)
|
* -h (profiling utility): Profiling Utility. (line 22)
|
* -h (profiling utility): Profiling Utility. (line 22)
|
* -i: Standalone Simulator.
|
* -i: Standalone Simulator.
|
(line 25)
|
(line 25)
|
* -m <1>: Memory Profiling Utility.
|
* -m <1>: Memory Profiling Utility.
|
(line 26)
|
(line 26)
|
* -m: Standalone Simulator.
|
* -m: Standalone Simulator.
|
(line 70)
|
(line 70)
|
* -q <1>: Profiling Utility. (line 30)
|
* -q <1>: Profiling Utility. (line 30)
|
* -q: Standalone Simulator.
|
* -q: Standalone Simulator.
|
(line 29)
|
(line 29)
|
* -t: Standalone Simulator.
|
* -t: Standalone Simulator.
|
(line 39)
|
(line 39)
|
* -V: Standalone Simulator.
|
* -V: Standalone Simulator.
|
(line 33)
|
(line 33)
|
* -v: Standalone Simulator.
|
* -v: Standalone Simulator.
|
(line 17)
|
(line 17)
|
* -v (memory profiling utility): Memory Profiling Utility.
|
* -v (memory profiling utility): Memory Profiling Utility.
|
(line 17)
|
(line 17)
|
* -v (profiling utility): Profiling Utility. (line 17)
|
* -v (profiling utility): Profiling Utility. (line 17)
|
* 0x00 UART VAPI sub-command (UART verification): Verification API.
|
* 0x00 UART VAPI sub-command (UART verification): Verification API.
|
(line 49)
|
(line 49)
|
* 0x01 UART VAPI sub-command (UART verification): Verification API.
|
* 0x01 UART VAPI sub-command (UART verification): Verification API.
|
(line 55)
|
(line 55)
|
* 0x02 UART VAPI sub-command (UART verification): Verification API.
|
* 0x02 UART VAPI sub-command (UART verification): Verification API.
|
(line 59)
|
(line 59)
|
* 0x03 UART VAPI sub-command (UART verification): Verification API.
|
* 0x03 UART VAPI sub-command (UART verification): Verification API.
|
(line 62)
|
(line 62)
|
* 0x04 UART VAPI sub-command (UART verification): Verification API.
|
* 0x04 UART VAPI sub-command (UART verification): Verification API.
|
(line 66)
|
(line 66)
|
* 16550 (UART configuration): UART Configuration. (line 73)
|
* 16550 (UART configuration): UART Configuration. (line 73)
|
* all tests enabled: Configuring the Build.
|
* all tests enabled: Configuring the Build.
|
(line 105)
|
(line 105)
|
* Argtable2 debugging: Configuring the Build.
|
* Argtable2 debugging: Configuring the Build.
|
(line 98)
|
(line 98)
|
* ATA/ATAPI configuration: Disc Interface Configuration.
|
* ATA/ATAPI configuration: Disc Interface Configuration.
|
(line 6)
|
(line 6)
|
* ATA/ATAPI device configuration: Disc Interface Configuration.
|
* ATA/ATAPI device configuration: Disc Interface Configuration.
|
(line 92)
|
(line 92)
|
* base_vapi_id (GPIO configuration - deprecated): GPIO Configuration.
|
* base_vapi_id (GPIO configuration - deprecated): GPIO Configuration.
|
(line 32)
|
(line 32)
|
* baseaddr (ATA/ATAPI configuration): Disc Interface Configuration.
|
* baseaddr (ATA/ATAPI configuration): Disc Interface Configuration.
|
(line 26)
|
(line 26)
|
* baseaddr (DMA configuration): DMA Configuration. (line 24)
|
* baseaddr (DMA configuration): DMA Configuration. (line 24)
|
* baseaddr (Ethernet configuration): Ethernet Configuration.
|
* baseaddr (Ethernet configuration): Ethernet Configuration.
|
(line 22)
|
(line 22)
|
* baseaddr (frame buffer configuration): Frame Buffer Configuration.
|
* baseaddr (frame buffer configuration): Frame Buffer Configuration.
|
(line 20)
|
(line 20)
|
* baseaddr (generic peripheral configuration): Generic Peripheral Configuration.
|
* baseaddr (generic peripheral configuration): Generic Peripheral Configuration.
|
(line 22)
|
(line 22)
|
* baseaddr (GPIO configuration): GPIO Configuration. (line 21)
|
* baseaddr (GPIO configuration): GPIO Configuration. (line 21)
|
* baseaddr (keyboard configuration): Keyboard Configuration.
|
* baseaddr (keyboard configuration): Keyboard Configuration.
|
(line 36)
|
(line 36)
|
* baseaddr (memory configuration): Memory Configuration.
|
* baseaddr (memory configuration): Memory Configuration.
|
(line 94)
|
(line 94)
|
* baseaddr (memory controller configuration): Memory Controller Configuration.
|
* baseaddr (memory controller configuration): Memory Controller Configuration.
|
(line 55)
|
(line 55)
|
* baseaddr (UART configuration): UART Configuration. (line 22)
|
* baseaddr (UART configuration): UART Configuration. (line 22)
|
* baseaddr (VGA configuration): Display Interface Configuration.
|
* baseaddr (VGA configuration): Display Interface Configuration.
|
(line 26)
|
(line 26)
|
* blocksize (cache configuration): Cache Configuration. (line 29)
|
* blocksize (cache configuration): Cache Configuration. (line 29)
|
* BPB configuration: Branch Prediction Configuration.
|
* BPB configuration: Branch Prediction Configuration.
|
(line 6)
|
(line 6)
|
* branch prediction configuration: Branch Prediction Configuration.
|
* branch prediction configuration: Branch Prediction Configuration.
|
(line 6)
|
(line 6)
|
* break (Interactive CLI): Interactive Command Line.
|
* break (Interactive CLI): Interactive Command Line.
|
(line 57)
|
(line 57)
|
* breakpoint list (Interactive CLI): Interactive Command Line.
|
* breakpoint list (Interactive CLI): Interactive Command Line.
|
(line 60)
|
(line 60)
|
* breakpoint set/clear (Interactive CLI): Interactive Command Line.
|
* breakpoint set/clear (Interactive CLI): Interactive Command Line.
|
(line 57)
|
(line 57)
|
* breaks (Interactive CLI): Interactive Command Line.
|
* breaks (Interactive CLI): Interactive Command Line.
|
(line 60)
|
(line 60)
|
* btic (branch prediction configuration): Branch Prediction Configuration.
|
* btic (branch prediction configuration): Branch Prediction Configuration.
|
(line 19)
|
(line 19)
|
* byte_enabled (generic peripheral configuration): Generic Peripheral Configuration.
|
* byte_enabled (generic peripheral configuration): Generic Peripheral Configuration.
|
(line 48)
|
(line 48)
|
* cache configuration: Cache Configuration. (line 6)
|
* cache configuration: Cache Configuration. (line 6)
|
* calling_convention (CUC configuration): CUC Configuration. (line 37)
|
* calling_convention (CUC configuration): CUC Configuration. (line 37)
|
* ce (memory configuration): Memory Configuration.
|
* ce (memory configuration): Memory Configuration.
|
(line 124)
|
(line 124)
|
* cfgr (CPU configuration): CPU Configuration. (line 47)
|
* cfgr (CPU configuration): CPU Configuration. (line 47)
|
* channel (UART configuration): UART Configuration. (line 29)
|
* channel (UART configuration): UART Configuration. (line 29)
|
* clear breakpoint (Interactive CLI): Interactive Command Line.
|
* clear breakpoint (Interactive CLI): Interactive Command Line.
|
(line 57)
|
(line 57)
|
* clkcycle (simulator configuration): Simulator Behavior. (line 115)
|
* clkcycle (simulator configuration): Simulator Behavior. (line 115)
|
* cm (Interactive CLI): Interactive Command Line.
|
* cm (Interactive CLI): Interactive Command Line.
|
(line 54)
|
(line 54)
|
* command line for Or1ksim standalone use: Standalone Simulator.
|
* command line for Or1ksim standalone use: Standalone Simulator.
|
(line 6)
|
(line 6)
|
* complex model: Configuring the Build.
|
* complex model: Configuring the Build.
|
(line 37)
|
(line 37)
|
* config: Global Data Structures.
|
* config: Global Data Structures.
|
(line 7)
|
(line 7)
|
* config.bpb: Global Data Structures.
|
* config.bpb: Global Data Structures.
|
(line 37)
|
(line 37)
|
* config.cpu: Global Data Structures.
|
* config.cpu: Global Data Structures.
|
(line 22)
|
(line 22)
|
* config.cuc: Global Data Structures.
|
* config.cuc: Global Data Structures.
|
(line 18)
|
(line 18)
|
* config.dc: Global Data Structures.
|
* config.dc: Global Data Structures.
|
(line 25)
|
(line 25)
|
* config.debug: Global Data Structures.
|
* config.debug: Global Data Structures.
|
(line 40)
|
(line 40)
|
* config.pic: Global Data Structures.
|
* config.pic: Global Data Structures.
|
(line 33)
|
(line 33)
|
* config.pm: Global Data Structures.
|
* config.pm: Global Data Structures.
|
(line 29)
|
(line 29)
|
* config.sim: Global Data Structures.
|
* config.sim: Global Data Structures.
|
(line 11)
|
(line 11)
|
* config.vapi: Global Data Structures.
|
* config.vapi: Global Data Structures.
|
(line 14)
|
(line 14)
|
* configuration dynamic structure: Global Data Structures.
|
* configuration dynamic structure: Global Data Structures.
|
(line 49)
|
(line 49)
|
* configuration file structure: Configuration File Format.
|
* configuration file structure: Configuration File Format.
|
(line 6)
|
(line 6)
|
* configuration global structure: Global Data Structures.
|
* configuration global structure: Global Data Structures.
|
(line 7)
|
(line 7)
|
* configuration info (Interactive CLI): Interactive Command Line.
|
* configuration info (Interactive CLI): Interactive Command Line.
|
(line 119)
|
(line 119)
|
* configuration of generic peripherals: Generic Peripheral Configuration.
|
* configuration of generic peripherals: Generic Peripheral Configuration.
|
(line 6)
|
(line 6)
|
* configuration parameter setting (Interactive CLI): Interactive Command Line.
|
* configuration parameter setting (Interactive CLI): Interactive Command Line.
|
(line 146)
|
(line 146)
|
* configuring branch prediction: Branch Prediction Configuration.
|
* configuring branch prediction: Branch Prediction Configuration.
|
(line 6)
|
(line 6)
|
* configuring data & instruction caches: Cache Configuration. (line 6)
|
* configuring data & instruction caches: Cache Configuration. (line 6)
|
* configuring data & instruction MMUs: Memory Management Configuration.
|
* configuring data & instruction MMUs: Memory Management Configuration.
|
(line 6)
|
(line 6)
|
* configuring DMA: DMA Configuration. (line 6)
|
* configuring DMA: DMA Configuration. (line 6)
|
* configuring memory: Memory Configuration.
|
* configuring memory: Memory Configuration.
|
(line 6)
|
(line 6)
|
* configuring Or1ksim: Configuration. (line 6)
|
* configuring Or1ksim: Configuration. (line 6)
|
* configuring power management: Power Management Configuration.
|
* configuring power management: Power Management Configuration.
|
(line 6)
|
(line 6)
|
* configuring the ATA/ATAPI interfaces: Disc Interface Configuration.
|
* configuring the ATA/ATAPI interfaces: Disc Interface Configuration.
|
(line 6)
|
(line 6)
|
* configuring the behavior of Or1ksim: Simulator Behavior. (line 6)
|
* configuring the behavior of Or1ksim: Simulator Behavior. (line 6)
|
* configuring the CPU: CPU Configuration. (line 6)
|
* configuring the CPU: CPU Configuration. (line 6)
|
* configuring the Custom Unit Compiler (CUC): CUC Configuration.
|
* configuring the Custom Unit Compiler (CUC): CUC Configuration.
|
(line 6)
|
(line 6)
|
* configuring the debug unit and interface to external debuggers: Debug Interface Configuration.
|
* configuring the debug unit and interface to external debuggers: Debug Interface Configuration.
|
(line 6)
|
(line 6)
|
* configuring the Ethernet interface: Ethernet Configuration.
|
* configuring the Ethernet interface: Ethernet Configuration.
|
(line 6)
|
(line 6)
|
* configuring the frame buffer: Frame Buffer Configuration.
|
* configuring the frame buffer: Frame Buffer Configuration.
|
(line 6)
|
(line 6)
|
* configuring the GPIO: GPIO Configuration. (line 6)
|
* configuring the GPIO: GPIO Configuration. (line 6)
|
* configuring the interrupt controller: Interrupt Configuration.
|
* configuring the interrupt controller: Interrupt Configuration.
|
(line 6)
|
(line 6)
|
* configuring the keyboard interface: Keyboard Configuration.
|
* configuring the keyboard interface: Keyboard Configuration.
|
(line 6)
|
(line 6)
|
* configuring the memory controller: Memory Controller Configuration.
|
* configuring the memory controller: Memory Controller Configuration.
|
(line 6)
|
(line 6)
|
* configuring the processor: CPU Configuration. (line 6)
|
* configuring the processor: CPU Configuration. (line 6)
|
* configuring the PS2 interface: Keyboard Configuration.
|
* configuring the PS2 interface: Keyboard Configuration.
|
(line 6)
|
(line 6)
|
* configuring the UART: UART Configuration. (line 6)
|
* configuring the UART: UART Configuration. (line 6)
|
* configuring the Verification API (VAPI): Verification API Configuration.
|
* configuring the Verification API (VAPI): Verification API Configuration.
|
(line 6)
|
(line 6)
|
* configuring the VGA interface: Display Interface Configuration.
|
* configuring the VGA interface: Display Interface Configuration.
|
(line 6)
|
(line 6)
|
* copying memory (Interactive CLI): Interactive Command Line.
|
* copying memory (Interactive CLI): Interactive Command Line.
|
(line 54)
|
(line 54)
|
* CPU configuration: CPU Configuration. (line 6)
|
* CPU configuration: CPU Configuration. (line 6)
|
* CUC configuration: CUC Configuration. (line 6)
|
* CUC configuration: CUC Configuration. (line 6)
|
* Custom Unit Compiler (Interactive CLI): Interactive Command Line.
|
* Custom Unit Compiler (Interactive CLI): Interactive Command Line.
|
(line 162)
|
(line 162)
|
* Custom Unit Compiler Configuration: CUC Configuration. (line 6)
|
* Custom Unit Compiler Configuration: CUC Configuration. (line 6)
|
* data cache configuration: Cache Configuration. (line 6)
|
* data cache configuration: Cache Configuration. (line 6)
|
* data MMU configuration: Memory Management Configuration.
|
* data MMU configuration: Memory Management Configuration.
|
(line 6)
|
(line 6)
|
* DCGE (power management register): Power Management Configuration.
|
* DCGE (power management register): Power Management Configuration.
|
(line 21)
|
(line 21)
|
* debug (Interactive CLI): Interactive Command Line.
|
* debug (Interactive CLI): Interactive Command Line.
|
(line 151)
|
(line 151)
|
* debug (simulator configuration): Simulator Behavior. (line 13)
|
* debug (simulator configuration): Simulator Behavior. (line 13)
|
* debug channel toggle (Interactive CLI): Interactive Command Line.
|
* debug channel toggle (Interactive CLI): Interactive Command Line.
|
(line 141)
|
(line 141)
|
* debug interface configuration: Debug Interface Configuration.
|
* debug interface configuration: Debug Interface Configuration.
|
(line 6)
|
(line 6)
|
* debug mode toggle (Interactive CLI): Interactive Command Line.
|
* debug mode toggle (Interactive CLI): Interactive Command Line.
|
(line 151)
|
(line 151)
|
* debug unit configuration: Debug Interface Configuration.
|
* debug unit configuration: Debug Interface Configuration.
|
(line 6)
|
(line 6)
|
* Debug Unit verification (VAPI): Verification API. (line 34)
|
* Debug Unit verification (VAPI): Verification API. (line 34)
|
* debugging enabled (Argtable2): Configuring the Build.
|
* debugging enabled (Argtable2): Configuring the Build.
|
(line 98)
|
(line 98)
|
* DejaGnu board configurations: Regression Testing. (line 35)
|
* DejaGnu board configurations: Regression Testing. (line 35)
|
* DejaGnu configuration: Regression Testing. (line 21)
|
* DejaGnu configuration: Regression Testing. (line 21)
|
* DejaGNU tests directories: Regression Testing. (line 50)
|
* DejaGNU tests directories: Regression Testing. (line 50)
|
* DejaGnu tool specific configuration: Regression Testing. (line 39)
|
* DejaGnu tool specific configuration: Regression Testing. (line 39)
|
* delayr (memory configuration): Memory Configuration.
|
* delayr (memory configuration): Memory Configuration.
|
(line 144)
|
(line 144)
|
* delayw (memory configuration): Memory Configuration.
|
* delayw (memory configuration): Memory Configuration.
|
(line 150)
|
(line 150)
|
* dependstats (CPU configuration): CPU Configuration. (line 89)
|
* dependstats (CPU configuration): CPU Configuration. (line 89)
|
* dev_id (ATA/ATAPI configuration): Disc Interface Configuration.
|
* dev_id (ATA/ATAPI configuration): Disc Interface Configuration.
|
(line 40)
|
(line 40)
|
* disassemble (Interactive CLI): Interactive Command Line.
|
* disassemble (Interactive CLI): Interactive Command Line.
|
(line 41)
|
(line 41)
|
* disc interface configuration: Disc Interface Configuration.
|
* disc interface configuration: Disc Interface Configuration.
|
(line 6)
|
(line 6)
|
* disc interface device configuration: Disc Interface Configuration.
|
* disc interface device configuration: Disc Interface Configuration.
|
(line 92)
|
(line 92)
|
* display interface configuration: Display Interface Configuration.
|
* display interface configuration: Display Interface Configuration.
|
(line 6)
|
(line 6)
|
* displaying memory (Interactive CLI): Interactive Command Line.
|
* displaying memory (Interactive CLI): Interactive Command Line.
|
(line 31)
|
(line 31)
|
* displaying registers (Interactive CLI): Interactive Command Line.
|
* displaying registers (Interactive CLI): Interactive Command Line.
|
(line 14)
|
(line 14)
|
* dm (Interactive CLI): Interactive Command Line.
|
* dm (Interactive CLI): Interactive Command Line.
|
(line 31)
|
(line 31)
|
* dma (Ethernet configuration): Ethernet Configuration.
|
* dma (Ethernet configuration): Ethernet Configuration.
|
(line 33)
|
(line 33)
|
* DMA configuration: DMA Configuration. (line 6)
|
* DMA configuration: DMA Configuration. (line 6)
|
* DMA verification (VAPI): Verification API. (line 73)
|
* DMA verification (VAPI): Verification API. (line 73)
|
* dma_mode0_td (ATA/ATAPI configuration): Disc Interface Configuration.
|
* dma_mode0_td (ATA/ATAPI configuration): Disc Interface Configuration.
|
(line 74)
|
(line 74)
|
* dma_mode0_teoc (ATA/ATAPI configuration): Disc Interface Configuration.
|
* dma_mode0_teoc (ATA/ATAPI configuration): Disc Interface Configuration.
|
(line 75)
|
(line 75)
|
* dma_mode0_tm (ATA/ATAPI configuration): Disc Interface Configuration.
|
* dma_mode0_tm (ATA/ATAPI configuration): Disc Interface Configuration.
|
(line 73)
|
(line 73)
|
* DME (power management register): Power Management Configuration.
|
* DME (power management register): Power Management Configuration.
|
(line 15)
|
(line 15)
|
* DMMU configuration: Memory Management Configuration.
|
* DMMU configuration: Memory Management Configuration.
|
(line 6)
|
(line 6)
|
* doze mode (power management register): Power Management Configuration.
|
* doze mode (power management register): Power Management Configuration.
|
(line 15)
|
(line 15)
|
* dv (Interactive CLI): Interactive Command Line.
|
* dv (Interactive CLI): Interactive Command Line.
|
(line 124)
|
(line 124)
|
* dynamic clock gating (power management register): Power Management Configuration.
|
* dynamic clock gating (power management register): Power Management Configuration.
|
(line 21)
|
(line 21)
|
* dynamic model: Configuring the Build.
|
* dynamic model: Configuring the Build.
|
(line 37)
|
(line 37)
|
* dynamic ports, use of: Verification API Configuration.
|
* dynamic ports, use of: Verification API Configuration.
|
(line 23)
|
(line 23)
|
* edge_trigger (interrupt controller): Interrupt Configuration.
|
* edge_trigger (interrupt controller): Interrupt Configuration.
|
(line 16)
|
(line 16)
|
* enable_bursts (CUC configuration): CUC Configuration. (line 41)
|
* enable_bursts (CUC configuration): CUC Configuration. (line 41)
|
* enabled (ATA/ATAPI configuration): Disc Interface Configuration.
|
* enabled (ATA/ATAPI configuration): Disc Interface Configuration.
|
(line 22)
|
(line 22)
|
* enabled (branch prediction configuration): Branch Prediction Configuration.
|
* enabled (branch prediction configuration): Branch Prediction Configuration.
|
(line 15)
|
(line 15)
|
* enabled (cache configuration): Cache Configuration. (line 11)
|
* enabled (cache configuration): Cache Configuration. (line 11)
|
* enabled (debug interface configuration): Debug Interface Configuration.
|
* enabled (debug interface configuration): Debug Interface Configuration.
|
(line 11)
|
(line 11)
|
* enabled (DMA configuration): DMA Configuration. (line 20)
|
* enabled (DMA configuration): DMA Configuration. (line 20)
|
* enabled (Ethernet configuration): Ethernet Configuration.
|
* enabled (Ethernet configuration): Ethernet Configuration.
|
(line 18)
|
(line 18)
|
* enabled (frame buffer configuration): Frame Buffer Configuration.
|
* enabled (frame buffer configuration): Frame Buffer Configuration.
|
(line 16)
|
(line 16)
|
* enabled (generic peripheral configuration): Generic Peripheral Configuration.
|
* enabled (generic peripheral configuration): Generic Peripheral Configuration.
|
(line 18)
|
(line 18)
|
* enabled (GPIO configuration): GPIO Configuration. (line 17)
|
* enabled (GPIO configuration): GPIO Configuration. (line 17)
|
* enabled (interrupt controller): Interrupt Configuration.
|
* enabled (interrupt controller): Interrupt Configuration.
|
(line 12)
|
(line 12)
|
* enabled (keyboard configuration): Keyboard Configuration.
|
* enabled (keyboard configuration): Keyboard Configuration.
|
(line 32)
|
(line 32)
|
* enabled (memory controller configuration): Memory Controller Configuration.
|
* enabled (memory controller configuration): Memory Controller Configuration.
|
(line 44)
|
(line 44)
|
* enabled (MMU configuration): Memory Management Configuration.
|
* enabled (MMU configuration): Memory Management Configuration.
|
(line 12)
|
(line 12)
|
* enabled (power management configuration): Power Management Configuration.
|
* enabled (power management configuration): Power Management Configuration.
|
(line 35)
|
(line 35)
|
* enabled (UART configuration): UART Configuration. (line 18)
|
* enabled (UART configuration): UART Configuration. (line 18)
|
* enabled (verification API configuration): Verification API Configuration.
|
* enabled (verification API configuration): Verification API Configuration.
|
(line 15)
|
(line 15)
|
* enabled (VGA configuration): Display Interface Configuration.
|
* enabled (VGA configuration): Display Interface Configuration.
|
(line 22)
|
(line 22)
|
* enabling Ethernet via socket: Configuring the Build.
|
* enabling Ethernet via socket: Configuring the Build.
|
(line 59)
|
(line 59)
|
* entrysize (MMU configuration): Memory Management Configuration.
|
* entrysize (MMU configuration): Memory Management Configuration.
|
(line 32)
|
(line 32)
|
* ETH_VAPI_CTRL (Ethernet verification): Verification API. (line 86)
|
* ETH_VAPI_CTRL (Ethernet verification): Verification API. (line 86)
|
* ETH_VAPI_DATA (Ethernet verification): Verification API. (line 84)
|
* ETH_VAPI_DATA (Ethernet verification): Verification API. (line 84)
|
* Ethernet configuration: Ethernet Configuration.
|
* Ethernet configuration: Ethernet Configuration.
|
(line 6)
|
(line 6)
|
* Ethernet verification (VAPI): Verification API. (line 78)
|
* Ethernet verification (VAPI): Verification API. (line 78)
|
* Ethernet via socket, enabling: Configuring the Build.
|
* Ethernet via socket, enabling: Configuring the Build.
|
(line 59)
|
(line 59)
|
* exclusive-OR immediate operand: Configuring the Build.
|
* exclusive-OR immediate operand: Configuring the Build.
|
(line 69)
|
(line 69)
|
* exe_bin_insn_log (simulator configuration): Simulator Behavior.
|
* exe_bin_insn_log (simulator configuration): Simulator Behavior.
|
(line 103)
|
(line 103)
|
* exe_bin_insn_log_file (simulator configuration): Simulator Behavior.
|
* exe_bin_insn_log_file (simulator configuration): Simulator Behavior.
|
(line 111)
|
(line 111)
|
* exe_log (simulator configuration): Simulator Behavior. (line 49)
|
* exe_log (simulator configuration): Simulator Behavior. (line 49)
|
* exe_log_end (simulator configuration): Simulator Behavior. (line 89)
|
* exe_log_end (simulator configuration): Simulator Behavior. (line 89)
|
* exe_log_file (simulator configuration): Simulator Behavior. (line 97)
|
* exe_log_file (simulator configuration): Simulator Behavior. (line 97)
|
* exe_log_fn (simulator configuration - deprecated): Simulator Behavior.
|
* exe_log_fn (simulator configuration - deprecated): Simulator Behavior.
|
(line 97)
|
(line 97)
|
* exe_log_marker (simulator configuration): Simulator Behavior.
|
* exe_log_marker (simulator configuration): Simulator Behavior.
|
(line 93)
|
(line 93)
|
* exe_log_start (simulator configuration): Simulator Behavior.
|
* exe_log_start (simulator configuration): Simulator Behavior.
|
(line 86)
|
(line 86)
|
* exe_log_type (simulator configuration): Simulator Behavior. (line 55)
|
* exe_log_type (simulator configuration): Simulator Behavior. (line 55)
|
* exe_log_type=default (simulator configuration): Simulator Behavior.
|
* exe_log_type=default (simulator configuration): Simulator Behavior.
|
(line 58)
|
(line 58)
|
* exe_log_type=hardware (simulator configuration): Simulator Behavior.
|
* exe_log_type=hardware (simulator configuration): Simulator Behavior.
|
(line 62)
|
(line 62)
|
* exe_log_type=simple (simulator configuration): Simulator Behavior.
|
* exe_log_type=simple (simulator configuration): Simulator Behavior.
|
(line 69)
|
(line 69)
|
* exe_log_type=software (simulator configuration): Simulator Behavior.
|
* exe_log_type=software (simulator configuration): Simulator Behavior.
|
(line 74)
|
(line 74)
|
* executing code (Interactive CLI): Interactive Command Line.
|
* executing code (Interactive CLI): Interactive Command Line.
|
(line 23)
|
(line 23)
|
* execution history (Interactive CLI): Interactive Command Line.
|
* execution history (Interactive CLI): Interactive Command Line.
|
(line 67)
|
(line 67)
|
* file (ATA/ATAPI device configuration): Disc Interface Configuration.
|
* file (ATA/ATAPI device configuration): Disc Interface Configuration.
|
(line 108)
|
(line 108)
|
* file (keyboard configuration): Keyboard Configuration.
|
* file (keyboard configuration): Keyboard Configuration.
|
(line 51)
|
(line 51)
|
* filename (frame buffer configuration - deprecated): Frame Buffer Configuration.
|
* filename (frame buffer configuration - deprecated): Frame Buffer Configuration.
|
(line 36)
|
(line 36)
|
* filename (VGA configuration - deprecated): Display Interface Configuration.
|
* filename (VGA configuration - deprecated): Display Interface Configuration.
|
(line 47)
|
(line 47)
|
* firmware (ATA/ATAPI device configuration): Disc Interface Configuration.
|
* firmware (ATA/ATAPI device configuration): Disc Interface Configuration.
|
(line 121)
|
(line 121)
|
* flag setting by instructions: Configuring the Build.
|
* flag setting by instructions: Configuring the Build.
|
(line 118)
|
(line 118)
|
* frame buffer configuration: Frame Buffer Configuration.
|
* frame buffer configuration: Frame Buffer Configuration.
|
(line 6)
|
(line 6)
|
* generic peripheral configuration: Generic Peripheral Configuration.
|
* generic peripheral configuration: Generic Peripheral Configuration.
|
(line 6)
|
(line 6)
|
* GPIO configuration: GPIO Configuration. (line 6)
|
* GPIO configuration: GPIO Configuration. (line 6)
|
* GPIO verification (VAPI): Verification API. (line 88)
|
* GPIO verification (VAPI): Verification API. (line 88)
|
* GPIO_VAPI_AUX (GPIO verification): Verification API. (line 100)
|
* GPIO_VAPI_AUX (GPIO verification): Verification API. (line 100)
|
* GPIO_VAPI_CLOCK (GPIO verification): Verification API. (line 103)
|
* GPIO_VAPI_CLOCK (GPIO verification): Verification API. (line 103)
|
* GPIO_VAPI_CTRL (GPIO verification): Verification API. (line 119)
|
* GPIO_VAPI_CTRL (GPIO verification): Verification API. (line 119)
|
* GPIO_VAPI_DATA (GPIO verification): Verification API. (line 97)
|
* GPIO_VAPI_DATA (GPIO verification): Verification API. (line 97)
|
* GPIO_VAPI_INTE (GPIO verification): Verification API. (line 110)
|
* GPIO_VAPI_INTE (GPIO verification): Verification API. (line 110)
|
* GPIO_VAPI_PTRIG (GPIO verification): Verification API. (line 113)
|
* GPIO_VAPI_PTRIG (GPIO verification): Verification API. (line 113)
|
* GPIO_VAPI_RGPIO (GPIO verification): Verification API. (line 107)
|
* GPIO_VAPI_RGPIO (GPIO verification): Verification API. (line 107)
|
* hardfloat (CPU configuration): CPU Configuration. (line 110)
|
* hardfloat (CPU configuration): CPU Configuration. (line 110)
|
* hazards (CPU configuration): CPU Configuration. (line 74)
|
* hazards (CPU configuration): CPU Configuration. (line 74)
|
* heads (ATA/ATAPI device configuration): Disc Interface Configuration.
|
* heads (ATA/ATAPI device configuration): Disc Interface Configuration.
|
(line 125)
|
(line 125)
|
* help (Interactive CLI): Interactive Command Line.
|
* help (Interactive CLI): Interactive Command Line.
|
(line 170)
|
(line 170)
|
* hexadecimal memory dump (Interactive CLI): Interactive Command Line.
|
* hexadecimal memory dump (Interactive CLI): Interactive Command Line.
|
(line 133)
|
(line 133)
|
* hide_device_id (verification API configuration): Verification API Configuration.
|
* hide_device_id (verification API configuration): Verification API Configuration.
|
(line 36)
|
(line 36)
|
* hist (Interactive CLI): Interactive Command Line.
|
* hist (Interactive CLI): Interactive Command Line.
|
(line 67)
|
(line 67)
|
* history (simulator configuration): Simulator Behavior. (line 40)
|
* history (simulator configuration): Simulator Behavior. (line 40)
|
* history of execution (Interactive CLI): Interactive Command Line.
|
* history of execution (Interactive CLI): Interactive Command Line.
|
(line 67)
|
(line 67)
|
* hitdelay (branch prediction configuration): Branch Prediction Configuration.
|
* hitdelay (branch prediction configuration): Branch Prediction Configuration.
|
(line 33)
|
(line 33)
|
* hitdelay (instruction cache configuration): Cache Configuration.
|
* hitdelay (instruction cache configuration): Cache Configuration.
|
(line 38)
|
(line 38)
|
* hitdelay (MMU configuration): Memory Management Configuration.
|
* hitdelay (MMU configuration): Memory Management Configuration.
|
(line 51)
|
(line 51)
|
* host test code: Regression Testing. (line 57)
|
* host test code: Regression Testing. (line 57)
|
* hw_enabled (generic peripheral configuration): Generic Peripheral Configuration.
|
* hw_enabled (generic peripheral configuration): Generic Peripheral Configuration.
|
(line 49)
|
(line 49)
|
* IMMU configuration: Memory Management Configuration.
|
* IMMU configuration: Memory Management Configuration.
|
(line 6)
|
(line 6)
|
* index (memory controller configuration): Memory Controller Configuration.
|
* index (memory controller configuration): Memory Controller Configuration.
|
(line 77)
|
(line 77)
|
* info (Interactive CLI): Interactive Command Line.
|
* info (Interactive CLI): Interactive Command Line.
|
(line 119)
|
(line 119)
|
* installing Or1ksim: Installation. (line 6)
|
* installing Or1ksim: Installation. (line 6)
|
* instruction cache configuration: Cache Configuration. (line 6)
|
* instruction cache configuration: Cache Configuration. (line 6)
|
* instruction MMU configuration: Memory Management Configuration.
|
* instruction MMU configuration: Memory Management Configuration.
|
(line 6)
|
(line 6)
|
* instruction profiling for Or1ksim: Profiling Utility. (line 6)
|
* instruction profiling for Or1ksim: Profiling Utility. (line 6)
|
* instruction profiling utility (Interactive CLI): Interactive Command Line.
|
* instruction profiling utility (Interactive CLI): Interactive Command Line.
|
(line 178)
|
(line 178)
|
* internal debugging: Internal Debugging. (line 6)
|
* internal debugging: Internal Debugging. (line 6)
|
* interrupt controller configuration: Interrupt Configuration.
|
* interrupt controller configuration: Interrupt Configuration.
|
(line 6)
|
(line 6)
|
* irq (ATA/ATAPI configuration): Disc Interface Configuration.
|
* irq (ATA/ATAPI configuration): Disc Interface Configuration.
|
(line 36)
|
(line 36)
|
* irq (DMA configuration): DMA Configuration. (line 34)
|
* irq (DMA configuration): DMA Configuration. (line 34)
|
* irq (GPIO configuration): GPIO Configuration. (line 29)
|
* irq (GPIO configuration): GPIO Configuration. (line 29)
|
* irq (keyboard configuration): Keyboard Configuration.
|
* irq (keyboard configuration): Keyboard Configuration.
|
(line 47)
|
(line 47)
|
* irq (UART configuration): UART Configuration. (line 70)
|
* irq (UART configuration): UART Configuration. (line 70)
|
* irq (VGA configuration): Display Interface Configuration.
|
* irq (VGA configuration): Display Interface Configuration.
|
(line 37)
|
(line 37)
|
* jitter (UART configuration): UART Configuration. (line 78)
|
* jitter (UART configuration): UART Configuration. (line 78)
|
* keyboard configuration: Keyboard Configuration.
|
* keyboard configuration: Keyboard Configuration.
|
(line 6)
|
(line 6)
|
* library version of Or1ksim: Simulator Library. (line 6)
|
* library version of Or1ksim: Simulator Library. (line 6)
|
* license for Or1ksim: GNU Free Documentation License.
|
* license for Or1ksim: GNU Free Documentation License.
|
(line 6)
|
(line 6)
|
* list breakpoints (Interactive CLI): Interactive Command Line.
|
* list breakpoints (Interactive CLI): Interactive Command Line.
|
(line 60)
|
(line 60)
|
* load_hitdelay (data cache configuration): Cache Configuration.
|
* load_hitdelay (data cache configuration): Cache Configuration.
|
(line 46)
|
(line 46)
|
* load_missdelay (data cache configuration): Cache Configuration.
|
* load_missdelay (data cache configuration): Cache Configuration.
|
(line 50)
|
(line 50)
|
* log (memory configuration): Memory Configuration.
|
* log (memory configuration): Memory Configuration.
|
(line 156)
|
(line 156)
|
* log_enabled (verification API configuration): Verification API Configuration.
|
* log_enabled (verification API configuration): Verification API Configuration.
|
(line 28)
|
(line 28)
|
* long: Simulator Library. (line 95)
|
* long: Simulator Library. (line 95)
|
* make file for tests: Regression Testing. (line 27)
|
* make file for tests: Regression Testing. (line 27)
|
* mc (memory configuration): Memory Configuration.
|
* mc (memory configuration): Memory Configuration.
|
(line 133)
|
(line 133)
|
* memory configuration: Memory Configuration.
|
* memory configuration: Memory Configuration.
|
(line 6)
|
(line 6)
|
* memory controller configuration: Memory Controller Configuration.
|
* memory controller configuration: Memory Controller Configuration.
|
(line 6)
|
(line 6)
|
* memory copying (Interactive CLI): Interactive Command Line.
|
* memory copying (Interactive CLI): Interactive Command Line.
|
(line 54)
|
(line 54)
|
* memory display (Interactive CLI): Interactive Command Line.
|
* memory display (Interactive CLI): Interactive Command Line.
|
(line 31)
|
(line 31)
|
* memory dump, hexadecimal (Interactive CLI): Interactive Command Line.
|
* memory dump, hexadecimal (Interactive CLI): Interactive Command Line.
|
(line 133)
|
(line 133)
|
* memory dump, Verilog (Interactive CLI): Interactive Command Line.
|
* memory dump, Verilog (Interactive CLI): Interactive Command Line.
|
(line 124)
|
(line 124)
|
* memory patching (Interactive CLI): Interactive Command Line.
|
* memory patching (Interactive CLI): Interactive Command Line.
|
(line 48)
|
(line 48)
|
* memory profiling end address: Memory Profiling Utility.
|
* memory profiling end address: Memory Profiling Utility.
|
(line 56)
|
(line 56)
|
* memory profiling start address: Memory Profiling Utility.
|
* memory profiling start address: Memory Profiling Utility.
|
(line 56)
|
(line 56)
|
* memory profiling utility (Interactive CLI): Interactive Command Line.
|
* memory profiling utility (Interactive CLI): Interactive Command Line.
|
(line 173)
|
(line 173)
|
* memory profiling version of Or1ksim: Memory Profiling Utility.
|
* memory profiling version of Or1ksim: Memory Profiling Utility.
|
(line 6)
|
(line 6)
|
* memory_order (CUC configuration): CUC Configuration. (line 15)
|
* memory_order (CUC configuration): CUC Configuration. (line 15)
|
* memory_order=exact (CUC configuration): CUC Configuration. (line 30)
|
* memory_order=exact (CUC configuration): CUC Configuration. (line 30)
|
* memory_order=none (CUC configuration): CUC Configuration. (line 18)
|
* memory_order=none (CUC configuration): CUC Configuration. (line 18)
|
* memory_order=strong (CUC configuration): CUC Configuration. (line 27)
|
* memory_order=strong (CUC configuration): CUC Configuration. (line 27)
|
* memory_order=weak (CUC configuration): CUC Configuration. (line 22)
|
* memory_order=weak (CUC configuration): CUC Configuration. (line 22)
|
* missdelay (branch prediction configuration): Branch Prediction Configuration.
|
* missdelay (branch prediction configuration): Branch Prediction Configuration.
|
(line 37)
|
(line 37)
|
* missdelay (instruction cache configuration): Cache Configuration.
|
* missdelay (instruction cache configuration): Cache Configuration.
|
(line 42)
|
(line 42)
|
* missdelay (MMU configuration): Memory Management Configuration.
|
* missdelay (MMU configuration): Memory Management Configuration.
|
(line 55)
|
(line 55)
|
* MMU configuration: Memory Management Configuration.
|
* MMU configuration: Memory Management Configuration.
|
(line 6)
|
(line 6)
|
* mprof_file (simulator configuration): Simulator Behavior. (line 34)
|
* mprof_file (simulator configuration): Simulator Behavior. (line 34)
|
* mprof_fn (simulator configuration - deprecated): Simulator Behavior.
|
* mprof_fn (simulator configuration - deprecated): Simulator Behavior.
|
(line 34)
|
(line 34)
|
* mprofile (Interactive CLI): Interactive Command Line.
|
* mprofile (Interactive CLI): Interactive Command Line.
|
(line 173)
|
(line 173)
|
* mprofile (simulator configuration): Simulator Behavior. (line 29)
|
* mprofile (simulator configuration): Simulator Behavior. (line 29)
|
* mwdma (ATA/ATAPI device configuration): Disc Interface Configuration.
|
* mwdma (ATA/ATAPI device configuration): Disc Interface Configuration.
|
(line 132)
|
(line 132)
|
* name (generic peripheral configuration): Generic Peripheral Configuration.
|
* name (generic peripheral configuration): Generic Peripheral Configuration.
|
(line 42)
|
(line 42)
|
* name (memory configuration): Memory Configuration.
|
* name (memory configuration): Memory Configuration.
|
(line 115)
|
(line 115)
|
* no_multicycle (CUC configuration): CUC Configuration. (line 45)
|
* no_multicycle (CUC configuration): CUC Configuration. (line 45)
|
* nsets (cache configuration): Cache Configuration. (line 15)
|
* nsets (cache configuration): Cache Configuration. (line 15)
|
* nsets (MMU configuration): Memory Management Configuration.
|
* nsets (MMU configuration): Memory Management Configuration.
|
(line 16)
|
(line 16)
|
* nways (cache configuration): Cache Configuration. (line 22)
|
* nways (cache configuration): Cache Configuration. (line 22)
|
* nways (MMU configuration): Memory Management Configuration.
|
* nways (MMU configuration): Memory Management Configuration.
|
(line 22)
|
(line 22)
|
* or1ksim_get_time_period: Simulator Library. (line 85)
|
* or1ksim_get_time_period: Simulator Library. (line 85)
|
* or1ksim_init: Simulator Library. (line 15)
|
* or1ksim_init: Simulator Library. (line 15)
|
* or1ksim_interrupt: Simulator Library. (line 100)
|
* or1ksim_interrupt: Simulator Library. (line 100)
|
* or1ksim_interrupt_clear: Simulator Library. (line 118)
|
* or1ksim_interrupt_clear: Simulator Library. (line 118)
|
* or1ksim_interrupt_set: Simulator Library. (line 109)
|
* or1ksim_interrupt_set: Simulator Library. (line 109)
|
* or1ksim_is_le: Simulator Library. (line 90)
|
* or1ksim_is_le: Simulator Library. (line 90)
|
* or1ksim_jtag_reset: Simulator Library. (line 127)
|
* or1ksim_jtag_reset: Simulator Library. (line 127)
|
* or1ksim_jtag_shift_dr: Simulator Library. (line 149)
|
* or1ksim_jtag_shift_dr: Simulator Library. (line 149)
|
* or1ksim_jtag_shift_ir: Simulator Library. (line 135)
|
* or1ksim_jtag_shift_ir: Simulator Library. (line 135)
|
* or1ksim_read_mem: Simulator Library. (line 163)
|
* or1ksim_read_mem: Simulator Library. (line 163)
|
* or1ksim_read_reg: Simulator Library. (line 199)
|
* or1ksim_read_reg: Simulator Library. (line 199)
|
* or1ksim_read_spr: Simulator Library. (line 181)
|
* or1ksim_read_spr: Simulator Library. (line 181)
|
* or1ksim_reset_duration: Simulator Library. (line 70)
|
* or1ksim_reset_duration: Simulator Library. (line 70)
|
* or1ksim_run: Simulator Library. (line 59)
|
* or1ksim_run: Simulator Library. (line 59)
|
* or1ksim_set_stall_state: Simulator Library. (line 217)
|
* or1ksim_set_stall_state: Simulator Library. (line 217)
|
* or1ksim_set_time_point: Simulator Library. (line 81)
|
* or1ksim_set_time_point: Simulator Library. (line 81)
|
* or1ksim_write_mem: Simulator Library. (line 172)
|
* or1ksim_write_mem: Simulator Library. (line 172)
|
* or1ksim_write_reg: Simulator Library. (line 208)
|
* or1ksim_write_reg: Simulator Library. (line 208)
|
* or1ksim_write_spr: Simulator Library. (line 190)
|
* or1ksim_write_spr: Simulator Library. (line 190)
|
* output rediretion: Concepts. (line 7)
|
* output rediretion: Concepts. (line 7)
|
* overflow flag setting by instructions: Configuring the Build.
|
* overflow flag setting by instructions: Configuring the Build.
|
(line 133)
|
(line 133)
|
* packet (ATA/ATAPI device configuration): Disc Interface Configuration.
|
* packet (ATA/ATAPI device configuration): Disc Interface Configuration.
|
(line 117)
|
(line 117)
|
* pagesize (MMU configuration): Memory Management Configuration.
|
* pagesize (MMU configuration): Memory Management Configuration.
|
(line 27)
|
(line 27)
|
* patching memory (Interactive CLI): Interactive Command Line.
|
* patching memory (Interactive CLI): Interactive Command Line.
|
(line 48)
|
(line 48)
|
* patching registers (Interactive CLI): Interactive Command Line.
|
* patching registers (Interactive CLI): Interactive Command Line.
|
(line 28)
|
(line 28)
|
* patching the program counter (Interactive CLI): Interactive Command Line.
|
* patching the program counter (Interactive CLI): Interactive Command Line.
|
(line 51)
|
(line 51)
|
* pattern (memory configuration): Memory Configuration.
|
* pattern (memory configuration): Memory Configuration.
|
(line 82)
|
(line 82)
|
* pc (Interactive CLI): Interactive Command Line.
|
* pc (Interactive CLI): Interactive Command Line.
|
(line 51)
|
(line 51)
|
* phy_addr: Ethernet Configuration.
|
* phy_addr: Ethernet Configuration.
|
(line 94)
|
(line 94)
|
* PIC configuration: Interrupt Configuration.
|
* PIC configuration: Interrupt Configuration.
|
(line 6)
|
(line 6)
|
* pio (ATA/ATAPI device configuration): Disc Interface Configuration.
|
* pio (ATA/ATAPI device configuration): Disc Interface Configuration.
|
(line 136)
|
(line 136)
|
* pio_mode0_t1 (ATA/ATAPI configuration): Disc Interface Configuration.
|
* pio_mode0_t1 (ATA/ATAPI configuration): Disc Interface Configuration.
|
(line 55)
|
(line 55)
|
* pio_mode0_t2 (ATA/ATAPI configuration): Disc Interface Configuration.
|
* pio_mode0_t2 (ATA/ATAPI configuration): Disc Interface Configuration.
|
(line 56)
|
(line 56)
|
* pio_mode0_t4 (ATA/ATAPI configuration): Disc Interface Configuration.
|
* pio_mode0_t4 (ATA/ATAPI configuration): Disc Interface Configuration.
|
(line 57)
|
(line 57)
|
* pio_mode0_teoc (ATA/ATAPI configuration): Disc Interface Configuration.
|
* pio_mode0_teoc (ATA/ATAPI configuration): Disc Interface Configuration.
|
(line 58)
|
(line 58)
|
* pm (Interactive CLI): Interactive Command Line.
|
* pm (Interactive CLI): Interactive Command Line.
|
(line 48)
|
(line 48)
|
* PMR - DGCE: Power Management Configuration.
|
* PMR - DGCE: Power Management Configuration.
|
(line 21)
|
(line 21)
|
* PMR - DME: Power Management Configuration.
|
* PMR - DME: Power Management Configuration.
|
(line 15)
|
(line 15)
|
* PMR - SDF: Power Management Configuration.
|
* PMR - SDF: Power Management Configuration.
|
(line 12)
|
(line 12)
|
* PMR - SME: Power Management Configuration.
|
* PMR - SME: Power Management Configuration.
|
(line 16)
|
(line 16)
|
* PMR - SUME: Power Management Configuration.
|
* PMR - SUME: Power Management Configuration.
|
(line 24)
|
(line 24)
|
* PMU configuration: Power Management Configuration.
|
* PMU configuration: Power Management Configuration.
|
(line 6)
|
(line 6)
|
* poc (memory controller configuration): Memory Controller Configuration.
|
* poc (memory controller configuration): Memory Controller Configuration.
|
(line 64)
|
(line 64)
|
* port range for TCP/IP: Verification API Configuration.
|
* port range for TCP/IP: Verification API Configuration.
|
(line 23)
|
(line 23)
|
* power management configuration: Power Management Configuration.
|
* power management configuration: Power Management Configuration.
|
(line 6)
|
(line 6)
|
* power management register, DGCE: Power Management Configuration.
|
* power management register, DGCE: Power Management Configuration.
|
(line 21)
|
(line 21)
|
* power management register, DME: Power Management Configuration.
|
* power management register, DME: Power Management Configuration.
|
(line 15)
|
(line 15)
|
* power management register, SDF: Power Management Configuration.
|
* power management register, SDF: Power Management Configuration.
|
(line 12)
|
(line 12)
|
* power management register, SME: Power Management Configuration.
|
* power management register, SME: Power Management Configuration.
|
(line 16)
|
(line 16)
|
* power management register, SUME: Power Management Configuration.
|
* power management register, SUME: Power Management Configuration.
|
(line 24)
|
(line 24)
|
* pr (Interactive CLI): Interactive Command Line.
|
* pr (Interactive CLI): Interactive Command Line.
|
(line 28)
|
(line 28)
|
* private ports, use of: Verification API Configuration.
|
* private ports, use of: Verification API Configuration.
|
(line 23)
|
(line 23)
|
* processor configuration: CPU Configuration. (line 6)
|
* processor configuration: CPU Configuration. (line 6)
|
* processor stall (Interactive CLI): Interactive Command Line.
|
* processor stall (Interactive CLI): Interactive Command Line.
|
(line 72)
|
(line 72)
|
* processor unstall (Interactive CLI): Interactive Command Line.
|
* processor unstall (Interactive CLI): Interactive Command Line.
|
(line 78)
|
(line 78)
|
* prof_file (simulator configuration): Simulator Behavior. (line 23)
|
* prof_file (simulator configuration): Simulator Behavior. (line 23)
|
* prof_fn (simulator configuration - deprecated): Simulator Behavior.
|
* prof_fn (simulator configuration - deprecated): Simulator Behavior.
|
(line 23)
|
(line 23)
|
* profile (simulator configuration): Simulator Behavior. (line 19)
|
* profile (simulator configuration): Simulator Behavior. (line 19)
|
* profiling for Or1ksim: Profiling Utility. (line 6)
|
* profiling for Or1ksim: Profiling Utility. (line 6)
|
* profiling utility (Interactive CLI): Interactive Command Line.
|
* profiling utility (Interactive CLI): Interactive Command Line.
|
(line 178)
|
(line 178)
|
* program counter patching (Interactive CLI): Interactive Command Line.
|
* program counter patching (Interactive CLI): Interactive Command Line.
|
(line 51)
|
(line 51)
|
* programmable interrupt controller configuration: Interrupt Configuration.
|
* programmable interrupt controller configuration: Interrupt Configuration.
|
(line 6)
|
(line 6)
|
* PS2 configuration: Keyboard Configuration.
|
* PS2 configuration: Keyboard Configuration.
|
(line 6)
|
(line 6)
|
* q (Interactive CLI): Interactive Command Line.
|
* q (Interactive CLI): Interactive Command Line.
|
(line 11)
|
(line 11)
|
* quitting (Interactive CLI): Interactive Command Line.
|
* quitting (Interactive CLI): Interactive Command Line.
|
(line 11)
|
(line 11)
|
* r (Interactive CLI): Interactive Command Line.
|
* r (Interactive CLI): Interactive Command Line.
|
(line 14)
|
(line 14)
|
* random_seed (memory configuration): Memory Configuration.
|
* random_seed (memory configuration): Memory Configuration.
|
(line 72)
|
(line 72)
|
* refresh_rate (frame buffer configuration): Frame Buffer Configuration.
|
* refresh_rate (frame buffer configuration): Frame Buffer Configuration.
|
(line 30)
|
(line 30)
|
* refresh_rate (VGA configuration): Display Interface Configuration.
|
* refresh_rate (VGA configuration): Display Interface Configuration.
|
(line 41)
|
(line 41)
|
* reg_sim_reset: Concepts. (line 13)
|
* reg_sim_reset: Concepts. (line 13)
|
* register display (Interactive CLI): Interactive Command Line.
|
* register display (Interactive CLI): Interactive Command Line.
|
(line 14)
|
(line 14)
|
* register over time statistics: Configuring the Build.
|
* register over time statistics: Configuring the Build.
|
(line 92)
|
(line 92)
|
* register patching (Interactive CLI): Interactive Command Line.
|
* register patching (Interactive CLI): Interactive Command Line.
|
(line 28)
|
(line 28)
|
* regression testing: Regression Testing. (line 6)
|
* regression testing: Regression Testing. (line 6)
|
* Remote Serial Protocol: Debug Interface Configuration.
|
* Remote Serial Protocol: Debug Interface Configuration.
|
(line 20)
|
(line 20)
|
* Remote Serial Protocol, --nosrv: Standalone Simulator.
|
* Remote Serial Protocol, --nosrv: Standalone Simulator.
|
(line 52)
|
(line 52)
|
* Remote Serial Protocol, --srv: Standalone Simulator.
|
* Remote Serial Protocol, --srv: Standalone Simulator.
|
(line 60)
|
(line 60)
|
* reset (Interactive CLI): Interactive Command Line.
|
* reset (Interactive CLI): Interactive Command Line.
|
(line 63)
|
(line 63)
|
* reset hooks: Concepts. (line 13)
|
* reset hooks: Concepts. (line 13)
|
* reset the simulator (Interactive CLI): Interactive Command Line.
|
* reset the simulator (Interactive CLI): Interactive Command Line.
|
(line 63)
|
(line 63)
|
* rev (ATA/ATAPI configuration): Disc Interface Configuration.
|
* rev (ATA/ATAPI configuration): Disc Interface Configuration.
|
(line 48)
|
(line 48)
|
* rev (CPU configuration): CPU Configuration. (line 15)
|
* rev (CPU configuration): CPU Configuration. (line 15)
|
* rsp_enabled (debug interface configuration): Debug Interface Configuration.
|
* rsp_enabled (debug interface configuration): Debug Interface Configuration.
|
(line 20)
|
(line 20)
|
* rsp_port (debug interface configuration): Debug Interface Configuration.
|
* rsp_port (debug interface configuration): Debug Interface Configuration.
|
(line 32)
|
(line 32)
|
* rtx_type (Ethernet configuration): Ethernet Configuration.
|
* rtx_type (Ethernet configuration): Ethernet Configuration.
|
(line 46)
|
(line 46)
|
* run (Interactive CLI): Interactive Command Line.
|
* run (Interactive CLI): Interactive Command Line.
|
(line 23)
|
(line 23)
|
* running code (Interactive CLI): Interactive Command Line.
|
* running code (Interactive CLI): Interactive Command Line.
|
(line 23)
|
(line 23)
|
* running Or1ksim: Usage. (line 6)
|
* running Or1ksim: Usage. (line 6)
|
* runtime: Global Data Structures.
|
* runtime: Global Data Structures.
|
(line 58)
|
(line 58)
|
* runtime global structure: Global Data Structures.
|
* runtime global structure: Global Data Structures.
|
(line 58)
|
(line 58)
|
* runtime.cpu: Global Data Structures.
|
* runtime.cpu: Global Data Structures.
|
(line 62)
|
(line 62)
|
* runtime.cpu.fout: Concepts. (line 7)
|
* runtime.cpu.fout: Concepts. (line 7)
|
* runtime.cuc: Global Data Structures.
|
* runtime.cuc: Global Data Structures.
|
(line 62)
|
(line 62)
|
* runtime.vapi: Global Data Structures.
|
* runtime.vapi: Global Data Structures.
|
(line 62)
|
(line 62)
|
* rx_channel (Ethernet configuration): Ethernet Configuration.
|
* rx_channel (Ethernet configuration): Ethernet Configuration.
|
(line 59)
|
(line 59)
|
* rxfile (Ethernet configuration): Ethernet Configuration.
|
* rxfile (Ethernet configuration): Ethernet Configuration.
|
(line 68)
|
(line 68)
|
* sbp_bf_fwd (branch prediction configuration): Branch Prediction Configuration.
|
* sbp_bf_fwd (branch prediction configuration): Branch Prediction Configuration.
|
(line 23)
|
(line 23)
|
* sbp_bnf_fwd (branch prediction configuration): Branch Prediction Configuration.
|
* sbp_bnf_fwd (branch prediction configuration): Branch Prediction Configuration.
|
(line 28)
|
(line 28)
|
* sbuf_len (CPU configuration): CPU Configuration. (line 101)
|
* sbuf_len (CPU configuration): CPU Configuration. (line 101)
|
* SDF (power management register): Power Management Configuration.
|
* SDF (power management register): Power Management Configuration.
|
(line 12)
|
(line 12)
|
* section ata: Disc Interface Configuration.
|
* section ata: Disc Interface Configuration.
|
(line 6)
|
(line 6)
|
* section bpb: Branch Prediction Configuration.
|
* section bpb: Branch Prediction Configuration.
|
(line 6)
|
(line 6)
|
* section cpio: GPIO Configuration. (line 6)
|
* section cpio: GPIO Configuration. (line 6)
|
* section cpu: CPU Configuration. (line 6)
|
* section cpu: CPU Configuration. (line 6)
|
* section cuc: CUC Configuration. (line 6)
|
* section cuc: CUC Configuration. (line 6)
|
* section dc: Cache Configuration. (line 6)
|
* section dc: Cache Configuration. (line 6)
|
* section debug: Debug Interface Configuration.
|
* section debug: Debug Interface Configuration.
|
(line 6)
|
(line 6)
|
* section dma: DMA Configuration. (line 6)
|
* section dma: DMA Configuration. (line 6)
|
* section dmmu: Memory Management Configuration.
|
* section dmmu: Memory Management Configuration.
|
(line 6)
|
(line 6)
|
* section ethernet: Ethernet Configuration.
|
* section ethernet: Ethernet Configuration.
|
(line 6)
|
(line 6)
|
* section fb: Frame Buffer Configuration.
|
* section fb: Frame Buffer Configuration.
|
(line 6)
|
(line 6)
|
* section generic: Generic Peripheral Configuration.
|
* section generic: Generic Peripheral Configuration.
|
(line 6)
|
(line 6)
|
* section ic: Cache Configuration. (line 6)
|
* section ic: Cache Configuration. (line 6)
|
* section immu: Memory Management Configuration.
|
* section immu: Memory Management Configuration.
|
(line 6)
|
(line 6)
|
* section kb: Keyboard Configuration.
|
* section kb: Keyboard Configuration.
|
(line 6)
|
(line 6)
|
* section mc: Memory Controller Configuration.
|
* section mc: Memory Controller Configuration.
|
(line 6)
|
(line 6)
|
* section memory: Memory Configuration.
|
* section memory: Memory Configuration.
|
(line 6)
|
(line 6)
|
* section pic: Interrupt Configuration.
|
* section pic: Interrupt Configuration.
|
(line 6)
|
(line 6)
|
* section pmu: Power Management Configuration.
|
* section pmu: Power Management Configuration.
|
(line 6)
|
(line 6)
|
* section sim: Simulator Behavior. (line 6)
|
* section sim: Simulator Behavior. (line 6)
|
* section uart: UART Configuration. (line 6)
|
* section uart: UART Configuration. (line 6)
|
* section vapi: Verification API Configuration.
|
* section vapi: Verification API Configuration.
|
(line 6)
|
(line 6)
|
* section vga: Display Interface Configuration.
|
* section vga: Display Interface Configuration.
|
(line 6)
|
(line 6)
|
* sections: Global Data Structures.
|
* sections: Global Data Structures.
|
(line 49)
|
(line 49)
|
* sectors (ATA/ATAPI device configuration): Disc Interface Configuration.
|
* sectors (ATA/ATAPI device configuration): Disc Interface Configuration.
|
(line 129)
|
(line 129)
|
* server_port (verification API configuration): Verification API Configuration.
|
* server_port (verification API configuration): Verification API Configuration.
|
(line 19)
|
(line 19)
|
* set (Interactive CLI): Interactive Command Line.
|
* set (Interactive CLI): Interactive Command Line.
|
(line 146)
|
(line 146)
|
* set breakpoint (Interactive CLI): Interactive Command Line.
|
* set breakpoint (Interactive CLI): Interactive Command Line.
|
(line 57)
|
(line 57)
|
* setdbch (Interactive CLI): Interactive Command Line.
|
* setdbch (Interactive CLI): Interactive Command Line.
|
(line 141)
|
(line 141)
|
* simple model: Configuring the Build.
|
* simple model: Configuring the Build.
|
(line 37)
|
(line 37)
|
* simulator configuration: Simulator Behavior. (line 6)
|
* simulator configuration: Simulator Behavior. (line 6)
|
* simulator configuration info (Interactive CLI): Interactive Command Line.
|
* simulator configuration info (Interactive CLI): Interactive Command Line.
|
(line 119)
|
(line 119)
|
* simulator reset (Interactive CLI): Interactive Command Line.
|
* simulator reset (Interactive CLI): Interactive Command Line.
|
(line 63)
|
(line 63)
|
* simulator statistics (Interactive CLI): Interactive Command Line.
|
* simulator statistics (Interactive CLI): Interactive Command Line.
|
(line 83)
|
(line 83)
|
* size (ATA/ATAPI device configuration): Disc Interface Configuration.
|
* size (ATA/ATAPI device configuration): Disc Interface Configuration.
|
(line 113)
|
(line 113)
|
* size (generic peripheral configuration): Generic Peripheral Configuration.
|
* size (generic peripheral configuration): Generic Peripheral Configuration.
|
(line 30)
|
(line 30)
|
* size (memory configuration): Memory Configuration.
|
* size (memory configuration): Memory Configuration.
|
(line 99)
|
(line 99)
|
* sleep mode (power management register): Power Management Configuration.
|
* sleep mode (power management register): Power Management Configuration.
|
(line 16)
|
(line 16)
|
* slow down factor (power management register): Power Management Configuration.
|
* slow down factor (power management register): Power Management Configuration.
|
(line 12)
|
(line 12)
|
* SME (power management register): Power Management Configuration.
|
* SME (power management register): Power Management Configuration.
|
(line 16)
|
(line 16)
|
* sockif (Ethernet configuration): Ethernet Configuration.
|
* sockif (Ethernet configuration): Ethernet Configuration.
|
(line 83)
|
(line 83)
|
* sr (CPU configuration): CPU Configuration. (line 53)
|
* sr (CPU configuration): CPU Configuration. (line 53)
|
* stall (Interactive CLI): Interactive Command Line.
|
* stall (Interactive CLI): Interactive Command Line.
|
(line 72)
|
(line 72)
|
* stall the processor (Interactive CLI): Interactive Command Line.
|
* stall the processor (Interactive CLI): Interactive Command Line.
|
(line 72)
|
(line 72)
|
* statistics, register over time: Configuring the Build.
|
* statistics, register over time: Configuring the Build.
|
(line 92)
|
(line 92)
|
* statistics, simulation (Interactive CLI): Interactive Command Line.
|
* statistics, simulation (Interactive CLI): Interactive Command Line.
|
(line 83)
|
(line 83)
|
* stats (Interactive CLI): Interactive Command Line.
|
* stats (Interactive CLI): Interactive Command Line.
|
(line 83)
|
(line 83)
|
* stepping code (Interactive CLI): Interactive Command Line.
|
* stepping code (Interactive CLI): Interactive Command Line.
|
(line 19)
|
(line 19)
|
* store_hitdelay (data cache configuration): Cache Configuration.
|
* store_hitdelay (data cache configuration): Cache Configuration.
|
(line 54)
|
(line 54)
|
* store_missdelay (data cache configuration): Cache Configuration.
|
* store_missdelay (data cache configuration): Cache Configuration.
|
(line 58)
|
(line 58)
|
* SUME (power management register): Power Management Configuration.
|
* SUME (power management register): Power Management Configuration.
|
(line 24)
|
(line 24)
|
* superscalar (CPU configuration): CPU Configuration. (line 63)
|
* superscalar (CPU configuration): CPU Configuration. (line 63)
|
* suspend mode (power management register): Power Management Configuration.
|
* suspend mode (power management register): Power Management Configuration.
|
(line 24)
|
(line 24)
|
* t (Interactive CLI): Interactive Command Line.
|
* t (Interactive CLI): Interactive Command Line.
|
(line 19)
|
(line 19)
|
* target test code: Regression Testing. (line 63)
|
* target test code: Regression Testing. (line 63)
|
* TCP/IP port range: Verification API Configuration.
|
* TCP/IP port range: Verification API Configuration.
|
(line 23)
|
(line 23)
|
* TCP/IP port range for or1ksim-rsp service: Debug Interface Configuration.
|
* TCP/IP port range for or1ksim-rsp service: Debug Interface Configuration.
|
(line 37)
|
(line 37)
|
* test code for host: Regression Testing. (line 57)
|
* test code for host: Regression Testing. (line 57)
|
* test code for target: Regression Testing. (line 63)
|
* test code for target: Regression Testing. (line 63)
|
* test make file: Regression Testing. (line 27)
|
* test make file: Regression Testing. (line 27)
|
* test README: Regression Testing. (line 32)
|
* test README: Regression Testing. (line 32)
|
* testing: Regression Testing. (line 6)
|
* testing: Regression Testing. (line 6)
|
* tests, all enabled.: Configuring the Build.
|
* tests, all enabled.: Configuring the Build.
|
(line 105)
|
(line 105)
|
* timings_file (CUC configuration): CUC Configuration. (line 49)
|
* timings_file (CUC configuration): CUC Configuration. (line 49)
|
* timings_fn (CUC configuration - deprecated): CUC Configuration.
|
* timings_fn (CUC configuration - deprecated): CUC Configuration.
|
(line 49)
|
(line 49)
|
* toggle breakpoint (Interactive CLI): Interactive Command Line.
|
* toggle breakpoint (Interactive CLI): Interactive Command Line.
|
(line 57)
|
(line 57)
|
* toggle debug channels (Interactive CLI): Interactive Command Line.
|
* toggle debug channels (Interactive CLI): Interactive Command Line.
|
(line 141)
|
(line 141)
|
* toggle debug mode (Interactive CLI): Interactive Command Line.
|
* toggle debug mode (Interactive CLI): Interactive Command Line.
|
(line 151)
|
(line 151)
|
* tx_channel (Ethernet configuration): Ethernet Configuration.
|
* tx_channel (Ethernet configuration): Ethernet Configuration.
|
(line 60)
|
(line 60)
|
* txfile (Ethernet configuration): Ethernet Configuration.
|
* txfile (Ethernet configuration): Ethernet Configuration.
|
(line 69)
|
(line 69)
|
* txfile (frame buffer configuration): Frame Buffer Configuration.
|
* txfile (frame buffer configuration): Frame Buffer Configuration.
|
(line 36)
|
(line 36)
|
* txfile (VGA configuration): Display Interface Configuration.
|
* txfile (VGA configuration): Display Interface Configuration.
|
(line 47)
|
(line 47)
|
* type (ATA/ATAPI device configuration): Disc Interface Configuration.
|
* type (ATA/ATAPI device configuration): Disc Interface Configuration.
|
(line 103)
|
(line 103)
|
* type (memory configuration): Memory Configuration.
|
* type (memory configuration): Memory Configuration.
|
(line 37)
|
(line 37)
|
* type=exitnops (memory configuration): Memory Configuration.
|
* type=exitnops (memory configuration): Memory Configuration.
|
(line 66)
|
(line 66)
|
* type=pattern (memory configuration): Memory Configuration.
|
* type=pattern (memory configuration): Memory Configuration.
|
(line 47)
|
(line 47)
|
* type=random (memory configuration): Memory Configuration.
|
* type=random (memory configuration): Memory Configuration.
|
(line 41)
|
(line 41)
|
* type=unknown (memory configuration): Memory Configuration.
|
* type=unknown (memory configuration): Memory Configuration.
|
(line 51)
|
(line 51)
|
* type=zero (memory configuration): Memory Configuration.
|
* type=zero (memory configuration): Memory Configuration.
|
(line 56)
|
(line 56)
|
* UART configuration: UART Configuration. (line 6)
|
* UART configuration: UART Configuration. (line 6)
|
* UART I/O from/to a physical serial port: UART Configuration.
|
* UART I/O from/to a physical serial port: UART Configuration.
|
(line 62)
|
(line 62)
|
* UART I/O from/to an xterm: UART Configuration. (line 38)
|
* UART I/O from/to an xterm: UART Configuration. (line 38)
|
* UART I/O from/to files: UART Configuration. (line 33)
|
* UART I/O from/to files: UART Configuration. (line 33)
|
* UART I/O from/to open file descriptors: UART Configuration. (line 58)
|
* UART I/O from/to open file descriptors: UART Configuration. (line 58)
|
* UART I/O from/to TCP/IP: UART Configuration. (line 45)
|
* UART I/O from/to TCP/IP: UART Configuration. (line 45)
|
* UART verification (VAPI): Verification API. (line 41)
|
* UART verification (VAPI): Verification API. (line 41)
|
* unstall (Interactive CLI): Interactive Command Line.
|
* unstall (Interactive CLI): Interactive Command Line.
|
(line 78)
|
(line 78)
|
* unstall the processor (Interactive CLI): Interactive Command Line.
|
* unstall the processor (Interactive CLI): Interactive Command Line.
|
(line 78)
|
(line 78)
|
* upr (CPU configuration): CPU Configuration. (line 21)
|
* upr (CPU configuration): CPU Configuration. (line 21)
|
* ustates (cache configuration): Cache Configuration. (line 33)
|
* ustates (cache configuration): Cache Configuration. (line 33)
|
* ustates (MMU configuration): Memory Management Configuration.
|
* ustates (MMU configuration): Memory Management Configuration.
|
(line 41)
|
(line 41)
|
* VAPI configuration: Verification API Configuration.
|
* VAPI configuration: Verification API Configuration.
|
(line 6)
|
(line 6)
|
* VAPI for Debug Unit: Verification API. (line 34)
|
* VAPI for Debug Unit: Verification API. (line 34)
|
* VAPI for DMA: Verification API. (line 73)
|
* VAPI for DMA: Verification API. (line 73)
|
* VAPI for Ethernet: Verification API. (line 78)
|
* VAPI for Ethernet: Verification API. (line 78)
|
* VAPI for GPIO: Verification API. (line 88)
|
* VAPI for GPIO: Verification API. (line 88)
|
* VAPI for UART: Verification API. (line 41)
|
* VAPI for UART: Verification API. (line 41)
|
* vapi_id (debug interface configuration): Debug Interface Configuration.
|
* vapi_id (debug interface configuration): Debug Interface Configuration.
|
(line 43)
|
(line 43)
|
* vapi_id (DMA configuration) <1>: Ethernet Configuration.
|
* vapi_id (DMA configuration) <1>: Ethernet Configuration.
|
(line 88)
|
(line 88)
|
* vapi_id (DMA configuration): DMA Configuration. (line 38)
|
* vapi_id (DMA configuration): DMA Configuration. (line 38)
|
* vapi_id (GPIO configuration): GPIO Configuration. (line 32)
|
* vapi_id (GPIO configuration): GPIO Configuration. (line 32)
|
* vapi_id (UART configuration): UART Configuration. (line 85)
|
* vapi_id (UART configuration): UART Configuration. (line 85)
|
* vapi_log_file (verification API configuration): Verification API Configuration.
|
* vapi_log_file (verification API configuration): Verification API Configuration.
|
(line 41)
|
(line 41)
|
* vapi_log_fn (verification API configuration - deprecated): Verification API Configuration.
|
* vapi_log_fn (verification API configuration - deprecated): Verification API Configuration.
|
(line 41)
|
(line 41)
|
* ver (CPU configuration): CPU Configuration. (line 15)
|
* ver (CPU configuration): CPU Configuration. (line 15)
|
* verbose (simulator configuration): Simulator Behavior. (line 10)
|
* verbose (simulator configuration): Simulator Behavior. (line 10)
|
* Verification API configuration: Verification API Configuration.
|
* Verification API configuration: Verification API Configuration.
|
(line 6)
|
(line 6)
|
* Verilog memory dump (Interactive CLI): Interactive Command Line.
|
* Verilog memory dump (Interactive CLI): Interactive Command Line.
|
(line 124)
|
(line 124)
|
* VGA configuration: Display Interface Configuration.
|
* VGA configuration: Display Interface Configuration.
|
(line 6)
|
(line 6)
|
* word_enabled (generic peripheral configuration): Generic Peripheral Configuration.
|
* word_enabled (generic peripheral configuration): Generic Peripheral Configuration.
|
(line 50)
|
(line 50)
|
|
|
|
|
|
|
Tag Table:
|
Tag Table:
|
Node: Top830
|
Node: Top830
|
Node: Installation1240
|
Node: Installation1240
|
Node: Preparation1487
|
Node: Preparation1487
|
Node: Configuring the Build1782
|
Node: Configuring the Build1782
|
Node: Build and Install7926
|
Node: Build and Install7926
|
Node: Known Issues8704
|
Node: Known Issues8704
|
Node: Usage9759
|
Node: Usage9759
|
Node: Standalone Simulator9973
|
Node: Standalone Simulator9973
|
Node: Profiling Utility14537
|
Node: Profiling Utility14537
|
Node: Memory Profiling Utility15447
|
Node: Memory Profiling Utility15447
|
Node: Simulator Library16812
|
Node: Simulator Library16812
|
Node: Configuration26895
|
Node: Configuration26895
|
Node: Configuration File Format27507
|
Node: Configuration File Format27507
|
Node: Configuration File Preprocessing27892
|
Node: Configuration File Preprocessing27892
|
Node: Configuration File Syntax28189
|
Node: Configuration File Syntax28189
|
Node: Simulator Configuration30974
|
Node: Simulator Configuration30974
|
Node: Simulator Behavior31265
|
Node: Simulator Behavior31265
|
Node: Verification API Configuration35846
|
Node: Verification API Configuration35846
|
Node: CUC Configuration37786
|
Node: CUC Configuration37786
|
Node: Core OpenRISC Configuration39778
|
Node: Core OpenRISC Configuration39778
|
Node: CPU Configuration40280
|
Node: CPU Configuration40280
|
Node: Memory Configuration44399
|
Node: Memory Configuration44399
|
Node: Memory Management Configuration51121
|
Node: Memory Management Configuration51121
|
Node: Cache Configuration53498
|
Node: Cache Configuration53498
|
Node: Interrupt Configuration55884
|
Node: Interrupt Configuration55884
|
Node: Power Management Configuration56620
|
Node: Power Management Configuration57446
|
Node: Branch Prediction Configuration57897
|
Node: Branch Prediction Configuration58723
|
Node: Debug Interface Configuration59257
|
Node: Debug Interface Configuration60083
|
Node: Peripheral Configuration61600
|
Node: Peripheral Configuration62426
|
Node: Memory Controller Configuration62226
|
Node: Memory Controller Configuration63052
|
Node: UART Configuration66006
|
Node: UART Configuration66832
|
Node: DMA Configuration69525
|
Node: DMA Configuration70351
|
Node: Ethernet Configuration71392
|
Node: Ethernet Configuration72218
|
Node: GPIO Configuration75474
|
Node: GPIO Configuration76300
|
Node: Display Interface Configuration77107
|
Node: Display Interface Configuration77933
|
Node: Frame Buffer Configuration79416
|
Node: Frame Buffer Configuration80242
|
Node: Keyboard Configuration81280
|
Node: Keyboard Configuration82106
|
Node: Disc Interface Configuration83518
|
Node: Disc Interface Configuration84344
|
Node: Generic Peripheral Configuration88622
|
Node: Generic Peripheral Configuration89448
|
Node: Interactive Command Line90917
|
Node: Interactive Command Line91743
|
Node: Verification API97891
|
Node: Verification API98717
|
Node: Code Internals102321
|
Node: Code Internals103147
|
Node: Coding Conventions102904
|
Node: Coding Conventions103730
|
Node: Global Data Structures107331
|
Node: Global Data Structures108157
|
Node: Concepts109988
|
Node: Concepts110814
|
Ref: Output Redirection110133
|
Ref: Output Redirection110959
|
Node: Internal Debugging110672
|
Node: Internal Debugging111498
|
Node: Regression Testing111196
|
Node: Regression Testing112022
|
Node: GNU Free Documentation License114985
|
Node: GNU Free Documentation License115811
|
Node: Index137392
|
Node: Index138218
|
|
|
End Tag Table
|
End Tag Table
|
|
|
