OpenCores
URL https://opencores.org/ocsvn/openrisc_me/openrisc_me/trunk

Subversion Repositories openrisc_me

Compare Revisions

  • This comparison shows the changes necessary to convert path 
    /openrisc/trunk/or1ksim/doc
    from Rev 91 to Rev 93
    ↔ Reverse comparison
  •

Rev 91 → Rev 93

/or1ksim.info
64,7 → 64,7
Unpack the software and create a _separate_ directory in which to build
it:
 
tar jxf or1ksim-2010-04-21.tar.bz2
tar jxf or1ksim-2010-04-28.tar.bz2
mkdir builddir_or1ksim
cd builddir_or1ksim
 
81,7 → 81,7
OpenRISC 1000 32-bit architecture. If this argument is omitted, it will
default to OpenRISC 1000 32-bit with a warning
 
../or1ksim-2010-04-21/configure --target=or32-uclinux ...
../or1ksim-2010-04-28/configure --target=or32-uclinux ...
 
There are several other options available, many of which are standard
to GNU `configure' scripts. Use `configure --help' to see all the
243,7 → 243,7
=============================
 
The following problems and issues are known about with Or1ksim
2010-04-21. The OpenRISC tracker may be used to see the current state
2010-04-28. The OpenRISC tracker may be used to see the current state
of these issues and to raise new problems and feature requests. It may
be found at `http://www.opencores.org/ptracker.cgi/view/or1k/398'.
 
487,11 → 487,13
The header file `or1ksim.h' contains appropriate declarations of the
functions exported by the Or1ksim library. These are:
 
-- `or1ksim.h': int or1ksim_init (const char *CONFIG_FILE, const char
*IMAGE_FILE, void *CLASS_PTR, unsigned long int (*UPR)(void
*CLASS_PTR, unsigned long int ADDR, unsigned long int MASK),
void (*UPW)(void *CLASS_PTR, unsigned long int ADDR, unsigned
long int MASK, unsigned long int WDATA))
-- `or1ksim.h': int or1ksim_init (const char
*CONFIG_FILE, const char *IMAGE_FILE, void *CLASS_PTR, int
(*UPR)(void *CLASS_PTR, unsigned long int ADDR, unsigned char
MASK[], unsigned char RDATA[], int DATA_LEN), int (*UPW)(void
*CLASS_PTR, unsigned long int ADDR, unsigned char MASK[], unsigned
char WDATA[], int DATA_LEN))
 
