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, 125 insertions, 0 deletions

diff --git a/fpga/usrp3/sim/general/sim_file_io.svh b/fpga/usrp3/sim/general/sim_file_io.svh
new file mode 100644
index 000000000..97fadd741
--- /dev/null
+++ b/fpga/usrp3/sim/general/sim_file_io.svh
@@ -0,0 +1,125 @@
+//
+// Copyright 2015 Ettus Research LLC
+//
+
+`ifndef WORKING_DIR
+  `define WORKING_DIR "."
+`endif
+
+`define ABSPATH(name) {`WORKING_DIR, "/", name}
+
+typedef enum {
+  READ, WRITE, APPEND
+} fopen_mode_t;
+
+typedef enum {
+  HEX, DEC, OCT, BIN, FLOAT
+} fformat_t;
+
+// Create a handle to a data_file with
+// - FILENAME: Name of the file
+// - FORMAT: Data format (HEX, DEC, OCT, BIN, FLOAT)
+// - DWIDTH: Width of each element stored in the file (one line per word)
+//
+
+//TODO: We would ideally use a class but that is not
+//      supported by most simulators.
+interface data_file_t #(
+  parameter FILENAME = "test.hex", 
+  parameter FORMAT = HEX, 
+  parameter DWIDTH = 64
+) (input clk);
+  bit     is_open;
+  integer handle;
+
+  // Open the data file for reading or writing.
+  //
+  // Usage: open(mode)
+  // where
+  //  - mode: RW mode (Choose from: READ, WRITE, APPEND)
+  //
+  function open(fopen_mode_t mode = READ);
+    if (mode == APPEND)
+      handle  = $fopen(`ABSPATH(FILENAME), "a");
+    else if (mode == WRITE)
+      handle  = $fopen(`ABSPATH(FILENAME), "w");
+    else
+      handle  = $fopen(`ABSPATH(FILENAME), "r");
+
+    if (handle == 0) begin
+      $error("Could not open file: %s", `ABSPATH(FILENAME));
+      $finish();
+    end
+    is_open = 1;
+  endfunction
+
+
+  // Close an open data file. No-op if file isn't already open
+  //
+  // Usage: close()
+  //
+  function close();
+    $fclose(handle);
+    handle  = 0;
+    is_open = 0;
+  endfunction
+
+  // Is end-of-file reached.
+  //
+  // Usage: is_eof() Returns eof
+  // where
+  // - eof: A boolean
+  //
+  function logic is_eof();
+    return ($feof(handle));
+  endfunction
+
+  // Read a line from the datafile
+  //
+  // Usage: readline() Returns data
+  // where
+  // - data: A logic array of width DWIDTH containing the read word
+  //
+  function logic [DWIDTH-1:0] readline();
+    automatic logic [DWIDTH-1:0] word = 64'h0;
+    automatic integer status;
+
+    if (FORMAT == HEX)
+      status = $fscanf(handle, "%x\n", word);
+    else if (FORMAT == DEC)
+      status = $fscanf(handle, "%d\n", word);
+    else if (FORMAT == OCT)
+      status = $fscanf(handle, "%o\n", word);
+    else if (FORMAT == BIN)
+      status = $fscanf(handle, "%b\n", word);
+    else if (FORMAT == DEC)
+      status = $fscanf(handle, "%g\n", word);
+    else
+      $error("Invalid format");
+
+    return word;
+  endfunction
+
+  // Write a line to the datafile
+  //
+  // Usage: writeline(data) 
+  // where
+  // - data: A logic array of width DWIDTH to write to the file
+  //
+  function void writeline(logic [DWIDTH-1:0] word);
+    if (FORMAT == HEX)
+      $fdisplay(handle, "%x", word);
+    else if (FORMAT == DEC)
+      $fdisplay(handle, "%d", word);
+    else if (FORMAT == OCT)
+      $fdisplay(handle, "%o", word);
+    else if (FORMAT == BIN)
+      $fdisplay(handle, "%b", word);
+    else if (FORMAT == DEC)
+      $fdisplay(handle, "%g", word);
+    else
+      $error("Invalid format");
+  endfunction
+
+endinterface
+