gpio.h

Go to the documentation of this file.

/*
 * This file is part of RTLib.
 *
 * Copyright (C) 2018 Derppening <david.18.19.21@gmail.com>
 *
 * RTLib 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.
 *
 * RTLib 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 RTLib.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef RTLIB_CORE_STM32F4_GPIO_H_
#define RTLIB_CORE_STM32F4_GPIO_H_

#if defined(STM32F4)

#include <cstdint>
#include <utility>

#include <libopencm3/stm32/gpio.h>

#include "core/util.h"

namespace core {
namespace stm32f4 {

class GPIO final {
 public:
  using AltFn = uint8_t;

  enum struct Mode : uint8_t {
    kInput = 0x0,
    kOutput,
    kAF,
    kAnalog
  };

  enum struct Speed : uint8_t {
    k2MHz = 0x0,
    k25MHz,
    k50MHz,
    k100MHz
  };

  enum struct Pullup : uint8_t {
    kNone = 0x0,
    kPullup,
    kPulldown
  };

  enum struct DriverType : uint8_t {
    kPushPull = 0x0,
    kOpenDrain
  };

  struct Config {
    Pinout pin = {};

    Mode mode = Mode::kInput;

    Speed speed = Speed::k2MHz;

    Pullup pullup = Pullup::kNone;

    DriverType driver = DriverType::kPushPull;

    AltFn altfn = GPIO_AF0;
  };

  explicit GPIO(const Config& config);

  GPIO(Pinout pin,
       Mode mode,
       Pullup pullup,
       Speed speed = Speed::k2MHz,
       DriverType driver = DriverType::kPushPull,
       AltFn altfn = 0x0);

  ~GPIO() = default;

  GPIO(GPIO&& other) noexcept = default;
  GPIO& operator=(GPIO&& other) noexcept = default;

  GPIO(const GPIO&) = delete;
  GPIO& operator=(const GPIO&) = delete;

  bool Read() const;
  void Set(bool state) const;
  void Toggle() const;

  void Reset() const;

 private:
  void Init(Mode mode, Pullup pullup, Speed speed = Speed::k2MHz, DriverType driver = DriverType::kPushPull) const;
  void InitRcc(Port port) const;

  void SetAltFn(uint8_t altfn);

  const Pinout& GetPinout() const { return pin_; }

  Pinout pin_;
};

}  // namespace stm32f4
}  // namespace core

#endif  // defined(STM32F4)

#endif  // RTLIB_CORE_STM32F4_GPIO_H_