Subversion Repositories aes-128-ecb-encoder

-- IPIF Common Library Package  

-------------------------------------------------------------------------------

--

-- *************************************************************************

-- **                                                                     **

-- ** DISCLAIMER OF LIABILITY                                             **

-- **                                                                     **

-- ** This text/file contains proprietary, confidential                   **

-- ** information of Xilinx, Inc., is distributed under                   **

-- ** license from Xilinx, Inc., and may be used, copied                  **

-- ** and/or disclosed only pursuant to the terms of a valid              **

-- ** license agreement with Xilinx, Inc. Xilinx hereby                   **

-- ** grants you a license to use this text/file solely for               **

-- ** design, simulation, implementation and creation of                  **

-- ** design files limited to Xilinx devices or technologies.             **

-- ** Use with non-Xilinx devices or technologies is expressly            **

-- ** prohibited and immediately terminates your license unless           **

-- ** covered by a separate agreement.                                    **

-- **                                                                     **

-- ** Xilinx is providing this design, code, or information               **

-- ** "as-is" solely for use in developing programs and                   **

-- ** solutions for Xilinx devices, with no obligation on the             **

-- ** part of Xilinx to provide support. By providing this design,        **

-- ** code, or information as one possible implementation of              **

-- ** this feature, application or standard, Xilinx is making no          **

-- ** representation that this implementation is free from any            **

-- ** claims of infringement. You are responsible for obtaining           **

-- ** any rights you may require for your implementation.                 **

-- ** Xilinx expressly disclaims any warranty whatsoever with             **

-- ** respect to the adequacy of the implementation, including            **

-- ** but not limited to any warranties or representations that this      **

-- ** implementation is free from claims of infringement, implied         **

-- ** warranties of merchantability or fitness for a particular           **

-- ** purpose.                                                            **

-- **                                                                     **

-- ** Xilinx products are not intended for use in life support            **

-- ** appliances, devices, or systems. Use in such applications is        **

-- ** expressly prohibited.                                               **

-- **                                                                     **

-- ** Any modifications that are made to the Source Code are              **

-- ** done at the user’s sole risk and will be unsupported.               **

-- ** The Xilinx Support Hotline does not have access to source           **

-- ** code and therefore cannot answer specific questions related         **

-- ** to source HDL. The Xilinx Hotline support of original source        **

-- ** code IP shall only address issues and questions related             **

-- ** to the standard Netlist version of the core (and thus               **

-- ** indirectly, the original core source).                              **

-- **                                                                     **

-- ** Copyright (c) 2002-2010 Xilinx, Inc. All rights reserved.           **

-- **                                                                     **

-- ** This copyright and support notice must be retained as part          **

-- ** of this text at all times.                                          **

-- **                                                                     **

-- *************************************************************************

--

-------------------------------------------------------------------------------

-- Filename:        ipif_pkg.vhd

-- Version:         Intital

-- Description:     This file contains the constants and functions used in the 

--                  ipif common library components.

--

-------------------------------------------------------------------------------

-- Structure:       

--

-------------------------------------------------------------------------------

-- Author:      DET

-- History:

--  DET         02/21/02      -- Created from proc_common_pkg.vhd

--

--  DET         03/13/02      -- PLB IPIF development updates

-- ^^^^^^

--              - Commented out string types and string functions due to an XST

--                problem with string arrays and functions. THe string array

--                processing functions were replaced with comperable functions

--                operating on integer arrays.

-- ~~~~~~

--

--

--     DET     4/30/2002     Initial

-- ~~~~~~

--     - Added three functions: rebuild_slv32_array, rebuild_slv64_array, and

--       rebuild_int_array to support removal of unused elements from the 

--       ARD arrays.

-- ^^^^^^ --

--

--     FLO     8/12/2002

-- ~~~~~~

--     - Added three functions: bits_needed_for_vac, bits_needed_for_occ,

--       and get_id_index_iboe.

--       (Removed provisional functions bits_needed_for_vacancy,

--        bits needed_for_occupancy, and bits_needed_for.)

-- ^^^^^^

--

--     FLO     3/24/2003

-- ~~~~~~

--     - Added dependent property paramters for channelized DMA.

--     - Added common property parameter array type.

--     - Definded the KEYHOLD_BURST common-property parameter.

