Subversion Repositories open8_urisc

-- Copyright (c)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_ts_ioctl
-- Description:  Provides an 8-bit microsecond resolution timer for generating
--            :   periodic interrupts for the Open8 task switcher, a second-
--            :   level cascaded interrupt manager, and 16-bit I/O write
--            :   qualification register.
--
-- Register Map:
-- Offset  Bitfield Description                        Read/Write
--   0x00  AAAAAAAA PIT Timer Interval (0 = disabled)    (RW)
--   0x01  AAAAAAAA External Interrupt Mask (lower)      (RW)
--   0x02  AAAAAAAA External Interrupt Mask (upper)      (RW)
--   0x03  AAAAAAAA Pending External Ints* (lower)       (RW)
--   0x04  AAAAAAAA Pending External Ints* (upper)       (RW)
--   0x05  A------- Interrupt Requested (write to clear) (RW)
--   0x06  AAAAAAAA IO Write Qualification Register LB   (RW)
--   0x07  AAAAAAAA IO Write Qualification Register UB   (RW)
--
-- Note: Each bit in the pending register is individually clearable by writing
--        a '1' to it, allowing interrupts to be cleared individually
--
-- Revision History
-- Author          Date     Change
------------------ -------- ---------------------------------------------------
-- Seth Henry      09/28/23 Initial creation
 
library ieee;
use ieee.std_logic_1164.all;
  use ieee.std_logic_unsigned.all;
  use ieee.std_logic_arith.all;
  use ieee.std_logic_misc.all;
 
library work;
  use work.open8_pkg.all;
 
entity o8_ts_ioctl is
generic(
  Address                    : ADDRESS_TYPE
);
port(
  Open8_Bus                  : in  OPEN8_BUS_TYPE;
  Rd_Data                    : out DATA_TYPE;
  --
  CPU_Interrupts             : out DATA_TYPE;
  --
  RAM_Write_Fault            : in  std_logic;
  IO_Interrupts_In           : in  ADDRESS_TYPE := x"0000";
  IO_Write_Qual_Out          : out ADDRESS_TYPE
);
end entity;
 
architecture behave of o8_ts_ioctl is
 
  alias  Clock               is Open8_Bus.Clock;
  alias  Reset               is Open8_Bus.Reset;
  alias  uSec_Tick           is Open8_Bus.uSec_Tick;
  alias  CPU_ISR_En          is Open8_Bus.GP_Flags(EXT_ISR);
  alias  CPU_Wr_En           is Open8_Bus.Wr_En;
  alias  CPU_Rd_En           is Open8_Bus.Rd_En;
 
  constant User_Addr         : std_logic_vector(15 downto 3) :=
                                Address(15 downto 3);
  alias  Comp_Addr           is Open8_Bus.Address(15 downto 3);
  signal Addr_Match          : std_logic := '0';
 
  alias  Reg_Sel_d           is Open8_Bus.Address(2 downto 0);
  signal Reg_Sel_q           : std_logic_vector(2 downto 0);
  signal Wr_En_d             : std_logic := '0';
  signal Wr_En_q             : std_logic := '0';
  alias  Wr_Data_d           is Open8_Bus.Wr_Data;
  signal Wr_Data_q           : DATA_TYPE := x"00";
  signal Rd_En_d               : std_logic := '0';
  signal Rd_En_q             : std_logic := '0';
 
  signal Interval            : DATA_TYPE := x"00";
  signal Update_Interval     : std_logic;
  signal Timer_Cnt           : DATA_TYPE := x"00";
 
  signal PIT_Interrupt       : std_logic := '0';
 
  signal Int_Mask            : ADDRESS_TYPE := x"0000";
  alias  Int_Mask_l          is Int_Mask(7 downto 0);
  alias  Int_Mask_h          is Int_Mask(15 downto 8);
 
  signal Clear_Pending       : ADDRESS_TYPE := x"0000";
  alias  Clear_Pending_l     is Clear_Pending(7 downto 0);
  alias  Clear_Pending_h     is Clear_Pending(15 downto 8);
 
  signal Ack_IO_Ints         : std_logic := '0';
 
  signal Pending             : ADDRESS_TYPE := x"0000";
  alias  Pending_l           is Pending(7 downto 0);
  alias  Pending_h           is Pending(15 downto 8);
  signal Pending_q           : ADDRESS_TYPE := x"0000";
  signal Pending_RE          : ADDRESS_TYPE := x"0000";
 
  signal IO_Int_Pending      : std_logic := '0';
 
  signal IO_Interrupt        : std_logic := '0';
 
  signal IO_Qual_Reg         : ADDRESS_TYPE := x"0000";
  alias  IO_Qual_l           is IO_Qual_Reg(7 downto 0);
  alias  IO_Qual_h           is IO_Qual_Reg(15 downto 8);
 