The initialization function is supplied with the name of a
configuration file, CONFIG_FILE, an executable image, IMAGE_FILE,
a pointer to the calling class, CLASS_PTR (since the library may
506,17 → 508,28
UPR is called for any reads to an external address. The CLASS_PTR
is passed back with these upcalls, allowing the function to
associate the call with the class which originally initialized the
library.
library. Both UPW and UPR should return zero on success and
non-zero otherwise. At the present time the meaning of non-zero
values is not defined but this may change in the future.
 
MASK indicates which bytes in the word 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
the byte should be zero.
the byte should be zero. The adddress, ADDR, is the _full_
address, since the upcall function must handle all generic
devices, using the full address for decoding.
 
ADDR, MASK, WDATA and the result from UPR all use host-endianess,
_not_ model-endianess. The internal Or1ksim routines manage all
the conversion.
Endianness is not completely transparent, since Or1ksim is
transferring byte vectors, not multi-byte values.
 
Caution: This is a change from version 0.3.0. It simplifies
the interface, and makes Or1ksim more consistent with payload
representation in SystemC TLM 2.0.
 
Note: The current implementation of Or1ksim always transfers
single words (4 bytes), using masks if smaller values are
required. In this it mimcs the behavior of the WishBone bus.
 
 
-- `or1ksim.h': int or1ksim_run (double DURATION)
Run the simulator for the simulated duration specified (in
seconds).
3667,7 → 3680,7
(line 122)
* log_enabled (verification API configuration): Verification API Configuration.
(line 28)
* long: Simulator Library. (line 74)
* long: Simulator Library. (line 87)
* mc (memory configuration): Memory Configuration.
(line 100)
* memory configuration: Memory Configuration.
3724,15 → 3737,15
* nways (cache configuration): Cache Configuration. (line 22)
* nways (MMU configuration): Memory Management Configuration.
(line 22)
* or1ksim_get_time_period: Simulator Library. (line 64)
* or1ksim_init: Simulator Library. (line 18)
* or1ksim_interrupt: Simulator Library. (line 79)
* or1ksim_interrupt_clear: Simulator Library. (line 97)
* or1ksim_interrupt_set: Simulator Library. (line 88)
* or1ksim_is_le: Simulator Library. (line 69)
* or1ksim_reset_duration: Simulator Library. (line 49)
* or1ksim_run: Simulator Library. (line 44)
* or1ksim_set_time_point: Simulator Library. (line 60)
* or1ksim_get_time_period: Simulator Library. (line 77)
* or1ksim_init: Simulator Library. (line 14)
* or1ksim_interrupt: Simulator Library. (line 92)
* or1ksim_interrupt_clear: Simulator Library. (line 110)
* or1ksim_interrupt_set: Simulator Library. (line 101)
* or1ksim_is_le: Simulator Library. (line 82)
* or1ksim_reset_duration: Simulator Library. (line 62)
* or1ksim_run: Simulator Library. (line 57)
* or1ksim_set_time_point: Simulator Library. (line 73)
* output rediretion: Concepts. (line 7)
* overflow flag setting by instructions: Configuring the Build.
(line 70)
4071,43 → 4084,43
Node: Profiling Utility13349
Node: Memory Profiling Utility14259
Node: Simulator Library15624
Node: Configuration21109
Node: Configuration File Format21718
Node: Configuration File Preprocessing22010
Node: Configuration File Syntax22381
Node: Simulator Configuration25166
Node: Simulator Behavior25457
Node: Verification API Configuration29501
Node: CUC Configuration31441
Node: Core OpenRISC Configuration33358
Node: CPU Configuration33860
Node: Memory Configuration37665
Node: Memory Management Configuration42978
Node: Cache Configuration45355
Node: Interrupt Configuration47741
Node: Power Management Configuration48477
Node: Branch Prediction Configuration49754
Node: Debug Interface Configuration51114
Node: Peripheral Configuration55334
Node: Memory Controller Configuration55960
Node: UART Configuration58565
Node: DMA Configuration62084
Node: Ethernet Configuration63951
Node: GPIO Configuration67929
Node: Display Interface Configuration69562
Node: Frame Buffer Configuration71871
Node: Keyboard Configuration73735
Node: Disc Interface Configuration75973
Node: Generic Peripheral Configuration80916
Node: Interactive Command Line83211
Node: Verification API90185
Node: Code Internals94615
Node: Coding Conventions95175
Node: Global Data Structures99602
Node: Concepts102259
Ref: Output Redirection102404
Node: Internal Debugging102943
Node: GNU Free Documentation License103440
Node: Index125847
Node: Configuration21816
Node: Configuration File Format22425
Node: Configuration File Preprocessing22717
Node: Configuration File Syntax23088
Node: Simulator Configuration25873
Node: Simulator Behavior26164
Node: Verification API Configuration30208
Node: CUC Configuration32148
Node: Core OpenRISC Configuration34065
Node: CPU Configuration34567
Node: Memory Configuration38372
Node: Memory Management Configuration43685
Node: Cache Configuration46062
Node: Interrupt Configuration48448
Node: Power Management Configuration49184
Node: Branch Prediction Configuration50461
Node: Debug Interface Configuration51821
Node: Peripheral Configuration56041
Node: Memory Controller Configuration56667
Node: UART Configuration59272
Node: DMA Configuration62791
Node: Ethernet Configuration64658
Node: GPIO Configuration68636
Node: Display Interface Configuration70269
Node: Frame Buffer Configuration72578
Node: Keyboard Configuration74442
Node: Disc Interface Configuration76680
Node: Generic Peripheral Configuration81623
Node: Interactive Command Line83918
Node: Verification API90892
Node: Code Internals95322
Node: Coding Conventions95882
Node: Global Data Structures100309
Node: Concepts102966
Ref: Output Redirection103111
Node: Internal Debugging103650
Node: GNU Free Documentation License104147
Node: Index126554

End Tag Table
/or1ksim.texi
599,7 → 599,13
The header file @file{or1ksim.h} contains appropriate declarations of
the functions exported by the @value{OR1KSIM} library. These are:
 
@deftypefn {@file{or1ksim.h}} int or1ksim_init (const char *@var{config_file}, const char *@var{image_file}, void *@var{class_ptr}, unsigned long int (*@var{upr})(void *@var{class_ptr}, unsigned long int @var{addr}, unsigned long int @var{mask}), void (*@var{upw})(void *@var{class_ptr}, unsigned long int @var{addr}, unsigned long int @var{mask}, unsigned long int @var{wdata}))
@deftypefn {@file{or1ksim.h}} int or1ksim_init (const char
*@var{config_file}, const char *@var{image_file}, void *@var{class_ptr},
int (*@var{upr})(void *@var{class_ptr}, unsigned long int @var{addr},
unsigned char @var{mask}[], unsigned char @var{rdata}[], int
@var{data_len}), int (*@var{upw})(void *@var{class_ptr}, unsigned long
int @var{addr}, unsigned char @var{mask}[], unsigned char @var{wdata}[],
int @var{data_len}))
 
The initialization function is supplied with the name of a
configuration file, @var{config_file}, an executable image, @var{image_file}, a pointer to the calling
615,16 → 621,31
file). @var{upr} is called for any reads to an external address. The
@var{class_ptr} is passed back with these upcalls, allowing the
function to associate the call with the class which originally
initialized the library.
initialized the library. Both @var{upw} and @var{upr} should return
zero on success and non-zero otherwise. At the present time the meaning
of non-zero values is not defined but this may change in the future.
 
@var{mask} indicates which bytes in the word are to be written or
@var{mask} indicates which bytes in the data are to be written or
read. Bytes to be read/written should have 0xff set in
@var{mask}. Otherwise the byte should be zero.
@var{mask}. Otherwise the byte should be zero. The adddress,
@var{addr}, is the @emph{full} address, since the upcall function must
handle all generic devices, using the full address for decoding.
 
@var{addr}, @var{mask}, @var{wdata} and the result from @var{upr} all
use host-endianess, @emph{not} model-endianess. The internal
@value{OR1KSIM} routines manage all the conversion.
Endianness is not completely transparent, since @value{OR1KSIM} is
transferring byte vectors, not multi-byte values.
 
@quotation Caution
This is a change from version 0.3.0. It simplifies the interface, and
makes @value{OR1KSIM} more consistent with payload representation in
SystemC TLM 2.0.
@end quotation
 
@quotation Note
The current implementation of Or1ksim always transfers single words (4
bytes), using masks if smaller values are required. In this it mimcs the
behavior of the WishBone bus.
@end quotation
 
@end deftypefn
 
@deftypefn {@file{or1ksim.h}} int or1ksim_run (double @var{duration})
/version.texi
1,4 → 1,4
@set UPDATED 20 April 2010
@set UPDATED 28 April 2010
@set UPDATED-MONTH April 2010
@set EDITION 2010-04-21
@set VERSION 2010-04-21
@set EDITION 2010-04-28
@set VERSION 2010-04-28

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.