-- ^^^^^^

--

--     FLO     10/22/2003

-- ~~~~~~

--     - Some adjustment to CHDMA parameterization.

--     - Cleanup of obsolete code and comments. (The former "XST workaround"

--       has become the officially deployed method.)

-- ^^^^^^

--

--     LSS     03/24/2004

-- ~~~~~~

--     - Added 5 functions

-- ^^^^^^

--

--      ALS     09/03/04

-- ^^^^^^

--      -- Added constants to describe the channel protocols used in MCH_OPB_IPIF

-- ~~~~~~

--

--     DET     1/17/2008     v4_0

-- ~~~~~~

--     - Changed proc_common library version to v4_0

--     - Incorporated new disclaimer header

-- ^^^^^^

--

-------------------------------------------------------------------------------

-- Naming Conventions:

--      active low signals:                     "*_n"

--      clock signals:                          "clk", "clk_div#", "clk_#x" 

--      reset signals:                          "rst", "rst_n" 

--      generics:                               "C_*" 

--      user defined types:                     "*_TYPE" 

--      state machine next state:               "*_ns" 

--      state machine current state:            "*_cs" 

--      combinatorial signals:                  "*_com" 

--      pipelined or register delay signals:    "*_d#" 

--      counter signals:                        "*cnt*"

--      clock enable signals:                   "*_ce" 

--      internal version of output port         "*_i"

--      device pins:                            "*_pin" 

--      ports:                                  - Names begin with Uppercase 

--      processes:                              "*_PROCESS" 

--      component instantiations:               "<ENTITY_>I_<#|FUNC>

-------------------------------------------------------------------------------

library ieee;

use ieee.std_logic_1164.all;

-- need conversion function to convert reals/integers to std logic vectors

use ieee.std_logic_arith.all;

use ieee.std_logic_arith.all;

use ieee.std_logic_unsigned.all;

package ipif_pkg is

-------------------------------------------------------------------------------

-- Type Declarations

-------------------------------------------------------------------------------

type    SLV32_ARRAY_TYPE is array (natural range <>) of std_logic_vector(0 to 31);

subtype SLV64_TYPE is std_logic_vector(0 to 63);

type    SLV64_ARRAY_TYPE is array (natural range <>) of SLV64_TYPE;

type    INTEGER_ARRAY_TYPE is array (natural range <>) of integer;

-------------------------------------------------------------------------------

-- Function and Procedure Declarations

-------------------------------------------------------------------------------

function "=" (s1: in string; s2: in string) return boolean;

function equaluseCase( str1, str2 : STRING ) RETURN BOOLEAN;

function calc_num_ce (ce_num_array : INTEGER_ARRAY_TYPE) return integer;

function calc_start_ce_index (ce_num_array : INTEGER_ARRAY_TYPE;

                              index        : integer) return integer;

function get_min_dwidth (dwidth_array: INTEGER_ARRAY_TYPE) return integer;

function get_max_dwidth (dwidth_array: INTEGER_ARRAY_TYPE) return integer;

function S32 (in_string : string) return string;

--------------------------------------------------------------------------------

-- ARD support functions.

-- These function can be useful when operating with the ARD parameterization.

--------------------------------------------------------------------------------

function get_id_index (id_array :INTEGER_ARRAY_TYPE;

                       id       : integer)

                       return integer;

function get_id_index_iboe (id_array :INTEGER_ARRAY_TYPE;

                       id       : integer)

                       return integer;

function find_ard_id (id_array : INTEGER_ARRAY_TYPE;

                      id       : integer) return boolean;

function find_id_dwidth (id_array    : INTEGER_ARRAY_TYPE;

                         dwidth_array: INTEGER_ARRAY_TYPE;

                         id          : integer;

                         default_i   : integer)

                         return integer;

function cnt_ipif_id_blks (id_array : INTEGER_ARRAY_TYPE) return integer;

function get_ipif_id_dbus_index (id_array : INTEGER_ARRAY_TYPE;

                                 id          : integer)

                                 return integer ;

function rebuild_slv32_array (slv32_array     : SLV32_ARRAY_TYPE;

                              num_valid_pairs : integer)

                              return SLV32_ARRAY_TYPE;

function rebuild_slv64_array (slv64_array     : SLV64_ARRAY_TYPE;

                              num_valid_pairs : integer)

                              return SLV64_ARRAY_TYPE;

