CMX_flavor_package.vhd

Go to the documentation of this file.

library IEEE;
use IEEE.STD_LOGIC_1164.ALL;
use IEEE.NUMERIC_STD.ALL;

library work;

use work.CMXpackage.all;
use work.CMX_local_package.all;

package CMX_flavor_package is

  
  constant version_flavor_common : std_logic_vector(15 downto 0):=x"F0A2";

  --from the array types
  CONSTANT max_tobs_tot        : integer := 64;
  CONSTANT max_tobs_topo       : integer := 32;
  CONSTANT max_jems            : integer := 16;
  CONSTANT max_tobs_pjem       : integer := 4;
  CONSTANT et2_width           : integer := 10;
  CONSTANT et1_width           : integer := 9;
  CONSTANT pos_width           : integer := 9;
  CONSTANT thresholds_num      : integer := 25;
  CONSTANT thresholds_width    : integer := 10;
  constant max_threshold     : std_logic_vector((thresholds_width-1) downto 0) := (others => '1');
  constant max_eta_slices    : integer := 4;

  constant num_presence_bits_pjem : integer :=8;

  
  --type arr_RTM_sdr is array(num_RTM_cables-1 downto 0) of std_logic_vector((numbits_in_RTM_connector*2)-1 downto 0);
   
  type arr_s0word is array(3 downto 0) of std_logic_vector(12 downto 0); 
  type arr_s1word is array(3 downto 0) of std_logic_vector(10 downto 0); 
  
  type Low_word is array (integer range <>) of arr_s0word;
  type High_word is array (integer range <>) of arr_s1word;
  type num_tobs is array(15 downto 0) of std_logic_vector(3 downto 0);
  type ntobs_type is array(15 downto 0) of std_logic_vector(2 downto 0);
  type ptr_sort is array(15 downto 0) of std_logic_vector(6 downto 0);
  type ptr_presort is array(15 downto 0) of std_logic_vector(3 downto 0);
  type ptr_jem   is array(16 downto 0) of std_logic_vector(6 downto 0);
  type pos_type is array(15 downto 0) of std_logic_vector(11 downto 0);
  type thPatG_type  is array(integer range <>) of std_logic_vector(120 downto 0);

  type JetTOB is record
    Et1 : std_logic_vector (8 downto 0);
    Et2:  std_logic_vector (9 downto 0);
    pos:  std_logic_vector (8 downto 0);     
  end record;
  
  type arr_TOB      is array (integer range <>) of JetTOB;  

  
  constant num_copies : integer :=3;

  type copy_arr_TOB is array (num_copies-1 downto 0) of arr_TOB(max_tobs_topo-1 downto 0);

  constant num_sort_layers: integer := 21;
  type type_TOB_sort_layers is array(num_sort_layers-1 downto 0) of arr_TOB(max_tobs_tot-1 downto 0);
  

  --this defines position ranges and sizes of the Et1 field in the backplane data
  type t_arr_addr_Et1 is array(3 downto 0) of integer range 0 to 82;
  constant arr_addr_Et1_MSword_loc_Hi : t_arr_addr_Et1 := (82,73,51,29);
  constant arr_addr_Et1_MSword_loc_Lo : t_arr_addr_Et1 := (78,72,48,24);
  constant arr_addr_Et1_MSword_size   : t_arr_addr_Et1 := (5,2,4,6);
  constant arr_addr_Et1_LSword_loc_Hi : t_arr_addr_Et1 := (77,58,34,10);
  constant arr_addr_Et1_LSword_loc_Lo : t_arr_addr_Et1 := (74,52,30,8);
  constant arr_addr_Et1_LSword_size   : t_arr_addr_Et1 := (4,7,5,3);
  

  
  type fpos_type    is array(integer range <>) of std_logic_vector(19 downto 0);
  type thPatL_type  is array(integer range <>) of std_logic_vector(99 downto 0);

  type par_type     is array(integer range <>) of std_logic;

  type presortEt2_type is array(integer range <>) of std_logic_vector(39 downto 0);
  type presortEt1_type is array(integer range <>) of std_logic_vector(35 downto 0);
  type presortpos_type is array(integer range <>) of std_logic_vector(35 downto 0);

  constant zero : std_logic:='0';   
  constant frame_16 : std_logic_vector(15 downto 0):=(others => '0');
  constant frame_17 : std_logic_vector(16 downto 0):=(others => '0');   
  constant frame_18 : std_logic_vector(17 downto 0):=(others => '0');   

 
  subtype T_SL      is std_logic;
  subtype T_SLV2    is std_logic_vector(1 downto 0);
  subtype T_SLV3    is std_logic_vector(2 downto 0);
  subtype T_SLV4    is std_logic_vector(3 downto 0);
  subtype T_SLV12   is std_logic_vector(11 downto 0);
  subtype T_SLV13   is std_logic_vector(12 downto 0);
  subtype T_SLV24   is std_logic_vector(23 downto 0);
  subtype T_SLV25   is std_logic_vector(24 downto 0);
  subtype T_SLV30   is std_logic_vector(29 downto 0);
  subtype T_SLV32   is std_logic_vector(31 downto 0);
  subtype T_SLV16   is std_logic_vector(15 downto 0);
  subtype T_SLV60   is std_logic_vector(59 downto 0);
  subtype T_SLV61   is std_logic_vector(60 downto 0);
  subtype T_SLV62   is std_logic_vector(61 downto 0);
  subtype T_SLV65   is std_logic_vector(64 downto 0);
  subtype T_SLV75   is std_logic_vector(74 downto 0);
  subtype T_SLV120  is std_logic_vector(119 downto 0);
  subtype T_SLV121  is std_logic_vector(120 downto 0);
  subtype T_SLV1936 is std_logic_vector(1935 downto 0);
  

  type nx3_array is array (integer range <>) of std_logic_vector ( 2 downto 0);
  type nx4_array  is array(integer range <>) of std_logic_vector(3 downto 0);
  type nx8_array is array  (integer range <>) of std_logic_vector(7 downto 0);
  type nx13_array is array (integer range <>) of std_logic_vector(12 downto 0);
  type nx24_array is array (integer range <>) of std_logic_vector(23 downto 0);
  type nx25_array is array (integer range <>) of std_logic_vector(24 downto 0);
  type nx26_array is array (integer range <>) of std_logic_vector(25 downto 0);
  type nx32_array is array (integer range <>) of std_logic_vector(31 downto 0);
  type nx35_array is array (integer range <>) of std_logic_vector(34 downto 0);
  type nx60_array is array (integer range <>) of std_logic_vector(59 downto 0);
  type nx100_array is array(integer range <>) of std_logic_vector(99 downto 0);
  type nx121_array is array(integer range <>) of std_logic_vector(120 downto 0);

  type nxmx4_array  is array(integer range <>,integer range <> ) of std_logic_vector(3 downto 0);

  type int_array is array (integer range <>) of integer;

  type threshold_slice       is array(integer range <>) of std_logic_vector(10 downto 0);
  type threshold_jem         is array(integer range <>) of threshold_slice(max_eta_slices-1 downto 0);
  type threshold_type        is array(integer range <>) of threshold_jem(thresholds_num-1 downto 0);

  type mult_type_a is array (integer range <>) of std_logic_vector(2 downto 0); 
  type mult_type is array (integer range <>) of mult_type_a(24 downto 0);                         
                
  type xsum_type_a is array(integer range <>) of std_logic_vector(3 downto 0);              
  type xsum_type is array(integer range <>) of xsum_type_a(7 downto 0);
                
  type totsum_type is array(integer range <>) of integer;

  constant TO_Jet_Et1_size : integer := 9;
  constant TO_Jet_Et2_size : integer := 10;
  -- constant TO_Jet_eta_size : integer := 5;
  -- constant TO_Jet_phi_size : integer := 5;
  constant TO_Jet_pos_size : integer := 9;
  
  constant TO_Jet_size : integer := TO_Jet_Et1_size + TO_Jet_Et2_size + TO_Jet_pos_size;
  constant Num_TO_Jet : integer := 32;

  
  type adder_type is array(15 downto 0) of std_logic_vector(2 downto 0);
  constant mult_i : adder_type:=("100","011","011","010",
                                 "011","010","010","001",
                                           "011","010","010","001",
                                           "010","001","001","000"); 

  type arr_TO_Jet is array (Num_TO_Jet - 1 downto 0) of STD_LOGIC_VECTOR(TO_Jet_size - 1 downto 0);
  

  CONSTANT slot11reduced : boolean := false;

  TYPE del_register_rtm_arr_type is array (num_RTM_cables - 1 downto 0) of del_register_rtm_type;  


  type loc_type_a is array(integer range <>) of std_logic_vector(1 downto 0);
  type loc_type is array(integer range <>) of loc_type_a(max_tobs_pjem-1 downto 0);

  
  type xpos_sort_type is array(15 downto 0) of std_logic_vector(3 downto 0);
  constant xpos_sort : xpos_sort_type:=("0000","1000","1000","1100",
                                        "1000","1100","1100","1110",
                                                     "1000","1100","1100","1110",
                                                     "1100","1110","1110","1111");


 type calc_parity_typa_a is array(integer range <>) of T_SL;
 type calc_parity_type is array(integer range <>) of calc_parity_typa_a(3 downto 0);
   
  type xpos_type    is array(integer range <>) of std_logic_vector(3 downto 0);                                   

