File interrupt_pin.hpp

File List > include > libhal > interrupt_pin.hpp

// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#pragma once

#include "error.hpp"
#include "functional.hpp"
#include "units.hpp"

namespace hal {
class interrupt_pin
{
public:
  enum class trigger_edge
  {
    falling = 0,
    rising = 1,
    both = 2,
  };

  struct settings
  {
    pin_resistor resistor = pin_resistor::pull_up;

    trigger_edge trigger = trigger_edge::rising;
  };

  using handler = void(bool p_state);

  [[nodiscard]] status configure(const settings& p_settings)
  {
    return driver_configure(p_settings);
  }

  void on_trigger(hal::callback<handler> p_callback)
  {
    return driver_on_trigger(p_callback);
  }

  virtual ~interrupt_pin() = default;

private:
  virtual status driver_configure(const settings& p_settings) = 0;
  virtual void driver_on_trigger(hal::callback<handler> p_callback) = 0;
};
}  // namespace hal