(* SPI slave device services using libsimpleio *)

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

DEFINITION MODULE SPI_libsimpleio;

  IMPORT
    Channel;

  FROM SYSTEM IMPORT BYTE;

  TYPE
    Device;

  CONST
    AUTO_CS = Channel.Unused;

  PROCEDURE Open
   (desg      : Channel.Designator;
    csdesg    : Channel.Designator;
    mode      : CARDINAL;
    wordsize  : CARDINAL;
    speed     : CARDINAL;
    VAR dev   : Device;
    VAR error : CARDINAL);

  PROCEDURE Close
   (VAR dev   : Device;
    VAR error : CARDINAL);

  PROCEDURE Transaction
   (dev       : Device;
    cmd       : ARRAY OF BYTE;
    cmdlen    : CARDINAL;
    delayus   : CARDINAL;
    VAR resp  : ARRAY OF BYTE;
    resplen   : CARDINAL;
    VAR error : CARDINAL);

  PROCEDURE Read
   (dev       : Device;
    VAR resp  : ARRAY OF BYTE;
    resplen   : CARDINAL;
    VAR error : CARDINAL);

  PROCEDURE Write
   (dev       : Device;
    cmd       : ARRAY OF BYTE;
    cmdlen    : CARDINAL;
    VAR error : CARDINAL);

  PROCEDURE fd(dev : Device) : INTEGER;

END SPI_libsimpleio.