-- Copyright (C)2025, 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.

PACKAGE BuildHAT IS

  Error : EXCEPTION;

  DefaultSerialPort : CONSTANT String := "/dev/ttyAMA0";
  DefaultBaudRate   : CONSTANT Positive := 115200;

  TYPE Byte        IS MOD 256;
  TYPE ByteArray   IS ARRAY (Positive RANGE <>) OF Byte;
  TYPE DeviceClass IS TAGGED PRIVATE;
  TYPE Device      IS ACCESS ALL DeviceClass'Class;
  TYPE Ports       IS (PortA, PortB, PortC, PortD);

  FUNCTION Create
   (serialport : String   := DefaultSerialPort;
    baudrate   : Positive := DefaultBaudRate) RETURN Device;

  PROCEDURE Initialize
   (Self       : OUT DeviceClass;
    serialport : String   := DefaultSerialPort;
    baudrate   : Positive := DefaultBaudRate);

  PROCEDURE Send
   (Self       : DeviceClass;
    s          : String);

PRIVATE

  TYPE DeviceClass IS TAGGED RECORD
    fd : Integer;
  END RECORD;

END BuildHAT;