| Line 1... |
Line 1... |
------------------------------------------------------------------------------
|
==============================
|
-- Title : fixed_extensions (VHDL fixed-point arithmetic --
|
fixed_extensions user manual
|
-- : extensions package). --
|
==============================
|
-- Author : Nikolaos Kavvadias --
|
|
-- Contact : nikolaos.kavvadias@gmail.com --
|
+-------------------+----------------------------------------------------------+
|
-- : http://www.nkavvadias.com --
|
| **Title** | fixed_extensions (VHDL fixed-point arithmetic extensions |
|
-- Release Date : 25 July 2011 --
|
| | package) |
|
-- Version : 0.0.5 --
|
+-------------------+----------------------------------------------------------+
|
--------------------:---------------------------------------------------------
|
| **Author** | Nikolaos Kavvadias 2011, 2012, 2013, 2014 |
|
-- Revision history : --
|
+-------------------+----------------------------------------------------------+
|
-- v0.0.5 : 2011-07-25 --
|
| **Contact** | nikos@nkavvadias.com |
|
-- : Initial release. --
|
+-------------------+----------------------------------------------------------+
|
------------------------------------------------------------------------------
|
| **Website** | http://www.nkavvadias.com |
|
|
+-------------------+----------------------------------------------------------+
|
|
| **Release Date** | 21 February 2014 |
|
|
+-------------------+----------------------------------------------------------+
|
|
| **Version** | 0.1.0 |
|
|
+-------------------+----------------------------------------------------------+
|
|
| **Rev. history** | |
|
|
+-------------------+----------------------------------------------------------+
|
|
| **v0.1.0** | 21-02-2014 |
|
|
| | |
|
|
| | Changed documentation format to RestructuredText. |
|
|
+-------------------+----------------------------------------------------------+
|
|
| **v0.0.5** | 25-07-2011 |
|
|
| | |
|
|
| | First public release. |
|
|
+-------------------+----------------------------------------------------------+
|
|
|
|
|
1. INTRODUCTION
|
1. Introduction
|
---------------
|
===============
|
|
|
"fixed_extensions_pkg" is a fixed-point arithmetic package written in VHDL
|
``fixed_extensions_pkg`` is a fixed-point arithmetic package written in VHDL
|
according to the VHDL-2008 update of the standard. It uses VHDL-2008 back-
|
according to the VHDL-2008 update of the standard. It uses VHDL-2008 back-
|
compatible libraries (by David Bishop) that are included in this distribution
|
compatible libraries (by David Bishop) that are included in this distribution
|
for the sake of completeness.
|
for the sake of completeness.
|
|
|
Currently, the "fixed_extensions_pkg" package implements the following:
|
Currently, the "fixed_extensions_pkg" package implements the following:
|
|
|
- ceil : round towards plus infinity.
|
-ceil:
|
- fix : round towards zero.
|
round towards plus infinity.
|
- floor : round towards minus infinity.
|
-fix:
|
- round : round to nearest; ties to greatest absolute value.
|
round towards zero.
|
- nearest : round to nearest; ties to plus infinity.
|
-floor:
|
- convergent: round to nearest; ties to closest even.
|
round towards minus infinity.
|
- bitinsert : bit-field insertion to word
|
-round:
|
- bitextract: bit-field extraction from word
|
round to nearest; ties to greatest absolute value.
|
|
-nearest:
|
|
round to nearest; ties to plus infinity.
|
|
-convergent:
|
|
round to nearest; ties to closest even.
|
|
-bitinsert:
|
|
bit-field insertion to word
|
|
-bitextract:
|
|
bit-field extraction from word
|
|
|
"fixed_extensions" is distributed along with a tool (gentestround) to generate
|
``fixed_extensions`` is distributed along with a tool (gentestround) to generate
|
customized VHDL test designs.
|
customized VHDL test designs.
|
|
|
|
The ``fixed_extensions`` project can be download from the following OpenCores
|
|
website: http://opencores.org/project,fixed_extensions
|
|
|
2. FILE LISTING
|
|
---------------
|
|
|
|
The fixed_extensions distributions includes the following files:
|
2. File listing
|
|
===============
|
|
|
/fixed_extensions-
|
The ``fixed_extensions`` distribution includes the following files:
|
/bench/vhdl
|
|
testrounding_tb.vhd Standard testbench file.
|
|
/doc
|
|
AUTHORS List of "fixed_extensions" authors.
|
|
BUGS Bug list.
|
|
ChangeLog A log for code changes.
|
|
COPYING.BSD The Modified BSD License.
|
|
README This file.
|
|
THANKS Acknowledgements.
|
|
TODO A list of future enhancements.
|
|
/gen/vhdl
|
|
testroundings.vhd Auto-generated test file for sfixed arithmetic.
|
|
testroundingu.vhd Auto-generated test file for ufixed arithmetic.
|
|
/rtl/vhdl
|
|
fixed_extensions_pkg_sim.vhd
|
|
The VHDL package for simulation-oriented use.
|
|
fixed_extensions_pkg_synth.vhd
|
|
The VHDL package for synthesis-oriented use.
|
|
/sim/rtl_sim/bin
|
|
run.sh A bash script for testing the package.
|
|
testroundings.do Modelsim macro script for testing sfixed arithmetic.
|
|
testroundings.sh Bash script for running an sfixed simulation.
|
|
testroundingu.do Modelsim macro script for testing ufixed arithmetic.
|
|
testroundingu.sh Bash script for running an ufixed simulation.
|
|
/sim/rtl_sim/src
|
|
fixed_float_types_custom.vhd
|
|
VHDL package with definitions for fixed-point arith.
|
|
fixed_pkg_c.vhd VHDL package implementing fixed-point arithmetic.
|
|
math_real.vhd VHDL package with some real arithmetic functions.
|
|
/sw
|
|
gentestround.c Test design generator written in ANSI C.
|
|
Makefile Makefile for compiling the test design generator.
|
|
|
|
|
|
3. FIXED_EXTENSIONS USAGE
|
|
-------------------------
|
|
|
|
The fixed_extensions package can be used as follows:
|
+-----------------------+------------------------------------------------------+
|
$./run.sh
|
| /fixed_extensions | Top-level directory |
|
|
+-----------------------+------------------------------------------------------+
|
|
| /bench/vhdl | Benchmarks VHDL directory |
|
|
+-----------------------+------------------------------------------------------+
|
|
| testrounding_tb.vhd | Standard testbench file. |
|
|
+-----------------------+------------------------------------------------------+
|
|
| /doc | Documentation directory |
|
|
+-----------------------+------------------------------------------------------+
|
|
| AUTHORS | List of authors. |
|
|
+-----------------------+------------------------------------------------------+
|
|
| BUGS | Bug list. |
|
|
+-----------------------+------------------------------------------------------+
|
|
| ChangeLog | A log for code changes. |
|
|
+-----------------------+------------------------------------------------------+
|
|
| COPYING.BSD | The modified BSD license. |
|
|
+-----------------------+------------------------------------------------------+
|
|
| README | This file. |
|
|
+-----------------------+------------------------------------------------------+
|
|
| README.html | HTML version of README. |
|
|
+-----------------------+------------------------------------------------------+
|
|
| README.pdf | PDF version of README. |
|
|
+-----------------------+------------------------------------------------------+
|
|
| rst2docs.sh | Bash script for generating the HTML and PDF versions.|
|
|
+-----------------------+------------------------------------------------------+
|
|
| THANKS | Acknowledgements. |
|
|
+-----------------------+------------------------------------------------------+
|
|
| TODO | A list of future enhancements. |
|
|
+-----------------------+------------------------------------------------------+
|
|
| VERSION | Current version of the project sources. |
|
|
+-----------------------+------------------------------------------------------+
|
|
| /gen/vhdl | Generated RTL VHDL code directory. |
|
|
+-----------------------+------------------------------------------------------+
|
|
| testroundings.vhd | Auto-generated test file for sfixed arithmetic. |
|
|
+-----------------------+------------------------------------------------------+
|
|
| testroundingu.vhd | Auto-generated test file for ufixed arithmetic. |
|
|
+-----------------------+------------------------------------------------------+
|
|
| /rtl/vhdl | RTL source code directory for the package |
|
|
+-----------------------+------------------------------------------------------+
|
|
| fixed_extensions_pkg- | The VHDL package for simulation-oriented use. |
|
|
| _sim.vhd | |
|
|
+-----------------------+------------------------------------------------------+
|
|
| /sim/rtl_sim | RTL simulation files directory |
|
|
+-----------------------+------------------------------------------------------+
|
|
| /sim/rtl_sim/bin | RTL simulation scripts directory |
|
|
+-----------------------+------------------------------------------------------+
|
|
| run.sh | A bash script for testing the package. |
|
|
+-----------------------+------------------------------------------------------+
|
|
| testroundings.do | Modelsim macro script for testing sfixed arithmetic. |
|
|
+-----------------------+------------------------------------------------------+
|
|
| testroundings.sh | Bash script for running an sfixed simulation. |
|
|
+-----------------------+------------------------------------------------------+
|
|
| testroundingu.do | Modelsim macro script for testing ufixed arithmetic. |
|
|
+-----------------------+------------------------------------------------------+
|
|
| testroundingu.sh | Bash script for running an ufixed simulation. |
|
|
+-----------------------+------------------------------------------------------+
|
|
| /sim/rtl_sim/src | Various source files for running RTL simulations |
|
|
+-----------------------+------------------------------------------------------+
|
|
| fixed_float_typ | VHDL package with definitions for fixed-point |
|
|
| es_custom.vhd | arithmetic. |
|
|
+-----------------------+------------------------------------------------------+
|
|
| fixed_pkg_c.vhd | VHDL package implementing fixed-point arithmetic |
|
|
| | (VHDL'93 version of the VHDL-2008 package as found |
|
|
| | http://www.eda.org/fphdl/). |
|
|
+-----------------------+------------------------------------------------------+
|
|
| math_real.vhd | VHDL package with some real arithmetic functions |
|
|
| | (also part of the IEEE 1076 standard for VHDL). |
|
|
+-----------------------+------------------------------------------------------+
|
|
| /sw | Software utilities |
|
|
+-----------------------+------------------------------------------------------+
|
|
| Makefile | Makefile for compiling the test design generator. |
|
|
+-----------------------+------------------------------------------------------+
|
|
| gentestround.c | Test design generator written in ANSI C. |
|
|
+-----------------------+------------------------------------------------------+
|
|
|
|
|
|
3. ``fixed_extensions`` usage
|
|
=============================
|
|
|
|
The fixed_extensions package can be used as follows. Assuming that the user has
|
|
changed directory to ``./fixed_extensions``, the following can be used:
|
|
|
|
| ``$ cd sim/rtl_sim/bin``
|
|
| ``$ ./run.sh``
|
|
|
|
Alternatively, the user can only generate and run some tests for solely the
|
|
signed fixed-point and unsigned fixed-point data types. This is correspondingly
|
|
performed as:
|
|
|
|
| ``$ ./testroundings.sh``
|
|
|
|
and
|
|
|
4. PREREQUISITIES
|
| ``$./testroundingu.sh``
|
-----------------
|
|
|
|
- Standard UNIX-based tools (tested on cygwin/x86)
|
|
make, bash
|
|
- [optional] Mentor Modelsim ("mti") (http://www.mentor.com)
|
|
Provides a simulation environment to run the tests.
|
|
|
|
|
4. Prerequisities
|
|
=================
|
|
|
5. CONTACT
|
- Standard UNIX-based tools (tested on cygwin/x86)
|
----------
|
|
|
|
You may contact me for further questions/suggestions/corrections at:
|
* make
|
|
* bash
|
|
|
Nikolaos Kavvadias
|
- [optional] Mentor Modelsim (``mti``) from http://www.model.com
|
|
|
|
Provides a simulation environment to run the tests.
|
http://www.nkavvadias.com
|
|
Provides a simulation environment to run the tests.
|
|
