URL
https://opencores.org/ocsvn/fixed_extensions/fixed_extensions/trunk
Subversion Repositories fixed_extensions
Compare Revisions
- This comparison shows the changes necessary to convert path
/fixed_extensions
- from Rev 2 to Rev 3
- ↔ Reverse comparison
Rev 2 → Rev 3
/trunk/doc/COPYING.BSD
1,7 → 1,7
*** MODIFIED BSD LICENSE |
=============================================================================== |
|
Copyright (c) 2011, Nikolaos Kavvadias |
Copyright (c) 2011, 2012, 2013, 2014 Nikolaos Kavvadias |
All rights reserved. |
|
Redistribution and use in source and binary forms, with or without |
/trunk/doc/BUGS
1,6 → 1,6
fixed_extensions BUGS -- known bugs. Last updated: 2011-07-25 |
fixed_extensions BUGS -- known bugs. Last updated: 2014-02-21 |
|
Known bugs in fixed_extensions-0.0.5 |
Known bugs in fixed_extensions-0.1.0 |
------------------------------------ |
|
** <dummy> |
/trunk/doc/README.html
Cannot display: file marked as a binary type.
svn:mime-type = application/xml
trunk/doc/README.html
Property changes :
Added: svn:executable
## -0,0 +1 ##
+*
\ No newline at end of property
Added: svn:mime-type
## -0,0 +1 ##
+application/xml
\ No newline at end of property
Index: trunk/doc/TODO
===================================================================
--- trunk/doc/TODO (revision 2)
+++ trunk/doc/TODO (revision 3)
@@ -3,6 +3,6 @@
Todo:
* Add more bit-manipulation operators for fixed-point arithmetic.
- * Test with GHDL (has some problems with s/ufixed entity ports.
+ * Test with GHDL (has some problems with s/ufixed entity ports).
end of file TODO
/trunk/doc/VERSION
1,6 → 1,6
0.0.5 |
0.1.0 |
/trunk/doc/README.pdf
Cannot display: file marked as a binary type.
svn:mime-type = application/pdf
trunk/doc/README.pdf
Property changes :
Added: svn:executable
## -0,0 +1 ##
+*
\ No newline at end of property
Added: svn:mime-type
## -0,0 +1 ##
+application/pdf
\ No newline at end of property
Index: trunk/doc/ChangeLog
===================================================================
--- trunk/doc/ChangeLog (revision 2)
+++ trunk/doc/ChangeLog (revision 3)
@@ -1,3 +1,7 @@
+2014-02-21 Nikolaos Kavvadias
+
+ * Release 0.1.0 with documentation updates.
+
2011-07-25 Nikolaos Kavvadias
* First release 0.0.5.
/trunk/doc/THANKS
1,7 → 1,7
Thanks to: |
|
X.Y. for whatever. |
This is just a placeholder. |
|
|
Thessaloniki, Greece, 2011-07-25 |
Lamia, Greece, 2014-02-21 |
|
/trunk/doc/rst2docs.sh
0,0 → 1,13
#!/bin/bash |
|
#DOCUTILS_PATH="/usr/local/bin/docutils/tools" |
#DOCUTILS_PATH="/cygdrive/c/docutils-0.11/tools" |
#DOCUTILS_PATH="/usr/local/bin/docutils/tools" |
DOCUTILS_PATH="/c/docutils-0.11/tools" |
|
${DOCUTILS_PATH}/rst2html.py <$1 >$1.html |
${DOCUTILS_PATH}/rst2latex.py <$1 >$1.tex |
pdflatex --shell-escape $1.tex |
rm -rf $1.aux $1.log $1.out $1.tex |
|
exit 0 |
trunk/doc/rst2docs.sh
Property changes :
Added: svn:executable
## -0,0 +1 ##
+*
\ No newline at end of property
Index: trunk/doc/README
===================================================================
--- trunk/doc/README (revision 2)
+++ trunk/doc/README (revision 3)
@@ -1,22 +1,37 @@
-------------------------------------------------------------------------------
--- Title : fixed_extensions (VHDL fixed-point arithmetic --
--- : extensions package). --
--- Author : Nikolaos Kavvadias --
--- Contact : nikolaos.kavvadias@gmail.com --
--- : http://www.nkavvadias.com --
--- Release Date : 25 July 2011 --
--- Version : 0.0.5 --
---------------------:---------------------------------------------------------
--- Revision history : --
--- v0.0.5 : 2011-07-25 --
--- : Initial release. --
-------------------------------------------------------------------------------
+==============================
+ fixed_extensions user manual
+==============================
++-------------------+----------------------------------------------------------+
+| **Title** | fixed_extensions (VHDL fixed-point arithmetic extensions |
+| | package) |
++-------------------+----------------------------------------------------------+
+| **Author** | Nikolaos Kavvadias 2011, 2012, 2013, 2014 |
++-------------------+----------------------------------------------------------+
+| **Contact** | nikos@nkavvadias.com |
++-------------------+----------------------------------------------------------+
+| **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
----------------
-"fixed_extensions_pkg" is a fixed-point arithmetic package written in VHDL
+1. Introduction
+===============
+
+``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-
compatible libraries (by David Bishop) that are included in this distribution
for the sake of completeness.
@@ -23,81 +38,139 @@
Currently, the "fixed_extensions_pkg" package implements the following:
- - ceil : round towards plus infinity.
- - fix : round towards zero.
- - floor : round towards minus infinity.
- - round : 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
+-ceil:
+ round towards plus infinity.
+-fix:
+ round towards zero.
+-floor:
+ round towards minus infinity.
+-round:
+ 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
-customized VHDL test designs.
+``fixed_extensions`` is distributed along with a tool (gentestround) to generate
+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-
- /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.
+The ``fixed_extensions`` distribution includes the following files:
+
++-----------------------+------------------------------------------------------+
+| /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
--------------------------
+3. ``fixed_extensions`` usage
+=============================
- The fixed_extensions package can be used as follows:
- $./run.sh
+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``
-4. PREREQUISITIES
------------------
+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:
-- 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.
+| ``$ ./testroundings.sh``
+and
-5. CONTACT
-----------
+| ``$./testroundingu.sh``
-You may contact me for further questions/suggestions/corrections at:
- Nikolaos Kavvadias
-
-
- http://www.nkavvadias.com
+4. Prerequisities
+=================
+
+- Standard UNIX-based tools (tested on cygwin/x86)
+
+ * make
+ * bash
+
+- [optional] Mentor Modelsim (``mti``) from http://www.model.com
+
+ Provides a simulation environment to run the tests.