pl011_driver.hpp

Go to the documentation of this file.

 
#pragma once
 
#include <etl/singleton.h>
 
#include "device_node.hpp"
#include "driver_registry.hpp"
#include "expected.hpp"
#include "kernel_log.hpp"
#include "pl011/pl011.hpp"
 
namespace pl011 {
using Pl011Device = Pl011;
}  // namespace pl011
 
class Pl011Driver {
 public:
  using Pl011Type = pl011::Pl011;
 
 
  [[nodiscard]] static auto GetEntry() -> const DriverEntry& {
    static const DriverEntry entry{
        .name = "pl011",
        .match_table = etl::span<const MatchEntry>(kMatchTable),
        .match = etl::delegate<bool(
            DeviceNode&)>::create<&Pl011Driver::MatchStatic>(),
        .probe = etl::delegate<Expected<void>(DeviceNode&)>::create<
            Pl011Driver, &Pl011Driver::Probe>(
            etl::singleton<Pl011Driver>::instance()),
        .remove = etl::delegate<Expected<void>(DeviceNode&)>::create<
            Pl011Driver, &Pl011Driver::Remove>(
            etl::singleton<Pl011Driver>::instance()),
    };
    return entry;
  }
 
  [[nodiscard]] static auto MatchStatic(DeviceNode& node) -> bool {
    static constexpr size_t kMinRegisterSpace = 0x48;
    return node.mmio_base != 0 && node.mmio_size >= kMinRegisterSpace;
  }
 
  [[nodiscard]] auto Probe(DeviceNode& node) -> Expected<void> {
    auto ctx = mmio_helper::Prepare(node, 0x1000);
    if (!ctx) {
      return std::unexpected(ctx.error());
    }
 
    uart_ = Pl011Type(ctx->base);
    node.type = DeviceType::kChar;
    klog::Info("Pl011Driver: UART at {:#x} bound", node.mmio_base);
    return {};
  }
 
  [[nodiscard]] auto Remove([[maybe_unused]] DeviceNode& node)
      -> Expected<void> {
    return {};
  }
 
  [[nodiscard]] auto GetDevice() -> Pl011Type* { return &uart_; }
 
  Pl011Driver() = default;
  Pl011Driver(const Pl011Driver&) = delete;
  Pl011Driver(Pl011Driver&&) = default;
  auto operator=(const Pl011Driver&) -> Pl011Driver& = delete;
  auto operator=(Pl011Driver&&) -> Pl011Driver& = default;
  ~Pl011Driver() = default;
 
 private:
  static constexpr MatchEntry kMatchTable[] = {
      {BusType::kPlatform, "arm,pl011"},
  };
 
  Pl011Type uart_{};
};
 
using Pl011DriverSingleton = etl::singleton<Pl011Driver>;