tb_arith_encoder.sv

module tb_arith_encoder_full #(
  parameter TB_RANGE_WIDTH = 16,      // These parameters (lines 2 to 7) represent the architecture parameters
  parameter TB_LOW_WIDTH = 24,      // They must be changed ONLY IF THERE ARE CHANGES IN THE ARCHITECTURE
  parameter TB_SYMBOL_WIDTH = 4,      // Changing these parameters WILL NOT ensure a correct execution by the architecture
  parameter TB_LUT_ADDR_WIDTH = 8,    // All changes on these parameters must be analyzed before and change some internal defaults in the architecture
  parameter TB_LUT_DATA_WIDTH = 16,
  parameter TB_D_SIZE = 5,
  parameter SELECT_VIDEO = 7,     // 0- Miss America 150frames 176x144 (Only 100 rows)
                    // 1- Miss America 150frames 176x144 (Entire Video)
                    // 2- Akiyo 300frames 176x144 (Entire Video)
                    // 3- Akiyo 300frames 176x144 (Only 100 rows)
                    // 4- Bowing 300frames (Entire Video)
                    // 5- Carphone 382frames 176x144 (Entire Video)
                    // 6- Bus 150frames 352x288 (Entire Video)
                    // 7- Beauty 1920x1080 120fps 420 8bit YUV
                    // 8- Bosphorus 1920x1080 120fps 420 8bit YUV
                    // 9- HoneyBee 1920x1080 120fps 420 8bit YUV
  parameter RUN_UNTIL_FIRST_MISS = 1, // With this option in 1, the simulation will stop as soon as it gets the first miss
                    // It doesn't matter if the miss is with Range or low
                    // 0- Run until the end of the simulation and count misses and matches
                    // 1- Stop when find the first miss
  parameter PIPELINE_STAGES = 3     // This variable defines the number of pipeline stages
                    // If the pipeline changes, many things will need to change in the testbench
                    // This variable will make it easier to change things here
  )();

  // File read variables
  int fd;
  int temp_fl, temp_fh, temp_symbol, temp_nsyms, temp_bool;   // inputs
  int temp_range, temp_low;         // verification variables (final numbers for low and range)
  int temp_init_range, temp_init_low;   // reset variables (verify is these variables are 32768 and 0, respectively)
  int status;   // check if the file was correctly read
  // Extra variables that comes from the file
  int temp_norm_in_rng, temp_norm_in_low; // these variables are contained in the file as the input for the normalization function
  // ---------------------------------
  // Verification variables
  int i, reset_sign_return;   // variable use for control
  int frame_counter, general_counter, reset_counter;     // the General counter will be responsible to keep track of the architecture in general while the counter frame will count only the execution while in a frame
  int verify_range[PIPELINE_STAGES+1], verify_low[PIPELINE_STAGES+1];  // general counter and low/range arrays to verify the value PIPELINE_STAGES later
                                          // As this TB doesn't save all the numbers from the input file and the current input won't result in an imidiate result
                                          // It is necessary to keep the output value saved to be compare PIPELINE_STAGES later, when the input will be finally ready.
  int verify_read, verify_save;
  int match_counter_range, miss_counter_range;    // variables to keep track of how many matches and misses were detected regarding the range value
  int match_counter_low, miss_counter_low;      // variables to keep track of how many matches and misses were detected regading the low value
  int previous_range_out, previous_low_out;   // these variable are part of the reset detection
                        // It is defined a reset when:
                          // 1- Low_input = 0 AND Range_input = 32768
                          // 2- Low_input != Previous_low_output AND Range_input != Previous_range_output
  // ---------------------------------
  // Architecture "conversation" variables
  // Here are declared all variables representing the inputs and outputs of the architecture.
  // Setting the REG variables here will automatically set the architecture's input pins
  reg tb_clk, tb_reset;
  reg [(TB_RANGE_WIDTH-1):0] tb_fl, tb_fh;
  reg [(TB_SYMBOL_WIDTH-1):0] tb_symbol;
  reg [TB_SYMBOL_WIDTH:0] tb_nsyms;
  reg tb_bool;
  wire [(TB_RANGE_WIDTH-1):0] tb_range;
  wire [(TB_LOW_WIDTH-1):0] tb_low;
  wire [(TB_D_SIZE-1):0] tb_cnt_output;
  wire [(TB_RANGE_WIDTH-1):0] tb_bit_out_1, tb_bit_out_2;
  wire [1:0] tb_flag_out;
  // ---------------------------------
  // Architecture declaration
  arithmetic_encoder #(
    .GENERAL_RANGE_WIDTH (TB_RANGE_WIDTH),
    .GENERAL_LOW_WIDTH (TB_LOW_WIDTH),
    .GENERAL_SYMBOL_WIDTH (TB_SYMBOL_WIDTH),
    .GENERAL_LUT_ADDR_WIDTH (TB_LUT_ADDR_WIDTH),
    .GENERAL_LUT_DATA_WIDTH (TB_LUT_DATA_WIDTH),
    .GENERAL_D_SIZE (TB_D_SIZE)
    ) arith_encoder (
      .general_clk (tb_clk),
      .reset (tb_reset),
      .general_fl (tb_fl),
      .general_fh (tb_fh),
      .general_symbol (tb_symbol),
      .general_nsyms (tb_nsyms),
      .general_bool (tb_bool),
      // outputs
      .RANGE_OUTPUT (tb_range),
      .LOW_OUTPUT (tb_low),
      .CNT_OUTPUT (tb_cnt_output),
      .OUT_BIT_1 (tb_bit_out_1),
      .OUT_BIT_2 (tb_bit_out_2),
      .OUT_FLAG_BITSTREAM (tb_flag_out)
    );
  // ---------------------------------

  always #1ns tb_clk <= ~tb_clk;    // Here is the Clock (clk) generator
                    // It is set to execute in a 12ns period
  function void open_file;
    case(SELECT_VIDEO)
      0 : begin
        $display("\t-> Video selected: Miss America 150 frames 176x144 (Only 100 rows)\n");
        fd = $fopen("C:/Users/Tulio/Desktop/arithmetic_encoder_av1/verification_area/simulation_data/full_data/new-data-miss-video_100-rows.csv", "r");
      end
      1 : begin
        $display("\t-> Video selected: Miss America 150 frames 176x144 (Entire Video)\n");
        fd = $fopen("C:/Users/Tulio/Desktop/arithmetic_encoder_av1/verification_area/simulation_data/videos/miss-america_150frames_176x144.csv", "r");
      end
      2 : begin
        $display("\t-> Video selected: Akiyo 300 frames 176x144 (Entire Video)\n");
        fd = $fopen("C:/Users/Tulio/Desktop/arithmetic_encoder_av1/verification_area/simulation_data/entropy_encoder/akiyo_300frames_176x144_main_data.csv", "r");
      end
      3 : begin
        $display("\t-> Video selected: Akiyo 300 frames 176x144 (Only 100 rows)\n");
        fd = $fopen("C:/Users/Tulio/Desktop/arithmetic_encoder_av1/verification_area/simulation_data/full_data/akiyo_300frames_176x144_100-rows.csv", "r");
      end
      4 : begin
        $display("\t-> Video selected: Bowing 300frames (Entire Video)\n");
        fd = $fopen("C:/Users/Tulio/Desktop/arithmetic_encoder_av1/verification_area/simulation_data/videos/bowing_300frames.csv", "r");
      end
      5 : begin
        $display("\t-> Video selected: Carphone 382frames 176x144 (Entire Video)\n");
        fd = $fopen("C:/Users/Tulio/Desktop/arithmetic_encoder_av1/verification_area/simulation_data/videos/carphone_382frames_176x144.csv", "r");
      end
      6 : begin
        $display("\t-> Video selected: Bus 150frames 352x288 (Entire Video)\n");
        fd = $fopen("C:/Users/Tulio/Desktop/arithmetic_encoder_av1/verification_area/simulation_data/videos/bus_150frames_352x288.csv", "r");
      end
      7 : begin
        $display("\t-> Video selected: Beauty 1920x1080 120fps 420 8bit YUV\n");
        fd = $fopen("F:/y4m_files/generated_files/cq_55/Beauty_1920x1080_120fps_420_8bit_YUV_cq55_main_data.csv", "r");
      end
      8 : begin
        $display("\t-> Video selected: Bosphorus 1920x1080 120fps 420 8bit YUV\n");
        fd = $fopen("C:/Users/Tulio/Desktop/arithmetic_encoder_av1/verification_area/simulation_data/entropy_encoder/1080p/Bosphorus_1920x1080_120fps_420_8bit_YUV_main_data.csv", "r");
      end
      9 : begin
        $display("\t-> Video selected: HoneyBee 1920x1080 120fps 420 8bit YUV\n");
        fd = $fopen("C:/Users/Tulio/Desktop/arithmetic_encoder_av1/verification_area/simulation_data/entropy_encoder/1080p/HoneyBee_1920x1080_120fps_420_8bit_YUV_main_data.csv", "r");
      end
    endcase
  endfunction
  function void reset_function;
    input int start_flag;   // start flag will define if the testbench variable will or won't be resetted
                // in the case of a reset between frames, it is necessary to keep the counter and miss/matches variables
    // This function is responsible for the reset procedure
    // Always when the testbench starts, the reset procedure will be called with the start flag 1 and important verification variables will be resetted as necessary
    // However, sometimes this function will be called only as a reset between frames, where some of the variable will be resetted
    if(start_flag) begin
      $display("\t-> Resetting testbench variables\n");
      reset_counter = 0;
      general_counter = 0;
      miss_counter_low = 0;
      match_counter_low = 0;
      miss_counter_range = 0;
      match_counter_range = 0;
    end
    //$display("\t\t-> Resetting verification arrays\n");
    frame_counter = 0;
    verify_read = 1;
    verify_save = 0;
    if(start_flag) begin
      $display("\t-> Reading first line of the file\n");
      status = $fscanf (fd, "%d;%d;%d;%d;%d;%d;%d;%d;%d;%d;%d;\n", temp_bool, temp_init_range, temp_init_low, temp_fl, temp_fh, temp_symbol, temp_nsyms, temp_norm_in_rng, temp_norm_in_low, temp_range, temp_low);
      if(status != 11) begin
        $display("\t-> Problem reading the file\n-> Closing testbench\n");
        $stop;
      end else begin
        $display("\t\t-> Setting architecture inputs\n");
        tb_bool = temp_bool;
        tb_fl = temp_fl;
        tb_fh = temp_fh;
        tb_symbol = temp_symbol;
        tb_nsyms = temp_nsyms;
        verify_low[verify_save] = temp_low;
        verify_range[verify_save] = temp_range;
        tb_reset <= 1'b1;
        $display("\t\t-> Saving verification arrays\n");
        $display("\t\t-> Updating pointers' values\n");
        verify_save = verify_save + 1;
        verify_read = verify_read + 1;
        general_counter = general_counter + 1;
        frame_counter = general_counter;
      end
    end else begin
      tb_bool = temp_bool;
      tb_fl = temp_fl;
      tb_fh = temp_fh;
      tb_symbol = temp_symbol;
      tb_nsyms = temp_nsyms;
      verify_low[verify_save] = temp_low;
      verify_range[verify_save] = temp_range;
      tb_reset <= 1'b1;
      update_array_pointers();
    end
  endfunction
  function void update_array_pointers;
    frame_counter = frame_counter + 1;
    if(verify_save >= PIPELINE_STAGES)
      verify_save = 0;
    else
      verify_save = verify_save + 1;

    if(verify_read >= PIPELINE_STAGES)
      verify_read = 0;
    else
      verify_read = verify_read + 1;
  endfunction
  function void finish_execution;
    if(tb_range != verify_range[verify_read]) begin
      miss_counter_range = miss_counter_range + 1;
      if(RUN_UNTIL_FIRST_MISS) begin
        $display("%d-> Range doesn't match with expected. \t%d, got %d\n", general_counter, verify_range[verify_read], tb_range);
        statistic(2);
      end
    end else begin
      match_counter_range = match_counter_range + 1;
    end
    if(tb_low != verify_low[verify_read]) begin
      miss_counter_low = miss_counter_low + 1;
      if(RUN_UNTIL_FIRST_MISS) begin
        $display("%d-> Low doesn't match with expected. \t%d, got %d\n", general_counter, verify_low[verify_read], tb_low);
        statistic(2);
      end
    end else begin
      match_counter_low = match_counter_low + 1;
    end
    update_array_pointers();
  endfunction
  function void statistic;
    input int info_flag;    // This flag will define how the simulation was stopped
                  // 0- normal stop
                  // 1- forced stop by mismatch with data in the main simulation
                  // 2- forced stop called by finish_execution function
                  // 3- forced stop -> problem reading file
    case(info_flag)
      0 : $display("==============\nDone with simulation\n=============\n");
      1 : $display("==============\nSimulation Stopped: mismatch in the main execution\n=============\n");
      2 : $display("==============\nSimulation stopped: problem with finish_execution function\n=============\n");
      3 : $display("==============\nSimulation stopped: problem reading the file\n=============\n");
    endcase
    $display("Statistics:\n");
    $display("Total simulations: %d\nTotal matches: %d\nTotal misses: %d\nTotal resets: %d\n", general_counter, match_counter_low+match_counter_range, miss_counter_low+miss_counter_range, reset_counter);
    $display("-------------------\n");
    $display("Range: \n\tMatches: %d\n\tMisses: %d\n", match_counter_range, miss_counter_range);
    $display("-------------------\n");
    $display("Low: \n\tMatches: %d\n\tMisses: %d\n", match_counter_low, miss_counter_low);
    $timeformat(-9, 7, " s", 32);
    $display("Execution time: %t\n", $time);
    $display("==============\nStatistics completed\n=============\n");
    $fclose(fd);
    $stop;
  endfunction
  function int run_simulation;
    status = $fscanf (fd, "%d;%d;%d;%d;%d;%d;%d;%d;%d;%d;%d;\n", temp_bool, temp_init_range, temp_init_low, temp_fl, temp_fh, temp_symbol, temp_nsyms, temp_norm_in_rng, temp_norm_in_low, temp_range, temp_low);
    general_counter = general_counter + 1;
    if(status != 11) begin
      $display("\t-> Problem reading file: %d\n", general_counter);
      statistic(3);
    end
    else begin
      if((temp_init_low == 0) && (temp_init_range == 32768) && ((temp_init_low != previous_low_out) || (temp_init_range != previous_range_out))) begin
        reset_counter = reset_counter + 1;
        $display("\t-> %d: Reset detected -> %d\n", general_counter, reset_counter);
        return 1;     // found a reset
      end else begin
        // reset detection: set the previous low and range to be used in the next execution
        previous_range_out = temp_range;
        previous_low_out = temp_low;
        // -----------------------------
        tb_bool = temp_bool;
        tb_fl = temp_fl;
        tb_fh = temp_fh;
        tb_symbol = temp_symbol;
        tb_nsyms = temp_nsyms;
        verify_range[verify_save] = temp_range;
        verify_low[verify_save] = temp_low;
        if(frame_counter > 2) begin
          if(verify_range[verify_read] != tb_range) begin
            miss_counter_range = miss_counter_range + 1;
            if(RUN_UNTIL_FIRST_MISS) begin
              $display("%d-> Range doesn't match with expected. \t%d, got %d\n", general_counter, verify_range[verify_read], tb_range);
              statistic(1);
            end
          end else begin
            match_counter_range = match_counter_range + 1;
          end
          if(verify_low[verify_read] != tb_low) begin
            miss_counter_low = miss_counter_low + 1;
            if(RUN_UNTIL_FIRST_MISS) begin
              $display("%d-> Low doesn't match with expected. \t%d, got %d\n", general_counter, verify_low[verify_read], tb_low);
              statistic(1);
            end else begin
              match_counter_low = match_counter_low + 1;
            end
          end
        end
        update_array_pointers();
      end
    end
    return 0;     // not reset
  endfunction



  initial begin
    $display("-> Starting testbench...\n");
    tb_clk <= 1'b0;
    $display("\t-> Clock set\n");
    open_file();
    if(fd)  $display("\t-> File opened successfully\n");
    else begin
      $display("\t-> Unable to open the file\n");
      $stop;
    end
    $display("-> Configuration completed.\n");
    $display("-> Starting simulation...\n");
    reset_function(1);    // This function is called with 1 because it is the first execution (start_flag)
    #2ns;
    tb_reset <= 1'b0;
    #2ns;
    $display("\t-> Reset procedure completed\n");
    $display("\t-> Starting simulation loop\n");
    while(!$feof(fd)) begin
      reset_sign_return = run_simulation();
      if(reset_sign_return) begin
        //$display("\t\t-> Finish previous simulation\n");
        for(i=0; i<2; i = i+1) begin
          finish_execution();
          #2ns;
        end
        //$display("\t\t-> Architecture empty\n");
        //$display("\t\t-> Low: %d\n", tb_low);
        reset_function(0);    // set the flag to zero avoiding an entire reset
        #2ns;
        //$display("\t\t-> Setting the reset sign to 0\n");
        tb_reset <= 1'b0;
      end
      #2ns;
    end
    statistic(0);
  end
endmodule