begin
 
  -- The task switcher assumes the following CPU interrupt configuration
  CPU_Interrupts(0)          <= RAM_Write_Fault; -- WPR fault interrupt
  CPU_Interrupts(1)          <= PIT_Interrupt;   -- Pre-emption timer interrupt
  CPU_Interrupts(2)          <= IO_Interrupt;    -- Cascaded I/O interrupt
  CPU_Interrupts(7 downto 3) <= (others => '0'); -- Supervisor functions
 
  IO_Write_Qual_Out          <= IO_Qual_Reg;
 
  Addr_Match                 <= '1' when Comp_Addr = User_Addr else '0';
  Wr_En_d                    <= Addr_Match and CPU_Wr_En and CPU_ISR_En;
  Rd_En_d                    <= Addr_Match and CPU_Rd_En;
 
  io_reg: process( Clock, Reset )
  begin
    if( Reset = Reset_Level )then
      Reg_Sel_q              <= (others => '0');
      Wr_En_q                <= '0';
      Wr_Data_q              <= x"00";
      Rd_En_q                <= '0';
      Rd_Data                <= OPEN8_NULLBUS;
      Interval               <= x"00";
      Update_Interval        <= '0';
      Int_Mask               <= x"0000";
      Clear_Pending          <= x"0000";
      Ack_IO_Ints            <= '0';
    elsif( rising_edge( Clock ) )then
      Reg_Sel_q              <= Reg_Sel_d;
      Wr_En_q                <= Wr_En_d;
      Wr_Data_q              <= Wr_Data_d;
 
      Update_Interval        <= Wr_En_q;
      Clear_Pending          <= x"0000";
      Ack_IO_Ints            <= '0';
      if( Wr_En_q = '1' )then
        case( Reg_Sel_q )is
          when "000" =>
            Interval         <= Wr_Data_q;
          when "001" =>
            Int_Mask_l       <= Wr_Data_q;
          when "010" =>
            Int_Mask_h       <= Wr_Data_q;
          when "011" =>
            Clear_Pending_l  <= Wr_Data_q;
          when "100" =>
            Clear_Pending_h  <= Wr_Data_q;
          when "101" =>
            Ack_IO_Ints      <= '1';
          when "110" =>
            IO_Qual_l        <= Wr_Data_q;
          when "111" =>
            IO_Qual_h        <= Wr_Data_q;
          when others =>
            null;
        end case;
      end if;
 
      Rd_Data                <= (others => '0');
      Rd_En_q                <= Rd_En_d;
      if( Rd_En_q = '1' )then
        case( Reg_Sel_q )is
          when "000" =>
            Rd_Data          <= Interval;
          when "001" =>
            Rd_Data          <= Int_Mask_l;
          when "010" =>
            Rd_Data          <= Int_Mask_h;
          when "011" =>
            Rd_Data          <= Pending_l;
          when "100" =>
            Rd_Data          <= Pending_h;
          when "101" =>
            Rd_Data          <= IO_Int_Pending & "0000000";
          when "110" =>
            Rd_Data          <= IO_Qual_l;
          when "111" =>
            Rd_Data          <= IO_Qual_h;
          when others =>
            null;
        end case;
      end if;
    end if;
  end process;
 
  Interval_proc: process( Clock, Reset )
  begin
    if( Reset = Reset_Level )then
      Timer_Cnt              <= x"00";
      PIT_Interrupt          <= '0';
    elsif( rising_edge(Clock) )then
      PIT_Interrupt              <= '0';
      Timer_Cnt              <= Timer_Cnt - uSec_Tick;
      if( Update_Interval = '1' )then
        Timer_Cnt            <= Interval;
      elsif( or_reduce(Timer_Cnt) = '0' )then
        Timer_Cnt            <= Interval;
        PIT_Interrupt        <= or_reduce(Interval); -- Only trigger on Int > 0
      end if;
    end if;
  end process;
 
  Interrupt_proc: process( Clock, Reset )
    variable i               : integer := 0;
  begin
    if( Reset = Reset_Level )then
      Pending                <= x"0000";
      Pending_q              <= x"0000";
      Pending_RE             <= x"0000";
      IO_Int_Pending         <= '0';
      IO_Interrupt           <= '0';
    elsif( rising_edge(Clock) )then
      for i in 0 to 15 loop
        if( IO_Interrupts_In(i) = '1' and Int_Mask(i) = '1' )then
          Pending(i)         <= '1';
        elsif( Clear_Pending(i) = '1' )then
          Pending(i)         <= '0';
        end if;
        Pending_q(i)         <= Pending(i);
        Pending_RE(i)        <= Pending(i) and not Pending_q(i);
      end loop;
 
      IO_Interrupt           <= '0';
      if( or_reduce(Pending_RE) = '1' and IO_Int_Pending = '0' )then
        IO_Int_Pending       <= '1';
        IO_Interrupt         <= '1';
      elsif( Ack_IO_Ints = '1' )then
        IO_Int_Pending       <= '0';
      end if;
 
    end if;
  end process;
 
end architecture;