function rebuild_int_array (int_array       : INTEGER_ARRAY_TYPE;

                            num_valid_entry : integer)

                            return INTEGER_ARRAY_TYPE;

-- 5 Functions Added 3/24/04

function populate_intr_mode_array (num_user_intr        : integer;

                                   intr_capture_mode    : integer)

                                  return INTEGER_ARRAY_TYPE ;

function add_intr_ard_id_array(include_intr    : boolean;

                              ard_id_array     : INTEGER_ARRAY_TYPE)

                              return INTEGER_ARRAY_TYPE;

function add_intr_ard_addr_range_array(include_intr    : boolean;

                              ZERO_ADDR_PAD        : std_logic_vector;

                              intr_baseaddr            : std_logic_vector;

                              intr_highaddr            : std_logic_vector;

                              ard_id_array             : INTEGER_ARRAY_TYPE;

                              ard_addr_range_array     : SLV64_ARRAY_TYPE)

                              return SLV64_ARRAY_TYPE;

function add_intr_ard_num_ce_array(include_intr     : boolean;

                              ard_id_array          : INTEGER_ARRAY_TYPE;

                              ard_num_ce_array      : INTEGER_ARRAY_TYPE)

                              return INTEGER_ARRAY_TYPE;

function add_intr_ard_dwidth_array(include_intr    : boolean;

                              intr_dwidth           : integer;

                              ard_id_array          : INTEGER_ARRAY_TYPE;

                              ard_dwidth_array      : INTEGER_ARRAY_TYPE)

                              return INTEGER_ARRAY_TYPE;

function log2(x : natural) return integer;

function clog2(x : positive) return natural;

-------------------------------------------------------------------------------

-- Constant Declarations

-------------------------------------------------------------------------------

-------------------------------------------------------------------------------

-- Channel Protocols

--  The constant declarations below give symbolic-name aliases for values that 

--  can be used in the C_MCH_PROTOCOL_ARRAY generic of the MCH_OPB_IPIF.

-------------------------------------------------------------------------------

constant XCL                    : integer := 0;

constant DAG                    : integer := 1;

--------------------------------------------------------------------------------

-- Address range types.

-- The constant declarations, below, give symbolic-name aliases for values

-- that can be used in the C_ARD_ID_ARRAY generic of IPIFs. The first set

-- gives aliases that are used to include IPIF services.

--------------------------------------------------------------------------------

-- IPIF module aliases

Constant IPIF_INTR              : integer := 1;

Constant IPIF_RST               : integer := 2;

Constant IPIF_SESR_SEAR         : integer := 3;

Constant IPIF_DMA_SG            : integer := 4;

Constant IPIF_WRFIFO_REG        : integer := 5;

Constant IPIF_WRFIFO_DATA       : integer := 6;

Constant IPIF_RDFIFO_REG        : integer := 7;

Constant IPIF_RDFIFO_DATA       : integer := 8;

Constant IPIF_CHDMA_CHANNELS    : integer := 9;

Constant IPIF_CHDMA_GLOBAL_REGS : integer := 10;

Constant CHDMA_STATUS_FIFO      : integer := 90;

-- Some predefined user module aliases

Constant USER_00                : integer := 100;

Constant USER_01                : integer := 101;

Constant USER_02                : integer := 102;

Constant USER_03                : integer := 103;

Constant USER_04                : integer := 104;

Constant USER_05                : integer := 105;

Constant USER_06                : integer := 106;

Constant USER_07                : integer := 107;

Constant USER_08                : integer := 108;

Constant USER_09                : integer := 109;

Constant USER_10                : integer := 110;

Constant USER_11                : integer := 111;

Constant USER_12                : integer := 112;

Constant USER_13                : integer := 113;

Constant USER_14                : integer := 114;

Constant USER_15                : integer := 115;

Constant USER_16                : integer := 116;

