gpiodevice.h

/* Copyright © 2018-2025 Pascal JEAN, All rights reserved.
   This file is part of the Piduino Library.
 
   The Piduino Library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 3 of the License, or (at your option) any later version.
 
   The Piduino Library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Lesser General Public License for more details.
 
   You should have received a copy of the GNU Lesser General Public License
   along with the Piduino Library; if not, see <http://www.gnu.org/licenses/>.
*/
#pragma once
 
#include <piduino/board.h>
#include <piduino/gpio.h>
 
namespace Piduino {
 
 
  class GpioDevice {
 
    public:
 
 
      GpioDevice();
 
      virtual ~GpioDevice();
 
      // -----------------------------------------------------------------
      //
      //                         Mandatory API
      //
      // -----------------------------------------------------------------
      virtual bool open() = 0;
 
      virtual void close() = 0;
 
      virtual void write (const Pin *pin, bool v) = 0;
 
      virtual bool read (const Pin *pin) const = 0;
 
      virtual void setMode (const Pin *pin, Pin::Mode m) = 0;
 
      virtual Pin::Mode mode (const Pin *pin) const = 0;
 
      virtual void setPull (const Pin *pin, Pin::Pull p) = 0;
 
      virtual AccessLayer preferedAccessLayer() const = 0;
 
      virtual const std::map<Pin::Mode, std::string> &modes() const = 0;
 
      // -----------------------------------------------------------------
      //
      //                           Optional API
      //
      // -----------------------------------------------------------------
 
      virtual void toggle (const Pin *pin);
 
      virtual Pin::Pull pull (const Pin *pin) const;
 
      virtual void setDrive (const Pin *pin, int d);
 
      virtual int drive (const Pin *pin) const;
 
      virtual int waitForInterrupt (const Pin *pin, Pin::Edge edge, int timeout_ms);
 
      virtual void setDebounce (const Pin *pin, uint32_t debounce_ms);
 
      virtual uint32_t debounce (const Pin *pin) const;
 
      virtual void setActiveLow (const Pin *pin, bool activeLow);
 
      virtual bool isActiveLow (const Pin *pin) const;
 
      enum {
        hasToggle     = 0x00000001,
        hasPullRead   = 0x00000002,
        hasAltRead    = 0x00000004,
        hasDrive      = 0x00000008,
        hasWfi        = 0x00000010,
        hasActiveLow  = 0x00000020,
        hasDebounce   = 0x00000040,
        useGpioMem    = 0x00010000, 
      };
 
      virtual unsigned int flags() const;
 
      virtual bool isOpen() const;
 
      virtual bool isDebug() const;
 
      virtual void setDebug (bool enable);
 
    protected:
      class Private;
 
      GpioDevice (Private &dd);
 
      std::unique_ptr<Private> d_ptr;
 
    private:
      PIMP_DECLARE_PRIVATE (GpioDevice)
  };
}
/* ========================================================================== */