ns16550a_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 "ns16550a/ns16550a.hpp"
 
class Ns16550aDriver {
 public:
  using Ns16550aType = ns16550a::Ns16550a;
 
 
  [[nodiscard]] static auto GetEntry() -> const DriverEntry& {
    static const DriverEntry entry{
        .name = "ns16550a",
        .match_table = etl::span<const MatchEntry>(kMatchTable),
        .match = etl::delegate<bool(
            DeviceNode&)>::create<&Ns16550aDriver::MatchStatic>(),
        .probe = etl::delegate<Expected<void>(DeviceNode&)>::create<
            Ns16550aDriver, &Ns16550aDriver::Probe>(
            etl::singleton<Ns16550aDriver>::instance()),
        .remove = etl::delegate<Expected<void>(DeviceNode&)>::create<
            Ns16550aDriver, &Ns16550aDriver::Remove>(
            etl::singleton<Ns16550aDriver>::instance()),
    };
    return entry;
  }
 
  [[nodiscard]] static auto MatchStatic([[maybe_unused]] DeviceNode& node)
      -> bool {
    static constexpr size_t kMinRegisterSpace = 8;
    return node.mmio_base != 0 && node.mmio_size >= kMinRegisterSpace;
  }
 
  [[nodiscard]] auto Probe(DeviceNode& node) -> Expected<void> {
    auto ctx = mmio_helper::Prepare(node, 0x100);
    if (!ctx) {
      return std::unexpected(ctx.error());
    }
 
    auto result = Ns16550aType::Create(ctx->base);
    if (!result) {
      return std::unexpected(Error(result.error().code));
    }
 
    uart_ = std::move(*result);
    node.type = DeviceType::kChar;
    klog::Info("Ns16550aDriver: UART at {:#x} bound", node.mmio_base);
    return {};
  }
 
  [[nodiscard]] auto Remove([[maybe_unused]] DeviceNode& node)
      -> Expected<void> {
    return {};
  }
 
  [[nodiscard]] auto GetDevice() -> Ns16550aType* { return &uart_; }
 
  Ns16550aDriver() = default;
  Ns16550aDriver(const Ns16550aDriver&) = delete;
  Ns16550aDriver(Ns16550aDriver&&) = default;
  auto operator=(const Ns16550aDriver&) -> Ns16550aDriver& = delete;
  auto operator=(Ns16550aDriver&&) -> Ns16550aDriver& = default;
  ~Ns16550aDriver() = default;
 
 private:
  static constexpr MatchEntry kMatchTable[] = {
      {BusType::kPlatform, "ns16550a"},
      {BusType::kPlatform, "ns16550"},
  };
 
  Ns16550aType uart_{};
};
 
using Ns16550aDriverSingleton = etl::singleton<Ns16550aDriver>;