gpio.h

/* Copyright © 2015-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 <string>
#include <vector>
#include <map>
#include <memory>
#include <exception>
#include <piduino/gpioconnector.h>
#include <piduino/soc.h>
 
namespace Piduino {
 
  class GpioDevice;
 
  class Gpio {
    public:
      friend class Connector;
 
      class Descriptor {
        public:
          std::string name; 
          long long id; 
          std::vector<Connector::Descriptor> connector; 
          // -- functions
          Descriptor (long long gpioId = -1);
          bool insert (); 
          bool hasConnector (const Connector::Descriptor &c) const;
          long long findId() const;
      };
 
 
      Gpio (AccessLayer layer = AccessLayerAuto);
 
      Gpio (long long gpioDatabaseId, const SoC & soc, AccessLayer layer);
 
      virtual ~Gpio();
 
      bool open();
 
      void close();
 
      bool isOpen() const;
 
      const std::string &name() const;
 
      long long id() const;
 
      void setReleaseOnClose (bool enable);
 
      bool releaseOnClose() const;
 
      Pin::Numbering numbering() const;
 
      void setNumbering (Pin::Numbering numbering);
 
      const std::string &numberingName () const;
 
      AccessLayer accessLayer() const;
 
      bool isDebug() const;
 
      void setDebug (bool enable);
 
      //------------------------------------------------------------------------
      //                          Accès aux connecteurs
      //------------------------------------------------------------------------
 
      int connectors() const;
 
      Connector *connector (int conn) const;
 
      const std::map<int, std::shared_ptr<Connector>> &connector();
 
 
      //------------------------------------------------------------------------
      //                          Accès aux broches
      //------------------------------------------------------------------------
 
      int size() const;
 
      Pin &pin (int num) const;
 
      Pin *pin (long long id) const;
 
      const std::map<int, std::shared_ptr<Pin>> &pin();
 
    protected:
      GpioDevice *device() const;
 
      //explicit Gpio (GpioDevice * device, AccessLayer layer);
 
    protected:
      class Private;
      Gpio (Private &dd);
      std::unique_ptr<Private> d_ptr;
 
    private:
      PIMP_DECLARE_PRIVATE (Gpio)
 
  };
  // ---------------------------------------------------------------------------
  //
  //                      Piduino Gpio Global Object
  //
  // ---------------------------------------------------------------------------
  extern Gpio gpio; 
}
 
/* ========================================================================== */