Merge FPGA repository back into UHD repository

The FPGA codebase was removed from the UHD repository in 2014 to reduce
the size of the repository. However, over the last half-decade, the
split between the repositories has proven more burdensome than it has
been helpful. By merging the FPGA code back, it will be possible to
create atomic commits that touch both FPGA and UHD codebases. Continuous
integration testing is also simplified by merging the repositories,
because it was previously difficult to automatically derive the correct
UHD branch when testing a feature branch on the FPGA repository.

This commit also updates the license files and paths therein.

We are therefore merging the repositories again. Future development for
FPGA code will happen in the same repository as the UHD host code and
MPM code.

== Original Codebase and Rebasing ==

The original FPGA repository will be hosted for the foreseeable future
at its original local location: https://github.com/EttusResearch/fpga/

It can be used for bisecting, reference, and a more detailed history.

The final commit from said repository to be merged here is
05003794e2da61cabf64dd278c45685a7abad7ec. This commit is tagged as
v4.0.0.0-pre-uhd-merge.

If you have changes in the FPGA repository that you want to rebase onto
the UHD repository, simply run the following commands:

- Create a directory to store patches (this should be an empty
  directory):

    mkdir ~/patches

- Now make sure that your FPGA codebase is based on the same state as
  the code that was merged:

    cd src/fpga # Or wherever your FPGA code is stored
    git rebase v4.0.0.0-pre-uhd-merge

  Note: The rebase command may look slightly different depending on what
  exactly you're trying to rebase.

- Create a patch set for your changes versus v4.0.0.0-pre-uhd-merge:

    git format-patch v4.0.0.0-pre-uhd-merge -o ~/patches

  Note: Make sure that only patches are stored in your output directory.
  It should otherwise be empty. Make sure that you picked the correct
  range of commits, and only commits you wanted to rebase were exported
  as patch files.