---( Start  of Dependent Properties declarations

--------------------------------------------------------------------------------

-- Declarations for Dependent Properties (properties that depend on the type of

-- the address range, or in other words, address-range-specific parameters).

-- There is one property, i.e. one parameter, encoded as an integer at

-- each index of the properties array. There is one properties array for

-- each address range.

-- 

-- The C_ARD_DEPENDENT_PROPS_ARRAY generic parameter in (most) IPIFs is such

-- a properties array and it is usually giving its (static) value using a

-- VHDL aggregate construct.  (--ToDo, give an example of this.)

--

-- The the "assigned" default value of a dependent property is zero. This value

-- is usually specified the aggregate by leaving its (index) name out so that

-- it is covered by an "others => 0" choice in the aggregate. Some parameters,

-- as noted in the definitions, below, have an "effective" default value that is

-- different from the assigned default value of zero. In such cases, the

-- function, eff_dp, given below, can be used to get the effective value of

-- the dependent property.

--------------------------------------------------------------------------------

constant DEPENDENT_PROPS_SIZE : integer := 32;

subtype DEPENDENT_PROPS_TYPE

         is INTEGER_ARRAY_TYPE(0 to DEPENDENT_PROPS_SIZE-1);

type DEPENDENT_PROPS_ARRAY_TYPE

         is array (natural range <>) of DEPENDENT_PROPS_TYPE;

--------------------------------------------------------------------------------

-- Below are the indices of dependent properties for the different types of

-- address ranges.

--

-- Example: Let C_ARD_DEPENDENT_PROPS_ARRAY hold the dependent properites

-- for a set of address ranges. Then, e.g.,

--

--   C_ARD_DEPENDENT_PROPS_ARRAY(i)(FIFO_CAPACITY_BITS)

--

-- gives the fifo capacity in bits, provided that the i'th address range

-- is of type IPIF_WRFIFO_DATA or IPIF_RDFIFO_DATA.

--

-- These indices should be referenced only by the names below and never

-- by numerical literals. (The right to change numerical index assignments

-- is reserved; applications using the names will not be affected by such

-- reassignments.)

--------------------------------------------------------------------------------

--

--ToDo, if the interrupt controller parameterization is ever moved to

--      C_ARD_DEPENDENT_PROPS_ARRAY, then the following declarations

--      could be uncommented and used.

---- IPIF_INTR                                                               IDX

---------------------------------------------------------------------------- ---

constant EXCLUDE_DEV_ISC                                       : integer := 0;

      -- 1 specifies that only the global interrupt

      -- enable is present in the device interrupt source

      -- controller and that the only source of interrupts

      -- in the device is the IP interrupt source controller.

      -- 0 specifies that the full device interrupt

      -- source controller structure will be included.

constant INCLUDE_DEV_PENCODER                                  : integer := 1;

      -- 1 will include the Device IID in the device interrupt

      -- source controller, 0 will exclude it.

--

-- IPIF_WRFIFO_DATA or IPIF_RDFIFO_DATA                                      IDX

---------------------------------------------------------------------------- ---

constant FIFO_CAPACITY_BITS                                      : integer := 0;

constant WR_WIDTH_BITS                                           : integer := 1;

constant RD_WIDTH_BITS                                           : integer := 2;

constant EXCLUDE_PACKET_MODE                                     : integer := 3;

      -- 1  Don't include packet mode features

      -- 0  Include packet mode features

constant EXCLUDE_VACANCY                                         : integer := 4;

      -- 1  Don't include vacancy calculation

      -- 0  Include vacancy calculation

      --    See also the functions

      --    bits_needed_for_vac  and

      --    bits_needed_for_occ  that are declared below.

constant INCLUDE_DRE                                             : integer := 5;

constant INCLUDE_AUTOPUSH_POP                                    : integer := 6;

constant AUTOPUSH_POP_CE                                         : integer := 7;

constant INCLUDE_CSUM                                            : integer := 8;

--------------------------------------------------------------------------------

--

-- DMA_SG                                                                    IDX

---------------------------------------------------------------------------- ---

--------------------------------------------------------------------------------

-- IPIF_CHDMA_CHANNELS                                                       IDX

---------------------------------------------------------------------------- ---

constant NUM_SUBS_FOR_PHYS_0                                     : integer :=0;

constant NUM_SUBS_FOR_PHYS_1                                     : integer :=1;

constant NUM_SUBS_FOR_PHYS_2                                     : integer :=2;

constant NUM_SUBS_FOR_PHYS_3                                     : integer :=3;

constant NUM_SUBS_FOR_PHYS_4                                     : integer :=4;

constant NUM_SUBS_FOR_PHYS_5                                     : integer :=5;

constant NUM_SUBS_FOR_PHYS_6                                     : integer :=6;

constant NUM_SUBS_FOR_PHYS_7                                     : integer :=7;

constant NUM_SUBS_FOR_PHYS_8                                     : integer :=8;

constant NUM_SUBS_FOR_PHYS_9                                     : integer :=9;

constant NUM_SUBS_FOR_PHYS_10                                    : integer :=10;

constant NUM_SUBS_FOR_PHYS_11                                    : integer :=11;

constant NUM_SUBS_FOR_PHYS_12                                    : integer :=12;

constant NUM_SUBS_FOR_PHYS_13                                    : integer :=13;

constant NUM_SUBS_FOR_PHYS_14                                    : integer :=14;

constant NUM_SUBS_FOR_PHYS_15                                    : integer :=15;

      -- Gives the number of sub-channels for physical channel i.

      --

      -- These constants, which will be MAX_NUM_PHYS_CHANNELS in number (see

      -- below), have consecutive values starting with 0 for

      -- NUM_SUBS_FOR_PHYS_0. (The constants serve the purpose of giving symbolic

      -- names for use in the dependent-properties aggregates that parameterize

      -- an IPIF_CHDMA_CHANNELS address range.)

      --  

      -- [Users can ignore this note for developers

      --   If the number of physical channels changes, both the

      --   IPIF_CHDMA_CHANNELS constants and MAX_NUM_PHYS_CHANNELS,

      --   below, must be adjusted.

      --   (Use of an array constant or a function of the form

      --    NUM_SUBS_FOR_PHYS(i) to define the indices

      --    runs afoul of LRM restrictions on non-locally static aggregate

      --    choices. (Further, the LRM imposes perhaps unnecessarily

      --    strict limits on what qualifies as a locally static primary.)

      --    Note: This information is supplied for the benefit of anyone seeking

      --    to improve the way that these NUM_SUBS_FOR_PHYS parameter

      --    indices are defined.)

      -- End of note for developers ]

      --

      -- The value associated with any index NUM_SUBS_FOR_PHYS_i in the

      -- dependent-properties array must be even since TX and RX channels

      -- come in pairs with the TX followed immediately by

      -- the corresponding RX.

      --

constant NUM_SIMPLE_DMA_CHANS                                  : integer :=16;

      -- The number of simple DMA channels.

constant NUM_SIMPLE_SG_CHANS                                   : integer :=17;

      -- The number of simple SG channels.

constant INTR_COALESCE                                         : integer :=18;

      -- 0 Interrupt coalescing is disabled

      -- 1 Interrupt coalescing is enabled

constant CLK_PERIOD_PS                                         : integer :=19;

      -- The period of the OPB Bus clock in ps.

      -- The default value of 0 is a special value that

      -- is synonymous with 10000 ps (10 ns).

      -- The value for CLK_PERIOD_PS is relevant only if (INTR_COALESCE = 1).

constant PACKET_WAIT_UNIT_NS                                   : integer :=20;

      -- Gives the unit for used for timing of pack-wait bounds.

      -- The default value of 0 is a special value that

      -- is synonymous with 1,000,000 ns (1 ms) and a non-default

      -- value is typically only used for testing.

      -- Relevant only if (INTR_COALESCE = 1).

constant BURST_SIZE                                            : integer :=21;

      -- 1, 2, 4, 8 or 16 

      -- The default value of 0 is a special value that

      -- is synonymous with a burst size of 16.

      -- Setting the BURST_SIZE to 1 effectively disables

      -- bursts.

constant REMAINDER_AS_SINGLES                                  : integer :=22;

      -- 0 Remainder handled as a short burst

      -- 1 Remainder handled as a series of singles

      --------------------------------------------------------------------------------

      -- The constant below is not the index of a dependent-properties

      -- parameter (and, as such, would never appear as a choice in a

      -- dependent-properties aggregate). Rather, it is fixed to the maximum

      -- number of physical channels that an Address Range of type

      -- IPIF_CHDMA_CHANNELS supports. It must be maintained in conjuction with

      -- the constants named, e.g., NUM_SUBS_FOR_PHYS_15, above.

      --------------------------------------------------------------------------------

      constant MAX_NUM_PHYS_CHANNELS : natural := 16;

      --------------------------------------------------------------------------

      -- EXAMPLE: Here is an example dependent-properties aggregate for an 

      -- address range of type IPIF_CHDMA_CHANNELS. 

      -- To have a compact list of all of the CHDMA parameters, all are

      -- shown, however three are commented out and the unneeded

      -- MUM_SUBS_FOR_PHYS_x are excluded. The "OTHERS => 0" association

      -- gives these parameters their default values, such that, for the example

      --

      --     - All physical channels above 2 have zero subchannels (effectively,

      --       these physical channels are not used)

      --     - There are no simple SG channels

      --     - The packet-wait time unit is 1 ms

      --     - Burst size is 16

      --------------------------------------------------------------------------

      --    (

      --     NUM_SUBS_FOR_PHYS_0                        =>     8,

      --     NUM_SUBS_FOR_PHYS_1                        =>     4,

      --     NUM_SUBS_FOR_PHYS_2                        =>    14,

      --     NUM_SIMPLE_DMA_CHANS                       =>     1,

      --   --NUM_SIMPLE_SG_CHANS                        =>     5,

      --     INTR_COALESCE                              =>     1,

      --     CLK_PERIOD_PS                              => 20000,

      --   --PACKET_WAIT_UNIT_NS                        => 50000,

      --   --BURST_SIZE                                 =>     1,

      --     REMAINDER_AS_SINGLES                       =>     1,

      --     OTHERS                                     =>     0

      --    )

      --

--------------------------------------------------------------------------------

--------------------------------------------------------------------------------

-- Calculates the number of bits needed to convey the vacancy (emptiness) of

-- the fifo described by dependent_props, if fifo_present. If not fifo_present,

-- returns 0 (or the smallest value allowed by tool limitations on null arrays)

-- without making reference to dependent_props.

--------------------------------------------------------------------------------

function  bits_needed_for_vac(

              fifo_present: boolean;

              dependent_props : DEPENDENT_PROPS_TYPE

          ) return integer;

--------------------------------------------------------------------------------

-- Calculates the number of bits needed to convey the occupancy (fullness) of

-- the fifo described by dependent_props, if fifo_present. If not fifo_present,

-- returns 0 (or the smallest value allowed by tool limitations on null arrays)

-- without making reference to dependent_props.

--------------------------------------------------------------------------------

function  bits_needed_for_occ(

              fifo_present: boolean;

              dependent_props : DEPENDENT_PROPS_TYPE

          ) return integer;

--------------------------------------------------------------------------------

-- Function eff_dp.

--

-- For some of the dependent properties, the default value of zero is meant

-- to imply an effective default value of other than zero (see e.g.

-- PKT_WAIT_UNIT_NS for the IPIF_CHDMA_CHANNELS address-range type). The

-- following function is used to get the (possibly default-adjusted)

-- value for a dependent property.

--

-- Example call:

--

--    eff_value_of_param :=

--        eff_dp(

--            C_IPIF_CHDMA_CHANNELS,

--            PACKET_WAIT_UNIT_NS,

--            C_ARD_DEPENDENT_PROPS_ARRAY(i)(PACKET_WAIT_UNIT_NS)

--        );

--

--    where C_ARD_DEPENDENT_PROPS_ARRAY(i) is an object of type

--    DEPENDENT_PROPS_ARRAY_TYPE, that was parameterized for an address range of

--    type C_IPIF_CHDMA_CHANNELS.

--------------------------------------------------------------------------------

function eff_dp(id       : integer;  -- The type of address range.

                dep_prop : integer;  -- The index of the dependent prop.

                value    : integer   -- The value at that index.

               ) return    integer;  -- The effective value, possibly adjusted

                                     -- if value has the default value of 0.

---) End  of Dependent Properties declarations

