Subversion Repositories open8_urisc

-- Copyright (c)2013, 2020 Jeremy Seth Henry

-- All rights reserved.

--

-- Redistribution and use in source and binary forms, with or without

-- modification, are permitted provided that the following conditions are met:

--     * Redistributions of source code must retain the above copyright

--       notice, this list of conditions and the following disclaimer.

--     * Redistributions in binary form must reproduce the above copyright

--       notice, this list of conditions and the following disclaimer in the

--       documentation and/or other materials provided with the distribution,

--       where applicable (as part of a user interface, debugging port, etc.)

--

-- THIS SOFTWARE IS PROVIDED BY JEREMY SETH HENRY ``AS IS'' AND ANY

-- EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

-- WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

-- DISCLAIMED. IN NO EVENT SHALL JEREMY SETH HENRY BE LIABLE FOR ANY

-- DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES

-- (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

-- LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

-- ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

-- (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF

-- THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

--

-- VHDL Units :  o8_ram_1k

-- Description:  Provides a wrapper layer for a 1kx8 RAM model with interface

--            :   logic for the Open8 CPU. Also provides an optional write

--            :   enable register that prevents regions from being written

--            :   by non-ISR code (uses the I flag) as a way to prevent tasks

--            :   from inadvertently writing outside of their designated

--            :   memory space.

--            :  When enabled, the write mask logically divides the memory into

--            :   32, 32-byte regions, corresponding to the 32 bits in the WPR

--            :   register.

--

-- WP Register Map:

-- Offset  Bitfield Description                        Read/Write

--   0x00  AAAAAAAA Region Enables  7:0                  (RW)

--   0x01  AAAAAAAA Region Enables 15:8                  (RW)

--   0x02  AAAAAAAA Region Enables 23:16                 (RW)

--   0x03  AAAAAAAA Region Enables 31:24                 (RW)

--   0x04  AAAAAAAA Fault Address  7:0                   (RW*)

--   0x05  AAAAAAAA Fault Address 15:8                   (RW*)

--

-- Revision History

-- Author          Date     Change

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

-- Seth Henry      04/16/20 Revision block added

-- Seth Henry      05/12/20 Added write protect logic

-- Seth Henry      10/04/23 Modified WPR to match 4K RAM and added fault

--                           address capture

library ieee;

use ieee.std_logic_1164.all;

use ieee.std_logic_unsigned.all;

use ieee.std_logic_arith.all;

library work;

  use work.open8_pkg.all;

entity o8_ram_1k is

generic(

  Write_Protect              : boolean := FALSE;

  Default_Mask               : std_logic_vector(31 downto 0) := x"00000000";

  Address_WPR                : ADDRESS_TYPE := x"0400";

  Address_RAM                : ADDRESS_TYPE

);

port(

  Open8_Bus                  : in  OPEN8_BUS_TYPE;

  Rd_Data                    : out DATA_TYPE;

  Write_Fault                : out std_logic

);

end entity;

architecture behave of o8_ram_1k is

  alias  Clock               is Open8_Bus.Clock;

  alias  Reset               is Open8_Bus.Reset;

  alias  ISR_En              is Open8_Bus.GP_Flags(EXT_ISR);

  alias  Full_Address        is Open8_Bus.Address;

  alias  Wr_En               is Open8_Bus.Wr_En;

  alias  Rd_En               is Open8_Bus.Rd_En;

  constant WPR_User_Addr     : std_logic_vector(15 downto 3)

                               := Address_WPR(15 downto 3);

  constant RAM_User_Addr     : std_logic_vector(15 downto 10)

                               := Address_RAM(15 downto 10);

  alias  WPR_Comp_Addr       is Open8_Bus.Address(15 downto 3);

  signal WPR_Addr_Match      : std_logic := '0';

  alias  WPR_Reg_Sel_d       is Open8_Bus.Address(2 downto 0);

  signal WPR_Reg_Sel_q       : std_logic_vector(2 downto 0) :=

                                (others => '0');

  alias  Wr_Data_d           is Open8_Bus.Wr_Data;

  signal WPR_Wr_Data_q       : DATA_TYPE := x"00";

  signal Write_Mask          : std_logic_vector(31 downto 0) :=

                                x"00000000";

  alias  Write_Mask_0        is Write_Mask( 7 downto  0);

  alias  Write_Mask_1        is Write_Mask(15 downto  8);

  alias  Write_Mask_2        is Write_Mask(23 downto 16);

  alias  Write_Mask_3        is Write_Mask(31 downto 24);

  signal WPR_Wr_En_d         : std_logic := '0';

  signal WPR_Wr_En_q         : std_logic := '0';

  signal WPR_Rd_En_d         : std_logic := '0';

  signal WPR_Rd_En_q         : std_logic := '0';

  alias  RAM_Base_Addr       is Open8_Bus.Address(15 downto 10);

  alias  RAM_Addr            is Open8_Bus.Address(9 downto 0);

  alias  RAM_Rgn_Addr        is Open8_Bus.Address(9 downto 5);

  signal RAM_Region_Match    : std_logic := '0';

  signal RAM_Addr_Match      : std_logic := '0';

  signal RAM_Wr_En_d         : std_logic := '0';

  signal RAM_Rd_En_d         : std_logic := '0';

  signal RAM_Rd_En_q         : std_logic := '0';

  signal RAM_Rd_Data         : DATA_TYPE := OPEN8_NULLBUS;

  signal Write_Fault_d       : std_logic := '0';

  signal Write_Fault_q       : std_logic := '0';

  signal Current_Addr        : ADDRESS_TYPE := x"0000";

  signal Fault_Addr          : ADDRESS_TYPE := x"0000";

  alias  Fault_Addr_l        is Fault_Addr(7 downto 0);

  alias  Fault_Addr_h        is Fault_Addr(15 downto 8);

begin

Write_Protect_On : if( Write_Protect )generate

  WPR_Addr_Match             <= '1' when WPR_Comp_Addr = WPR_User_Addr else '0';

  WPR_Wr_En_d                <= WPR_Addr_Match and Wr_En and ISR_En;

  WPR_Rd_En_d                <= WPR_Addr_Match and Rd_En;

  RAM_Addr_Match             <= '1' when RAM_Base_Addr = RAM_User_Addr else '0';

  RAM_Region_Match           <= Write_Mask(conv_integer(RAM_Rgn_Addr)) or

                                ISR_En;

  RAM_Rd_En_d                <= RAM_Addr_Match and Rd_En;

  RAM_Wr_En_d                <= RAM_Addr_Match and RAM_Region_Match and Wr_En;

  Write_Fault_d              <= RAM_Addr_Match and (not RAM_Region_Match) and Wr_En;

  Write_Fault                <= Write_Fault_q;

  RAM_proc: process( Reset, Clock )

  begin

    if( Reset = Reset_Level )then

      WPR_Reg_Sel_q          <= (others => '0');

      WPR_Wr_Data_q          <= x"00";

      WPR_Wr_En_q            <= '0';

      WPR_Rd_En_q            <= '0';

      Write_Mask             <= Default_Mask;

      RAM_Rd_En_q            <= '0';

      Rd_Data                <= OPEN8_NULLBUS;

      Write_Fault            <= '0';

          Current_Addr           <= x"0000";

    elsif( rising_edge(Clock) )then

      WPR_Reg_Sel_q          <= WPR_Reg_Sel_d;

      WPR_Wr_En_q            <= WPR_Wr_En_d;

      WPR_Wr_Data_q          <= Wr_Data_d;

      if( WPR_Wr_En_q = '1' )then

        case( WPR_Reg_Sel_q )is

          when "000" =>

            Write_Mask_0     <= WPR_Wr_Data_q;

          when "001" =>

            Write_Mask_1     <= WPR_Wr_Data_q;

          when "010" =>

            Write_Mask_2     <= WPR_Wr_Data_q;

          when "011" =>

            Write_Mask_3     <= WPR_Wr_Data_q;

                  when "100" | "101" =>

                    Fault_Addr       <= (others => '0');

          when others =>

            null;

        end case;

      end if;

      WPR_Rd_En_q            <= WPR_Rd_En_d;

      RAM_Rd_En_q            <= RAM_Rd_En_d;

      Rd_Data                <= OPEN8_NULLBUS;

      if( RAM_Rd_En_q = '1' )then

        Rd_Data              <= RAM_Rd_Data;

      elsif( WPR_Rd_En_q = '1'  )then

        case( WPR_Reg_Sel_q )is

          when "000" =>

            Rd_Data          <= Write_Mask_0;

          when "001" =>

            Rd_Data          <= Write_Mask_1;

          when "010" =>

            Rd_Data          <= Write_Mask_2;

          when "011" =>

            Rd_Data          <= Write_Mask_3;

                  when "100" =>

                    Rd_Data          <= Fault_Addr_l;

                  when "101" =>

                    Rd_Data          <= Fault_Addr_h;

          when others =>

            null;

        end case;

      end if;

      Write_Fault_q          <= Write_Fault_d;

          Current_Addr           <= Full_Address;

          if( Write_Fault_q = '1' )then

             Fault_Addr          <= Current_Addr;

      end if;

    end if;

  end process;

end generate;

Write_Protect_Off : if( not Write_Protect )generate

  Write_Fault                <= '0';

  RAM_Addr_Match             <= '1' when RAM_Base_Addr = RAM_User_Addr else '0';

  RAM_Rd_En_d                <= RAM_Addr_Match and Open8_Bus.Rd_En;

  RAM_Wr_En_d                <= RAM_Addr_Match and Open8_Bus.Wr_En;

  RAM_proc: process( Reset, Clock )

  begin

    if( Reset = Reset_Level )then

      RAM_Rd_En_q            <= '0';

      Rd_Data                <= OPEN8_NULLBUS;

    elsif( rising_edge(Clock) )then

      RAM_Rd_En_q            <= RAM_Rd_En_d;

      Rd_Data                <= OPEN8_NULLBUS;

      if( RAM_Rd_En_q = '1' )then

        Rd_Data              <= RAM_Rd_Data;

      end if;

    end if;

  end process;

end generate;

  -- Note that this RAM should be created without an output FF (unregistered Q)

  U_RAM : entity work.ram_1k_core

  port map(

    address                  => RAM_Addr,

    clock                    => Clock,

    data                     => Wr_Data_d,

    wren                     => RAM_Wr_En_d,

    q                        => RAM_Rd_Data

  );

end architecture;