- Go to the UHD repository and apply the patches:

    cd src/uhd # Or wherever your UHD repository is stored
    git am --directory fpga ~/patches/*
    rm -rf ~/patches # This is for cleanup

== Contributors ==

The following people have contributed mainly to these files (this list
is not complete):

Co-authored-by: Alex Williams <alex.williams@ni.com>
Co-authored-by: Andrej Rode <andrej.rode@ettus.com>
Co-authored-by: Ashish Chaudhari <ashish@ettus.com>
Co-authored-by: Ben Hilburn <ben.hilburn@ettus.com>
Co-authored-by: Ciro Nishiguchi <ciro.nishiguchi@ni.com>
Co-authored-by: Daniel Jepson <daniel.jepson@ni.com>
Co-authored-by: Derek Kozel <derek.kozel@ettus.com>
Co-authored-by: EJ Kreinar <ej@he360.com>
Co-authored-by: Humberto Jimenez <humberto.jimenez@ni.com>
Co-authored-by: Ian Buckley <ian.buckley@gmail.com>
Co-authored-by: Jörg Hofrichter <joerg.hofrichter@ni.com>
Co-authored-by: Jon Kiser <jon.kiser@ni.com>
Co-authored-by: Josh Blum <josh@joshknows.com>
Co-authored-by: Jonathon Pendlum <jonathan.pendlum@ettus.com>
Co-authored-by: Martin Braun <martin.braun@ettus.com>
Co-authored-by: Matt Ettus <matt@ettus.com>
Co-authored-by: Michael West <michael.west@ettus.com>
Co-authored-by: Moritz Fischer <moritz.fischer@ettus.com>
Co-authored-by: Nick Foster <nick@ettus.com>
Co-authored-by: Nicolas Cuervo <nicolas.cuervo@ettus.com>
Co-authored-by: Paul Butler <paul.butler@ni.com>
Co-authored-by: Paul David <paul.david@ettus.com>
Co-authored-by: Ryan Marlow <ryan.marlow@ettus.com>
Co-authored-by: Sugandha Gupta <sugandha.gupta@ettus.com>
Co-authored-by: Sylvain Munaut <tnt@246tNt.com>
Co-authored-by: Trung Tran <trung.tran@ettus.com>
Co-authored-by: Vidush Vishwanath <vidush.vishwanath@ettus.com>
Co-authored-by: Wade Fife <wade.fife@ettus.com>

1 files changed, 128 insertions, 0 deletions

diff --git a/fpga/usrp3/lib/vivado_ipi/axi_bitq/bitq_fsm.vhd b/fpga/usrp3/lib/vivado_ipi/axi_bitq/bitq_fsm.vhd
new file mode 100644
index 000000000..ed7ab4a50
--- /dev/null
+++ b/fpga/usrp3/lib/vivado_ipi/axi_bitq/bitq_fsm.vhd
@@ -0,0 +1,128 @@
+--
+-- Copyright 2018 Ettus Research, A National Instruments Company
+--
+-- SPDX-License-Identifier: LGPL-3.0
+--
+-- Module: bitq_fsm
+-- Description: Simple IP to shift bits in/out (primarily for JTAG)
+-- bitq_fsm implements the state machine underlying the IP
+
+library ieee;
+use ieee.std_logic_1164.all;
+use ieee.numeric_std.all;
+
+entity bitq_fsm is
+port (
+  clk  : in std_logic;
+  rstn : in std_logic;
+  prescalar : in std_logic_vector(7 downto 0);
+
+  bit_clk  : inout std_logic;
+  bit_in   : in    std_logic;
+  bit_out  : inout std_logic;
+  bit_stb  : inout std_logic;
+  start    : in std_logic;
+  ready    : out std_logic;
+  len      : in std_logic_vector(4 downto 0);
+  wr_data  : in std_logic_vector(31 downto 0);
+  stb_data : in std_logic_vector(31 downto 0);
+  rd_data  : out std_logic_vector(31 downto 0)
+
+);
+
+end bitq_fsm;
+
+architecture arch of bitq_fsm is
+  type bitq_state_t is (IDLE, LOW, HIGH);
+  signal bitq_state : bitq_state_t;
+
+  signal bit_clk_count  : unsigned(7 downto 0);
+  signal bit_count  : unsigned(5 downto 0);
+
+  signal bit_out_r  : std_logic;
+  signal bit_stb_r  : std_logic;
+
+  signal rd_data_r  : std_logic_vector(31 downto 0);
+
+begin
+  rd_data <= rd_data_r;
+
+  gen_io : process (bitq_state, bit_count, bit_out_r, bit_stb_r)
+  begin
+    case (bitq_state) is
+    when IDLE =>
+      bit_clk <= 'Z';
+      bit_out <= 'Z';
+      bit_stb <= 'Z';
+      ready   <= '1';
+    when LOW =>
+      bit_clk <= '0';
+      bit_out <= bit_out_r;
+      bit_stb <= bit_stb_r;
+      ready <= '0';
+    when HIGH =>
+      bit_clk <= '1';
+      bit_out <= bit_out_r;
+      bit_stb <= bit_stb_r;
+      ready <= '0';
+    when others =>
+      bit_clk <= 'Z';
+      bit_out <= 'Z';
+      bit_stb <= 'Z';
+      ready   <= '1';
+    end case;
+  end process;
+
+  bit_clk_gen : process (clk)
+  begin
+  if rising_edge(clk) then
+    if (rstn = '0') or (bitq_state = IDLE) or
+       (bit_clk_count = 0) then
+      bit_clk_count <= unsigned(prescalar);
+    elsif (bit_clk_count /= 0) then
+      bit_clk_count <= bit_clk_count - 1;
+    end if;
+  end if;
+  end process bit_clk_gen;
+
+  fsm : process (clk)
+  begin
+  if rising_edge(clk) then
+    if (rstn = '0') then
+      bitq_state <= IDLE;
+      bit_count <= to_unsigned(0, bit_count'length);
+      rd_data_r <= (others => '0');
+    else
+      case bitq_state is
+      when IDLE =>
+        bit_count <= to_unsigned(0, bit_count'length);
+
+        if (start = '1') then
+          bitq_state <= LOW;
+          rd_data_r <= (others => '0');
+          bit_out_r <= wr_data(0);
+          bit_stb_r <= stb_data(0);
+        end if;
+      when LOW =>
+        if (bit_clk_count = 0) then
+          rd_data_r(to_integer(bit_count)) <= bit_in;
+          bit_count <= bit_count + 1;
+          bitq_state <= HIGH; --Rising edge
+        end if;
+      when HIGH =>
+        if (bit_clk_count = 0) then
+          if (bit_count > unsigned('0' & len)) then
+            bitq_state <= IDLE;
+          else
+            bit_out_r <= wr_data(to_integer(bit_count));
+            bit_stb_r <= stb_data(to_integer(bit_count));
+            bitq_state <= LOW; --Falling edge
+          end if;
+        end if;
+      end case;
+    end if;
+  end if;
+  end process fsm;
+
+end arch;
+