--------------------------------------------------------------------------------

-- Declarations for Common Properties (properties that apply regardless of the

-- type of the address range). Structurally, these work the same as

-- the dependent properties.

--------------------------------------------------------------------------------

constant COMMON_PROPS_SIZE : integer := 2;

subtype COMMON_PROPS_TYPE

         is INTEGER_ARRAY_TYPE(0 to COMMON_PROPS_SIZE-1);

type COMMON_PROPS_ARRAY_TYPE

         is array (natural range <>) of COMMON_PROPS_TYPE;

--------------------------------------------------------------------------------

-- Below are the indices of the common properties.

--

-- These indices should be referenced only by the names below and never

-- by numerical literals.

--                                                                           IDX

---------------------------------------------------------------------------- ---

constant KEYHOLE_BURST                                           : integer := 0;

      -- 1 All addresses of a burst are forced to the initial

      --   address of the burst.

      -- 0 Burst addresses follow the bus protocol.

-- IP interrupt mode array constants

Constant INTR_PASS_THRU         : integer := 1;

Constant INTR_PASS_THRU_INV     : integer := 2;

Constant INTR_REG_EVENT         : integer := 3;

Constant INTR_REG_EVENT_INV     : integer := 4;

Constant INTR_POS_EDGE_DETECT   : integer := 5;