type ofwntobs_type is array(0 to 255) of std_logic_vector(3 downto 0);
constant ofwntobs: ofwntobs_type:=(
"0000",
"0001",
"0001",
"0010",
"0001",
"0010",
"0010",
"0011",
"0001",
"0010",
"0010",
"0011",
"0010",
"0011",
"0011",
"0100",
"0001",
"0010",
"0010",
"0011",
"0010",
"0011",
"0011",
"0100",
"0010",
"0011",
"0011",
"0100",
"0011",
"0100",
"0100",
"1111",
"0001",
"0010",
"0010",
"0011",
"0010",
"0011",
"0011",
"0100",
"0010",
"0011",
"0011",
"0100",
"0011",
"0100",
"0100",
"1111",
"0010",
"0011",
"0011",
"0100",
"0011",
"0100",
"0100",
"1111",
"0011",
"0100",
"0100",
"1111",
"0100",
"1111",
"1111",
"1111",
"0001",
"0010",
"0010",
"0011",
"0010",
"0011",
"0011",
"0100",
"0010",
"0011",
"0011",
"0100",
"0011",
"0100",
"0100",
"1111",
"0010",
"0011",
"0011",
"0100",
"0011",
"0100",
"0100",
"1111",
"0011",
"0100",
"0100",
"1111",
"0100",
"1111",
"1111",
"1111",
"0010",
"0011",
"0011",
"0100",
"0011",
"0100",
"0100",
"1111",
"0011",
"0100",
"0100",
"1111",
"0100",
"1111",
"1111",
"1111",
"0011",
"0100",
"0100",
"1111",
"0100",
"1111",
"1111",
"1111",
"0100",
"1111",
"1111",
"1111",
"1111",
"1111",
"1111",
"1111",
"0001",
"0010",
"0010",
"0011",
"0010",
"0011",
"0011",
"0100",
"0010",
"0011",
"0011",
"0100",
"0011",
"0100",
"0100",
"1111",
"0010",
"0011",
"0011",
"0100",
"0011",
"0100",
"0100",
"1111",
"0011",
"0100",
"0100",
"1111",
"0100",
"1111",
"1111",
"1111",
"0010",
"0011",
"0011",
"0100",
"0011",
"0100",
"0100",
"1111",
"0011",
"0100",
"0100",
"1111",
"0100",
"1111",
"1111",
"1111",
"0011",
"0100",
"0100",
"1111",
"0100",
"1111",
"1111",
"1111",
"0100",
"1111",
"1111",
"1111",
"1111",
"1111",
"1111",
"1111",
"0010",
"0011",
"0011",
"0100",
"0011",
"0100",
"0100",
"1111",
"0011",
"0100",
"0100",
"1111",
"0100",
"1111",
"1111",
"1111",
"0011",
"0100",
"0100",
"1111",
"0100",
"1111",
"1111",
"1111",
"0100",
"1111",
"1111",
"1111",
"1111",
"1111",
"1111",
"1111",
"0011",
"0100",
"0100",
"1111",
"0100",
"1111",
"1111",
"1111",
"0100",
"1111",
"1111",
"1111",
"1111",
"1111",
"1111",
"1111",
"0100",
"1111",
"1111",
"1111",
"1111",
"1111",
"1111",
"1111",
"1111",
"1111",
"1111",
"1111",
"1111",
"1111",
"1111",
"1111");

type cnt_mult_arr is array(integer range <>) of std_logic_vector(31 downto 0);
type cnt_mult_arr_2x16 is array(integer range <>) of std_logic_vector(15 downto 0);


  procedure Conv3to2 
        ( signal a: in std_logic_vector (2 downto 0);
      signal b: out std_logic_vector (1 downto 0)) is
          begin
                if a(2) = '1' then
                    b <= "11";
                else
                    b <= a(1 downto 0);
                end if;
   end Conv3to2; 

  ----------
  function add3x2 (
      a: std_logic_vector (2 downto 0);   
      b: std_logic_vector (2 downto 0)
  ) 
  return std_logic_vector is
  ----------
  -- add two 3-bit numbers, return 4-bit sum
  -- 
    variable isum: integer range 0 to 15;
    variable vsum: std_logic_vector(3 downto 0);
  ----------
  begin
    isum :=   to_integer(unsigned(a))
            + to_integer(unsigned(b));
     vsum := std_logic_vector(to_unsigned(isum,4));
     return vsum;
  end add3x2;



end CMX_flavor_package;