ADD: Module for a Simple Fifo, later used in the UART, to get it running on all FPGAs
This commit is contained in:
parent
b02a2f5b75
commit
dbd8ef11a1
339
src/Modules/SimpleFifo/License
Normal file
339
src/Modules/SimpleFifo/License
Normal file
@ -0,0 +1,339 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 2, June 1991
|
||||
|
||||
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
|
||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The licenses for most software are designed to take away your
|
||||
freedom to share and change it. By contrast, the GNU General Public
|
||||
License is intended to guarantee your freedom to share and change free
|
||||
software--to make sure the software is free for all its users. This
|
||||
General Public License applies to most of the Free Software
|
||||
Foundation's software and to any other program whose authors commit to
|
||||
using it. (Some other Free Software Foundation software is covered by
|
||||
the GNU Lesser General Public License instead.) You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
this service if you wish), that you receive source code or can get it
|
||||
if you want it, that you can change the software or use pieces of it
|
||||
in new free programs; and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to make restrictions that forbid
|
||||
anyone to deny you these rights or to ask you to surrender the rights.
|
||||
These restrictions translate to certain responsibilities for you if you
|
||||
distribute copies of the software, or if you modify it.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must give the recipients all the rights that
|
||||
you have. You must make sure that they, too, receive or can get the
|
||||
source code. And you must show them these terms so they know their
|
||||
rights.
|
||||
|
||||
We protect your rights with two steps: (1) copyright the software, and
|
||||
(2) offer you this license which gives you legal permission to copy,
|
||||
distribute and/or modify the software.
|
||||
|
||||
Also, for each author's protection and ours, we want to make certain
|
||||
that everyone understands that there is no warranty for this free
|
||||
software. If the software is modified by someone else and passed on, we
|
||||
want its recipients to know that what they have is not the original, so
|
||||
that any problems introduced by others will not reflect on the original
|
||||
authors' reputations.
|
||||
|
||||
Finally, any free program is threatened constantly by software
|
||||
patents. We wish to avoid the danger that redistributors of a free
|
||||
program will individually obtain patent licenses, in effect making the
|
||||
program proprietary. To prevent this, we have made it clear that any
|
||||
patent must be licensed for everyone's free use or not licensed at all.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||
|
||||
0. This License applies to any program or other work which contains
|
||||
a notice placed by the copyright holder saying it may be distributed
|
||||
under the terms of this General Public License. The "Program", below,
|
||||
refers to any such program or work, and a "work based on the Program"
|
||||
means either the Program or any derivative work under copyright law:
|
||||
that is to say, a work containing the Program or a portion of it,
|
||||
either verbatim or with modifications and/or translated into another
|
||||
language. (Hereinafter, translation is included without limitation in
|
||||
the term "modification".) Each licensee is addressed as "you".
|
||||
|
||||
Activities other than copying, distribution and modification are not
|
||||
covered by this License; they are outside its scope. The act of
|
||||
running the Program is not restricted, and the output from the Program
|
||||
is covered only if its contents constitute a work based on the
|
||||
Program (independent of having been made by running the Program).
|
||||
Whether that is true depends on what the Program does.
|
||||
|
||||
1. You may copy and distribute verbatim copies of the Program's
|
||||
source code as you receive it, in any medium, provided that you
|
||||
conspicuously and appropriately publish on each copy an appropriate
|
||||
copyright notice and disclaimer of warranty; keep intact all the
|
||||
notices that refer to this License and to the absence of any warranty;
|
||||
and give any other recipients of the Program a copy of this License
|
||||
along with the Program.
|
||||
|
||||
You may charge a fee for the physical act of transferring a copy, and
|
||||
you may at your option offer warranty protection in exchange for a fee.
|
||||
|
||||
2. You may modify your copy or copies of the Program or any portion
|
||||
of it, thus forming a work based on the Program, and copy and
|
||||
distribute such modifications or work under the terms of Section 1
|
||||
above, provided that you also meet all of these conditions:
|
||||
|
||||
a) You must cause the modified files to carry prominent notices
|
||||
stating that you changed the files and the date of any change.
|
||||
|
||||
b) You must cause any work that you distribute or publish, that in
|
||||
whole or in part contains or is derived from the Program or any
|
||||
part thereof, to be licensed as a whole at no charge to all third
|
||||
parties under the terms of this License.
|
||||
|
||||
c) If the modified program normally reads commands interactively
|
||||
when run, you must cause it, when started running for such
|
||||
interactive use in the most ordinary way, to print or display an
|
||||
announcement including an appropriate copyright notice and a
|
||||
notice that there is no warranty (or else, saying that you provide
|
||||
a warranty) and that users may redistribute the program under
|
||||
these conditions, and telling the user how to view a copy of this
|
||||
License. (Exception: if the Program itself is interactive but
|
||||
does not normally print such an announcement, your work based on
|
||||
the Program is not required to print an announcement.)
|
||||
|
||||
These requirements apply to the modified work as a whole. If
|
||||
identifiable sections of that work are not derived from the Program,
|
||||
and can be reasonably considered independent and separate works in
|
||||
themselves, then this License, and its terms, do not apply to those
|
||||
sections when you distribute them as separate works. But when you
|
||||
distribute the same sections as part of a whole which is a work based
|
||||
on the Program, the distribution of the whole must be on the terms of
|
||||
this License, whose permissions for other licensees extend to the
|
||||
entire whole, and thus to each and every part regardless of who wrote it.
|
||||
|
||||
Thus, it is not the intent of this section to claim rights or contest
|
||||
your rights to work written entirely by you; rather, the intent is to
|
||||
exercise the right to control the distribution of derivative or
|
||||
collective works based on the Program.
|
||||
|
||||
In addition, mere aggregation of another work not based on the Program
|
||||
with the Program (or with a work based on the Program) on a volume of
|
||||
a storage or distribution medium does not bring the other work under
|
||||
the scope of this License.
|
||||
|
||||
3. You may copy and distribute the Program (or a work based on it,
|
||||
under Section 2) in object code or executable form under the terms of
|
||||
Sections 1 and 2 above provided that you also do one of the following:
|
||||
|
||||
a) Accompany it with the complete corresponding machine-readable
|
||||
source code, which must be distributed under the terms of Sections
|
||||
1 and 2 above on a medium customarily used for software interchange; or,
|
||||
|
||||
b) Accompany it with a written offer, valid for at least three
|
||||
years, to give any third party, for a charge no more than your
|
||||
cost of physically performing source distribution, a complete
|
||||
machine-readable copy of the corresponding source code, to be
|
||||
distributed under the terms of Sections 1 and 2 above on a medium
|
||||
customarily used for software interchange; or,
|
||||
|
||||
c) Accompany it with the information you received as to the offer
|
||||
to distribute corresponding source code. (This alternative is
|
||||
allowed only for noncommercial distribution and only if you
|
||||
received the program in object code or executable form with such
|
||||
an offer, in accord with Subsection b above.)
|
||||
|
||||
The source code for a work means the preferred form of the work for
|
||||
making modifications to it. For an executable work, complete source
|
||||
code means all the source code for all modules it contains, plus any
|
||||
associated interface definition files, plus the scripts used to
|
||||
control compilation and installation of the executable. However, as a
|
||||
special exception, the source code distributed need not include
|
||||
anything that is normally distributed (in either source or binary
|
||||
form) with the major components (compiler, kernel, and so on) of the
|
||||
operating system on which the executable runs, unless that component
|
||||
itself accompanies the executable.
|
||||
|
||||
If distribution of executable or object code is made by offering
|
||||
access to copy from a designated place, then offering equivalent
|
||||
access to copy the source code from the same place counts as
|
||||
distribution of the source code, even though third parties are not
|
||||
compelled to copy the source along with the object code.
|
||||
|
||||
4. You may not copy, modify, sublicense, or distribute the Program
|
||||
except as expressly provided under this License. Any attempt
|
||||
otherwise to copy, modify, sublicense or distribute the Program is
|
||||
void, and will automatically terminate your rights under this License.
|
||||
However, parties who have received copies, or rights, from you under
|
||||
this License will not have their licenses terminated so long as such
|
||||
parties remain in full compliance.
|
||||
|
||||
5. You are not required to accept this License, since you have not
|
||||
signed it. However, nothing else grants you permission to modify or
|
||||
distribute the Program or its derivative works. These actions are
|
||||
prohibited by law if you do not accept this License. Therefore, by
|
||||
modifying or distributing the Program (or any work based on the
|
||||
Program), you indicate your acceptance of this License to do so, and
|
||||
all its terms and conditions for copying, distributing or modifying
|
||||
the Program or works based on it.
|
||||
|
||||
6. Each time you redistribute the Program (or any work based on the
|
||||
Program), the recipient automatically receives a license from the
|
||||
original licensor to copy, distribute or modify the Program subject to
|
||||
these terms and conditions. You may not impose any further
|
||||
restrictions on the recipients' exercise of the rights granted herein.
|
||||
You are not responsible for enforcing compliance by third parties to
|
||||
this License.
|
||||
|
||||
7. If, as a consequence of a court judgment or allegation of patent
|
||||
infringement or for any other reason (not limited to patent issues),
|
||||
conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot
|
||||
distribute so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you
|
||||
may not distribute the Program at all. For example, if a patent
|
||||
license would not permit royalty-free redistribution of the Program by
|
||||
all those who receive copies directly or indirectly through you, then
|
||||
the only way you could satisfy both it and this License would be to
|
||||
refrain entirely from distribution of the Program.
|
||||
|
||||
If any portion of this section is held invalid or unenforceable under
|
||||
any particular circumstance, the balance of the section is intended to
|
||||
apply and the section as a whole is intended to apply in other
|
||||
circumstances.
|
||||
|
||||
It is not the purpose of this section to induce you to infringe any
|
||||
patents or other property right claims or to contest validity of any
|
||||
such claims; this section has the sole purpose of protecting the
|
||||
integrity of the free software distribution system, which is
|
||||
implemented by public license practices. Many people have made
|
||||
generous contributions to the wide range of software distributed
|
||||
through that system in reliance on consistent application of that
|
||||
system; it is up to the author/donor to decide if he or she is willing
|
||||
to distribute software through any other system and a licensee cannot
|
||||
impose that choice.
|
||||
|
||||
This section is intended to make thoroughly clear what is believed to
|
||||
be a consequence of the rest of this License.
|
||||
|
||||
8. If the distribution and/or use of the Program is restricted in
|
||||
certain countries either by patents or by copyrighted interfaces, the
|
||||
original copyright holder who places the Program under this License
|
||||
may add an explicit geographical distribution limitation excluding
|
||||
those countries, so that distribution is permitted only in or among
|
||||
countries not thus excluded. In such case, this License incorporates
|
||||
the limitation as if written in the body of this License.
|
||||
|
||||
9. The Free Software Foundation may publish revised and/or new versions
|
||||
of the General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the Program
|
||||
specifies a version number of this License which applies to it and "any
|
||||
later version", you have the option of following the terms and conditions
|
||||
either of that version or of any later version published by the Free
|
||||
Software Foundation. If the Program does not specify a version number of
|
||||
this License, you may choose any version ever published by the Free Software
|
||||
Foundation.
|
||||
|
||||
10. If you wish to incorporate parts of the Program into other free
|
||||
programs whose distribution conditions are different, write to the author
|
||||
to ask for permission. For software which is copyrighted by the Free
|
||||
Software Foundation, write to the Free Software Foundation; we sometimes
|
||||
make exceptions for this. Our decision will be guided by the two goals
|
||||
of preserving the free status of all derivatives of our free software and
|
||||
of promoting the sharing and reuse of software generally.
|
||||
|
||||
NO WARRANTY
|
||||
|
||||
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
||||
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
||||
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
||||
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
||||
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||||
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
||||
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
||||
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
||||
REPAIR OR CORRECTION.
|
||||
|
||||
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
||||
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
||||
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
||||
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
||||
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
||||
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
||||
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
||||
POSSIBILITY OF SUCH DAMAGES.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
convey the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software; you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation; either version 2 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License along
|
||||
with this program; if not, write to the Free Software Foundation, Inc.,
|
||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program is interactive, make it output a short notice like this
|
||||
when it starts in an interactive mode:
|
||||
|
||||
Gnomovision version 69, Copyright (C) year name of author
|
||||
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, the commands you use may
|
||||
be called something other than `show w' and `show c'; they could even be
|
||||
mouse-clicks or menu items--whatever suits your program.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or your
|
||||
school, if any, to sign a "copyright disclaimer" for the program, if
|
||||
necessary. Here is a sample; alter the names:
|
||||
|
||||
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
||||
`Gnomovision' (which makes passes at compilers) written by James Hacker.
|
||||
|
||||
<signature of Ty Coon>, 1 April 1989
|
||||
Ty Coon, President of Vice
|
||||
|
||||
This General Public License does not permit incorporating your program into
|
||||
proprietary programs. If your program is a subroutine library, you may
|
||||
consider it more useful to permit linking proprietary applications with the
|
||||
library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License.
|
3
src/Modules/SimpleFifo/Makefile.files
Normal file
3
src/Modules/SimpleFifo/Makefile.files
Normal file
@ -0,0 +1,3 @@
|
||||
VHDL_PKG +=
|
||||
VHDL_TB +=
|
||||
VHDL_SRC += src/CDC_fifoIF.vhd src/dual_port_block_ram.vhd src/SimpleFifo.vhd
|
11
src/Modules/SimpleFifo/README
Normal file
11
src/Modules/SimpleFifo/README
Normal file
@ -0,0 +1,11 @@
|
||||
Simple Fifo
|
||||
--------------------
|
||||
|
||||
|
||||
Simple Fifo is a VHDL Module implementing a very simple Fifo with
|
||||
configurable datawidth and depth...
|
||||
|
||||
It uses a self written clock domain crossing component and a dual port block ram module.
|
||||
|
||||
If you find bugs in these components, please fix them and send a pull request to
|
||||
dmeyer@federationhq.de.
|
137
src/Modules/SimpleFifo/src/CDC_fifoIF.vhd
Normal file
137
src/Modules/SimpleFifo/src/CDC_fifoIF.vhd
Normal file
@ -0,0 +1,137 @@
|
||||
-------------------------------------------------------
|
||||
--! @file
|
||||
--! @brief Clock Domain Crossing Module
|
||||
--! @author Dominik Meyer
|
||||
--! @email dmeyer@federationhq.de
|
||||
--! @date 2013-04-30
|
||||
-------------------------------------------------------
|
||||
|
||||
|
||||
library ieee;
|
||||
use ieee.std_logic_1164.all;
|
||||
use ieee.std_logic_unsigned.all;
|
||||
|
||||
|
||||
--! Clock Domain Crossing Module
|
||||
|
||||
--! This component can be used to cross clock domain borders.
|
||||
--! It is using a handshake protocol to make sure the data
|
||||
--! has travelled across the border
|
||||
entity CDC_fifoIF is
|
||||
generic (
|
||||
GEN_Data_size : integer := 8
|
||||
);
|
||||
port (
|
||||
|
||||
idData : in std_logic_vector(GEN_Data_size-1 downto 0); --! data we want to send cross clock domains
|
||||
icWe : in std_logic; --! data should be written to the other side
|
||||
ocFull : out std_logic; --! module currently holds data
|
||||
icWriteClk : in std_logic; --! write clock
|
||||
|
||||
|
||||
odData : out std_logic_vector(GEN_Data_size-1 downto 0); --! data from the other side
|
||||
ocDataAvail : out std_logic; --! data is available from module
|
||||
icRe : in std_logic; --! ReadEnable signal
|
||||
icReadClk : in std_logic; --! Read Clock
|
||||
|
||||
icReset : in std_logic --! synchronous active high reset, triggered by the Write Clock, has to ne high at least 4 clock ticks
|
||||
);
|
||||
end CDC_fifoIF;
|
||||
|
||||
architecture arch of CDC_fifoIF is
|
||||
|
||||
|
||||
signal srDataIn : std_logic_vector(GEN_Data_size-1 downto 0);
|
||||
signal srDataOut : std_logic_vector(GEN_Data_size-1 downto 0);
|
||||
signal scEnable : std_logic;
|
||||
|
||||
signal scWEnableBuf : std_logic;
|
||||
signal scWEnableBuf2 : std_logic;
|
||||
signal scREnableBuf : std_logic;
|
||||
signal scREnableBuf2 : std_logic;
|
||||
signal scREnableBuf3 : std_logic;
|
||||
signal scREnable : std_logic;
|
||||
|
||||
signal scDataAvail : std_logic;
|
||||
|
||||
|
||||
--
|
||||
-- Input FSM
|
||||
--
|
||||
type INPUT_STATES is (s_start, s_idle, s_hold);
|
||||
signal input_state : INPUT_STATES;
|
||||
|
||||
begin
|
||||
|
||||
ocFull <= scEnable or scREnableBuf3 or scREnableBuf2;
|
||||
ocDataAvail <= (icRe or scDataAvail) and not scREnable;
|
||||
|
||||
|
||||
input : process(icWriteClk)
|
||||
begin
|
||||
if (rising_edge(icWriteClk)) then
|
||||
if (icReset = '1') then
|
||||
|
||||
srDataIn <= (others => '0');
|
||||
scEnable <= '0';
|
||||
scREnableBuf <= '0';
|
||||
scREnableBuf2 <= '0';
|
||||
scREnableBuf3 <= '0';
|
||||
|
||||
else
|
||||
|
||||
if (icWe = '1') then
|
||||
srDataIn <= idData;
|
||||
scEnable <= '1';
|
||||
elsif (scREnableBuf3 = '1') then
|
||||
scEnable <= '0';
|
||||
else
|
||||
scEnable <= scEnable;
|
||||
end if;
|
||||
|
||||
scREnableBuf <= scREnable;
|
||||
scREnableBuf2 <= scREnableBuf;
|
||||
scREnableBuf3 <= scREnableBuf2;
|
||||
|
||||
end if;
|
||||
end if;
|
||||
end process;
|
||||
|
||||
|
||||
|
||||
|
||||
output : process(icReadClk)
|
||||
begin
|
||||
if (rising_edge(icReadClk)) then
|
||||
if (icReset = '1') then
|
||||
scWEnableBuf <= '0';
|
||||
scWEnableBuf2 <= '0';
|
||||
scDataAvail <= '0';
|
||||
srDataOut <= (others => '0');
|
||||
scREnable <= '0';
|
||||
else
|
||||
|
||||
if (icRe = '1') then
|
||||
scREnable <= '1';
|
||||
elsif (scDataAvail = '0') then
|
||||
scREnable <= '0';
|
||||
end if;
|
||||
|
||||
if (scWEnableBuf2 = '1') then
|
||||
srDataOut <= srDataIn;
|
||||
else
|
||||
srDataOut <= srDataOut;
|
||||
end if;
|
||||
|
||||
|
||||
scWEnableBuf <= scEnable;
|
||||
scWEnableBuf2 <= scWEnableBuf;
|
||||
scDataAvail <= scWEnableBuf2;
|
||||
|
||||
end if;
|
||||
end if;
|
||||
end process;
|
||||
|
||||
odData <= srDataOut;
|
||||
|
||||
end arch;
|
325
src/Modules/SimpleFifo/src/SimpleFifo.vhd
Normal file
325
src/Modules/SimpleFifo/src/SimpleFifo.vhd
Normal file
@ -0,0 +1,325 @@
|
||||
-------------------------------------------------------
|
||||
--! @file
|
||||
--! @brief Simple Fifo, using the dual_port_block_ram to work on all FPGAs
|
||||
--! @author Dominik Meyer
|
||||
--! @email dmeyer@federationhq.de
|
||||
--! @licence GPLv2
|
||||
--! @date 2013-11-20
|
||||
-------------------------------------------------------
|
||||
|
||||
library ieee;
|
||||
use ieee.std_logic_1164.all;
|
||||
use ieee.std_logic_unsigned.all;
|
||||
use ieee.std_logic_arith.all;
|
||||
use ieee.math_real.all;
|
||||
|
||||
|
||||
--! Simple Fifo, using the dual_port_block_ram to work on all FPGAs
|
||||
|
||||
--! This is a very simple Fifo !
|
||||
entity SimpleFifo is
|
||||
|
||||
generic (
|
||||
GEN_WIDTH : integer := 8; --! Data width of each data word
|
||||
GEN_DEPTH : integer := 256; --! how many values can be stored in Fifo
|
||||
|
||||
GEN_A_EMPTY : integer := 2; --! when is the FIFO signaled as almost empty
|
||||
GEN_A_FULL : integer := 250 --! when is the FIFO signaled as almost full
|
||||
|
||||
);
|
||||
|
||||
|
||||
port (
|
||||
odData : out std_logic_vector(GEN_WIDTH-1 downto 0); --! Data output of the fifo
|
||||
icReadClk : in std_logic; --! read from fifo clock
|
||||
icReadEnable : in std_logic; --! we have read the value
|
||||
|
||||
|
||||
idData : in std_logic_vector(GEN_WIDTH-1 downto 0); --! data input to fifo
|
||||
icWriteClk : in std_logic; --! clock for writing to the fifo
|
||||
icWe : in std_logic; --! write enable for writing to the fifo
|
||||
|
||||
ocEmpty : out std_logic; --! signal fifo empty
|
||||
ocFull : out std_logic; --! signal fifo full
|
||||
ocAempty : out std_logic; --! signal fifo almost empty
|
||||
ocAfull : out std_logic; --! signal fifo almost full
|
||||
|
||||
icClkEnable : in std_logic; --! active high clock enable signal
|
||||
icReset : in std_logic --! active high reset, values in RAM are not overwritten, just FIFO
|
||||
--! counters are resetted
|
||||
|
||||
);
|
||||
|
||||
|
||||
end SimpleFifo;
|
||||
|
||||
architecture behavioral of SimpleFifo is
|
||||
|
||||
component CDC_fifoIF
|
||||
generic (
|
||||
GEN_Data_size : integer
|
||||
);
|
||||
port (
|
||||
idData : in std_logic_vector ( GEN_Data_size - 1 downto 0 );
|
||||
icWe : in std_logic;
|
||||
ocFull : out std_logic;
|
||||
icWriteClk : in std_logic;
|
||||
odData : out std_logic_vector ( GEN_Data_size - 1 downto 0 );
|
||||
ocDataAvail : out std_logic;
|
||||
icRe : in std_logic;
|
||||
icReadClk : in std_logic;
|
||||
icReset : in std_logic
|
||||
);
|
||||
end component;
|
||||
|
||||
|
||||
component dual_port_block_ram
|
||||
generic (
|
||||
GEN_WIDTH : integer;
|
||||
GEN_DEPTH : integer;
|
||||
GEN_ADDR_SIZE : integer
|
||||
);
|
||||
port (
|
||||
icClkA : in std_logic;
|
||||
icWeA : in std_logic;
|
||||
icEnA : in std_logic;
|
||||
idAddrA : in std_logic_vector ( GEN_ADDR_SIZE - 1 downto 0 );
|
||||
idDataA : in std_logic_vector ( GEN_WIDTH - 1 downto 0 );
|
||||
icClkB : in std_logic;
|
||||
icEnB : in std_logic;
|
||||
idAddrB : in std_logic_vector ( GEN_ADDR_SIZE - 1 downto 0 );
|
||||
odDataB : out std_logic_vector ( GEN_WIDTH - 1 downto 0 )
|
||||
);
|
||||
end component;
|
||||
|
||||
|
||||
--
|
||||
-- General Signals
|
||||
--
|
||||
signal scEmpty : std_logic;
|
||||
signal scFull : std_logic;
|
||||
|
||||
|
||||
--
|
||||
-- Signals for CDC
|
||||
--
|
||||
signal sdRead2WriteIN : std_logic_vector(integer(ceil(log2(real(GEN_DEPTH)))) downto 0);
|
||||
signal sdRead2WriteOut : std_logic_vector(integer(ceil(log2(real(GEN_DEPTH)))) downto 0);
|
||||
signal scRead2WriteWe : std_logic;
|
||||
signal scRead2WriteFull : std_logic;
|
||||
signal scRead2WriteDA : std_logic;
|
||||
signal scRead2WriteRe : std_logic;
|
||||
|
||||
|
||||
signal sdWrite2ReadIN : std_logic_vector(integer(ceil(log2(real(GEN_DEPTH)))) downto 0);
|
||||
signal sdWrite2ReadOUT : std_logic_vector(integer(ceil(log2(real(GEN_DEPTH)))) downto 0);
|
||||
signal scWrite2ReadWe : std_logic;
|
||||
signal scWrite2ReadFull : std_logic;
|
||||
signal scWrite2ReadDA : std_logic;
|
||||
signal scWrite2ReadRe : std_logic;
|
||||
|
||||
--
|
||||
-- Signals for the Read side
|
||||
--
|
||||
signal srReadAddr : std_logic_vector(integer(ceil(log2(real(GEN_DEPTH))))-1 downto 0);
|
||||
signal srReadOverflow : std_logic;
|
||||
signal srWriteAddrRead : std_logic_vector(integer(ceil(log2(real(GEN_DEPTH))))-1 downto 0);
|
||||
signal srWriteOverflowRead : std_logic;
|
||||
|
||||
signal srDataOut : std_logic_vector(GEN_WIDTH - 1 downto 0);
|
||||
signal sdDataOut : std_logic_vector(GEN_WIDTH - 1 downto 0);
|
||||
|
||||
--
|
||||
-- Signals for the Write side
|
||||
--
|
||||
signal srWriteAddr : std_logic_vector(integer(ceil(log2(real(GEN_DEPTH))))-1 downto 0);
|
||||
signal srWriteOverflow : std_logic;
|
||||
signal srReadAddrWrite : std_logic_vector(integer(ceil(log2(real(GEN_DEPTH))))-1 downto 0);
|
||||
signal srReadOverflowWrite : std_logic;
|
||||
|
||||
|
||||
-- signals for RAM
|
||||
signal scRAMwriteEnable : std_logic;
|
||||
|
||||
|
||||
begin
|
||||
|
||||
ocEmpty <= scEmpty;
|
||||
ocFull <= scFull;
|
||||
|
||||
|
||||
scRAMwriteEnable <= not scFull and icWe;
|
||||
|
||||
ram0 : dual_port_block_ram
|
||||
generic map(
|
||||
GEN_WIDTH => GEN_WIDTH,
|
||||
GEN_DEPTH => GEN_DEPTH,
|
||||
GEN_ADDR_SIZE => integer(ceil(log2(real(GEN_DEPTH))))
|
||||
)
|
||||
port map(
|
||||
icClkA => icWriteClk,
|
||||
icWeA => scRAMwriteEnable,
|
||||
icEnA => icClkEnable,
|
||||
idAddrA => srWriteAddr,
|
||||
idDataA => idData,
|
||||
icClkB => icWriteClk,
|
||||
icEnB => icClkEnable,
|
||||
idAddrB => srReadAddr,
|
||||
odDataB => odData
|
||||
);
|
||||
|
||||
scFull <= '1' when srWriteOverflow = '0' and srReadOverflowWrite = '0' and srWriteAddr - srReadAddrWrite >= GEN_DEPTH-1 else
|
||||
'1' when srWriteOverflow = '1' and srReadOverflowWrite = '0' and GEN_DEPTH-srReadAddrWrite+srWriteAddr >= GEN_DEPTH-1 else
|
||||
'1' when srWriteOverflow = '0' and srReadOverflowWrite = '1' and GEN_DEPTH-srReadAddrWrite+srWriteAddr >= GEN_DEPTH-1 else
|
||||
'1' when srWriteOverflow = '1' and srWriteOverflowRead = '1' and srWriteAddr - srReadAddrWrite >= GEN_DEPTH-1 else
|
||||
'0';
|
||||
|
||||
scEmpty <= '1' when srWriteOverflowRead = '0' and srReadOverflow = '0' and srWriteAddrRead - srReadAddr = 0 else
|
||||
'1' when srWriteOverflowRead = '1' and srReadOverflow = '1' and srWriteAddrRead - srReadAddr = 0 else
|
||||
'0';
|
||||
|
||||
|
||||
|
||||
ocAfull <= '1' when srWriteOverflow = '0' and srReadOverflowWrite = '0' and srWriteAddr - srReadAddrWrite >= GEN_A_FULL else
|
||||
'1' when srWriteOverflow = '1' and srReadOverflowWrite = '0' and GEN_DEPTH-srReadAddrWrite+srWriteAddr >= GEN_A_FULL else
|
||||
'1' when srWriteOverflow = '0' and srReadOverflowWrite = '1' and GEN_DEPTH-srReadAddrWrite+srWriteAddr >= GEN_A_FULL else
|
||||
'1' when srWriteOverflow = '1' and srWriteOverflowRead = '1' and srWriteAddr - srReadAddrWrite >= GEN_A_FULL else
|
||||
'0';
|
||||
|
||||
|
||||
ocAempty <= '1' when srWriteOverflow = '0' and srReadOverflowWrite = '0' and srWriteAddr - srReadAddrWrite <= GEN_A_EMPTY else
|
||||
'1' when srWriteOverflow = '1' and srReadOverflowWrite = '0' and GEN_DEPTH-srReadAddrWrite+srWriteAddr <= GEN_A_EMPTY else
|
||||
'1' when srWriteOverflow = '0' and srReadOverflowWrite = '1' and GEN_DEPTH-srReadAddrWrite+srWriteAddr <= GEN_A_EMPTY else
|
||||
'1' when srWriteOverflow = '1' and srWriteOverflowRead = '1' and srWriteAddr - srReadAddrWrite <= GEN_A_EMPTY else
|
||||
'0';
|
||||
|
||||
|
||||
-- write FSM
|
||||
Writefsm : process(icWriteClk)
|
||||
begin
|
||||
if (rising_edge(icWriteClk)) then
|
||||
if (icReset = '1') then
|
||||
|
||||
srWriteAddr <= (others => '0');
|
||||
srWriteOverflow <= '0';
|
||||
|
||||
srReadAddrWrite <= (others => '0');
|
||||
srReadOverflowWrite <= '0';
|
||||
|
||||
elsif (icClkEnable = '1') then
|
||||
|
||||
if (scWrite2ReadFull = '0') then
|
||||
scWrite2ReadWe <= '1';
|
||||
else
|
||||
scWrite2ReadWe <= '0';
|
||||
end if;
|
||||
|
||||
if (scRead2WriteDA = '1') then
|
||||
scRead2WriteRe <= '1';
|
||||
srReadAddrWrite <= sdRead2WriteOUT(integer(ceil(log2(real(GEN_DEPTH)))) downto 1);
|
||||
srReadOverflowWrite <= sdRead2WriteOUT(0);
|
||||
else
|
||||
scRead2WriteRe <= '0';
|
||||
end if;
|
||||
|
||||
if (icWe = '1' and scFull = '0') then
|
||||
if (srWriteAddr >= GEN_DEPTH-1 ) then
|
||||
srWriteAddr <= (others => '0');
|
||||
srWriteOverflow <= not srWriteOverflow;
|
||||
else
|
||||
srWriteAddr <= srWriteAddr + 1;
|
||||
end if;
|
||||
end if;
|
||||
|
||||
end if;
|
||||
end if;
|
||||
end process;
|
||||
|
||||
|
||||
cdcWrite2Read : CDC_fifoIF
|
||||
generic map(
|
||||
GEN_Data_size => integer(ceil(log2(real(GEN_DEPTH))))+1
|
||||
)
|
||||
port map(
|
||||
idData => sdWrite2ReadIN,
|
||||
icWe => scWrite2ReadWe,
|
||||
ocFull => scWrite2ReadFull,
|
||||
icWriteClk => icWriteClk,
|
||||
odData => sdWrite2ReadOUT,
|
||||
ocDataAvail => scWrite2ReadDA,
|
||||
icRe => scWrite2ReadRe,
|
||||
icReadClk => icReadClk,
|
||||
icReset => icReset
|
||||
);
|
||||
|
||||
|
||||
sdWrite2ReadIN <= srWriteAddr & srWriteOverflow;
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
-- write FSM
|
||||
Readfsm : process(icReadClk)
|
||||
begin
|
||||
if (rising_edge(icReadClk)) then
|
||||
if (icReset = '1') then
|
||||
|
||||
srReadAddr <= (others => '0');
|
||||
srWriteAddrRead <= (others => '0');
|
||||
srWriteOverflowRead <= '0';
|
||||
srReadOverflow <= '0';
|
||||
|
||||
elsif (icClkEnable = '1') then
|
||||
|
||||
if (scRead2WriteFull = '0') then
|
||||
scRead2WriteWe <= '1';
|
||||
else
|
||||
scRead2WriteWe <= '0';
|
||||
end if;
|
||||
|
||||
if (scWrite2ReadDA = '1') then
|
||||
scWrite2ReadRe <= '1';
|
||||
srWriteAddrRead <= sdWrite2ReadOUT(integer(ceil(log2(real(GEN_DEPTH)))) downto 1);
|
||||
srWriteOverflowRead <= sdWrite2ReadOut(0);
|
||||
else
|
||||
scWrite2ReadRe <= '0';
|
||||
end if;
|
||||
|
||||
if (icReadEnable = '1' and scEmpty = '0') then
|
||||
if (srReadAddr >= GEN_DEPTH-1) then
|
||||
srReadAddr <= (others => '0');
|
||||
srReadOverflow <= not srReadOverflow;
|
||||
else
|
||||
srReadAddr <= srReadAddr + 1;
|
||||
end if;
|
||||
end if;
|
||||
|
||||
end if;
|
||||
end if;
|
||||
end process;
|
||||
|
||||
|
||||
cdcRead2Write : CDC_fifoIF
|
||||
generic map(
|
||||
GEN_Data_size => integer(ceil(log2(real(GEN_DEPTH))))+1
|
||||
)
|
||||
port map(
|
||||
idData => sdRead2WriteIN,
|
||||
icWe => scRead2WriteRe,
|
||||
ocFull => scRead2WriteFull,
|
||||
icWriteClk => icWriteClk,
|
||||
odData => sdRead2WriteOut,
|
||||
ocDataAvail => scRead2WriteDA,
|
||||
icRe => scRead2WriteRe,
|
||||
icReadClk => icReadClk,
|
||||
icReset => icReset
|
||||
);
|
||||
|
||||
|
||||
|
||||
sdRead2WriteIN <= srReadAddr & srReadOverflow;
|
||||
|
||||
|
||||
|
||||
end behavioral;
|
81
src/Modules/SimpleFifo/src/dual_port_block_ram.vhd
Normal file
81
src/Modules/SimpleFifo/src/dual_port_block_ram.vhd
Normal file
@ -0,0 +1,81 @@
|
||||
-------------------------------------------------------
|
||||
--! @file
|
||||
--! @brief dual port block ram description - write to one port, read from the other
|
||||
--! @author Dominik Meyer
|
||||
--! @email dmeyer@federationhq.de
|
||||
--! @licence GPLv2
|
||||
--! @date 2013-11-20
|
||||
-------------------------------------------------------
|
||||
library ieee;
|
||||
use ieee.std_logic_1164.all;
|
||||
use ieee.std_logic_unsigned.all;
|
||||
use ieee.std_logic_arith.all;
|
||||
|
||||
|
||||
--! dual port block ram description - write to one port, read from the other
|
||||
|
||||
--! dual port block ream description
|
||||
--! Port A is used for writing to the ram, while Port B is used for reading only.
|
||||
--! written in a way that the Xilinx Tools will use the onboard block ram
|
||||
--! if available, otherwise using logic cells
|
||||
entity dual_port_block_ram is
|
||||
|
||||
generic (
|
||||
GEN_WIDTH : integer := 8; --! the width of one data word
|
||||
GEN_DEPTH : integer := 256; --! how many words should be storeable in the ram
|
||||
GEN_ADDR_SIZE : integer := 8 --! how many address bits shall be used
|
||||
|
||||
);
|
||||
|
||||
|
||||
port (
|
||||
icClkA : in std_logic; --! clock for port A
|
||||
icWeA : in std_logic; --! active high write enable for port A
|
||||
icEnA : in std_logic; --! active high enable for port A
|
||||
idAddrA : in std_logic_vector(GEN_ADDR_SIZE - 1 downto 0); --! address for port A
|
||||
idDataA : in std_logic_vector(GEN_WIDTH - 1 downto 0); --! data input for port A
|
||||
|
||||
icClkB : in std_logic; --! clock for port B
|
||||
icEnB : in std_logic; --! active high enable signal for port B
|
||||
idAddrB : in std_logic_vector(GEN_ADDR_SIZE - 1 downto 0); --! address for port B
|
||||
odDataB : out std_logic_vector(GEN_WIDTH - 1 downto 0) --! data output of port B
|
||||
|
||||
);
|
||||
|
||||
end dual_port_block_ram;
|
||||
|
||||
architecture behavioral of dual_port_block_ram is
|
||||
|
||||
type ramType is array (0 to GEN_DEPTH-1) of std_logic_vector(GEN_WIDTH-1 downto 0);
|
||||
signal ram : ramType := (others => (others => '0'));
|
||||
|
||||
signal sdDataOut : std_logic_vector(GEN_WIDTH-1 downto 0);
|
||||
|
||||
begin
|
||||
|
||||
portA : process(icClkA)
|
||||
begin
|
||||
if (rising_edge(icClkA)) then
|
||||
if (icEnA = '1') then
|
||||
if (icWeA = '1') then
|
||||
ram(conv_integer(idAddrA)) <= idDataA;
|
||||
end if;
|
||||
end if;
|
||||
end if;
|
||||
end process;
|
||||
|
||||
|
||||
|
||||
portB : process(icClkB)
|
||||
begin
|
||||
if (rising_edge(icClkB)) then
|
||||
if (icEnB = '1') then
|
||||
sdDataOut <= ram(conv_integer(idAddrB));
|
||||
end if;
|
||||
end if;
|
||||
|
||||
end process;
|
||||
|
||||
odDataB <= sdDataOut;
|
||||
|
||||
end behavioral;
|
Loading…
Reference in New Issue
Block a user