-- LPC1114 I/O Processor 32-bit Counter/Timer services

-- Copyright (C)2019-2023, Philip Munts dba Munts Technologies.
--
-- 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.
--
-- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT HOLDER OR CONTRIBUTORS 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.

WITH Interfaces;

PACKAGE RemoteIO.LPC1114.Timers IS

  Timer_Error : EXCEPTION;

  TYPE TimerClass IS TAGGED PRIVATE;

  TYPE Timer IS ACCESS ALL TimerClass'Class;

  -- Constructor

  FUNCTION Create
   (absdev : NOT NULL RemoteIO.LPC1114.Abstract_Device.Device;
    desg   : Interfaces.Unsigned_32) RETURN Timer;

  -- Methods

  PROCEDURE Reset
   (Self    : TimerClass);

  PROCEDURE Configure_Mode
   (Self    : TimerClass;
    mode    : Interfaces.Unsigned_32);

  PROCEDURE Configure_Prescaler
   (Self    : TimerClass;
    divisor : Interfaces.Unsigned_32);

  PROCEDURE Configure_Capture
   (Self    : TimerClass;
    edge    : Interfaces.Unsigned_32);

  PROCEDURE Configure_Match_Action
   (Self    : TimerClass;
    reg     : Interfaces.Unsigned_32;
    action  : Interfaces.Unsigned_32;
    reset   : Boolean;
    stop    : Boolean);

  PROCEDURE Configure_Match_Value
   (Self    : TimerClass;
    reg     : Interfaces.Unsigned_32;
    value   : Interfaces.Unsigned_32);

PRIVATE

  TYPE TimerClass IS TAGGED RECORD
    dev : RemoteIO.LPC1114.Abstract_Device.Device;
    desg : Interfaces.Unsigned_32;
  END RECORD;

END RemoteIO.LPC1114.Timers;