Constant INTR_NEG_EDGE_DETECT   : integer := 6;

end ipif_pkg;

package body ipif_pkg is

-------------------------------------------------------------------------------

-- Function log2 -- returns number of bits needed to encode x choices

--   x = 0  returns 0

--   x = 1  returns 0

--   x = 2  returns 1

--   x = 4  returns 2, etc.

-------------------------------------------------------------------------------

--

function log2(x : natural) return integer is

  variable i  : integer := 0;

  variable val: integer := 1;

begin

  if x = 0 then return 0;

  else

    for j in 0 to 29 loop -- for loop for XST 

      if val >= x then null;

      else

        i := i+1;

        val := val*2;

      end if;

    end loop;

  -- Fix per CR520627  XST was ignoring this anyway and printing a  

  -- Warning in SRP file. This will get rid of the warning and not

  -- impact simulation.  

  -- synthesis translate_off

    assert val >= x

      report "Function log2 received argument larger" &

             " than its capability of 2^30. "

      severity failure;

  -- synthesis translate_on

    return i;

  end if;

end function log2;

--------------------------------------------------------------------------------

-- Function clog2 - returns the integer ceiling of the base 2 logarithm of x,

--                  i.e., the least integer greater than or equal to log2(x).

--------------------------------------------------------------------------------

function clog2(x : positive) return natural is

  variable r  : natural := 0;

  variable rp : natural := 1; -- rp tracks the value 2**r

begin

  while rp < x loop -- Termination condition T: x <= 2**r

    -- Loop invariant L: 2**(r-1) < x

    r := r + 1;

    if rp > integer'high - rp then exit; end if;  -- If doubling rp overflows

      -- the integer range, the doubled value would exceed x, so safe to exit.

    rp := rp + rp;

  end loop;

  -- L and T  <->  2**(r-1) < x <= 2**r  <->  (r-1) < log2(x) <= r

  return r; --

end clog2;

-------------------------------------------------------------------------------

-- Function Definitions

-------------------------------------------------------------------------------

-----------------------------------------------------------------------------

-- Function "="

--

-- This function can be used to overload the "=" operator when comparing

-- strings.

-----------------------------------------------------------------------------

  function "=" (s1: in string; s2: in string) return boolean is

      constant tc: character := ' ';  -- string termination character

      variable i: integer := 1;

      variable v1 : string(1 to s1'length) := s1;

      variable v2 : string(1 to s2'length) := s2;

  begin

      while (i <= v1'length) and (v1(i) /= tc) and

            (i <= v2'length) and (v2(i) /= tc) and

            (v1(i) = v2(i))

      loop

          i := i+1;

      end loop;

      return ((i > v1'length) or (v1(i) = tc)) and

             ((i > v2'length) or (v2(i) = tc));

  end;

----------------------------------------------------------------------------

-- Function equaluseCase

--

-- This function returns true if case sensitive string comparison determines

-- that str1 and str2 are the same.

-----------------------------------------------------------------------------

   FUNCTION equaluseCase( str1, str2 : STRING ) RETURN BOOLEAN IS

     CONSTANT len1 : INTEGER := str1'length;

     CONSTANT len2 : INTEGER := str2'length;

     VARIABLE equal : BOOLEAN := TRUE;

   BEGIN

      IF NOT (len1=len2) THEN

        equal := FALSE;

      ELSE

        FOR i IN str1'range LOOP

          IF NOT (str1(i) = str2(i)) THEN

            equal := FALSE;

          END IF;

        END LOOP;

      END IF;