local_apic.h

Go to the documentation of this file.

 
#pragma once
 
#include <cpu_io.h>
 
#include <array>
#include <cstdint>
 
#include "expected.hpp"
 
class LocalApic {
 public:
  [[nodiscard]] auto Init() -> Expected<void>;
 
  [[nodiscard]] auto GetApicVersion() const -> uint32_t;
 
  auto SendEoi() const -> void;
 
  [[nodiscard]] auto SendIpi(uint32_t destination_apic_id, uint8_t vector) const
      -> Expected<void>;
 
  [[nodiscard]] auto BroadcastIpi(uint8_t vector) const -> Expected<void>;
 
  auto SetTaskPriority(uint8_t priority) const -> void;
 
  [[nodiscard]] auto GetTaskPriority() const -> uint8_t;
 
  auto EnableTimer(uint32_t initial_count, uint32_t divide_value,
                   uint8_t vector, bool periodic = true) const -> void;
 
  auto DisableTimer() const -> void;
 
  [[nodiscard]] auto GetTimerCurrentCount() const -> uint32_t;
 
  auto SetupPeriodicTimer(uint32_t frequency_hz, uint8_t vector) const -> void;
 
  auto SetupOneShotTimer(uint32_t microseconds, uint8_t vector) const -> void;
 
  auto SendInitIpi(uint32_t destination_apic_id) const -> void;
 
  auto SendStartupIpi(uint32_t destination_apic_id, uint8_t start_page) const
      -> void;
 
  auto WakeupAp(uint32_t destination_apic_id, uint8_t start_vector) const
      -> void;
 
  auto ConfigureLvtEntries() const -> void;
 
  [[nodiscard]] auto ReadErrorStatus() const -> uint32_t;
 
  auto PrintInfo() const -> void;
 
  LocalApic() = default;
  LocalApic(const LocalApic&) = delete;
  LocalApic(LocalApic&&) = default;
  auto operator=(const LocalApic&) -> LocalApic& = delete;
  auto operator=(LocalApic&&) -> LocalApic& = default;
  ~LocalApic() = default;
 
 private:
  static constexpr uint32_t kXApicIdOffset = 0x20;
  static constexpr uint32_t kXApicVersionOffset = 0x30;
  static constexpr uint32_t kXApicTprOffset = 0x80;
  static constexpr uint32_t kXApicEoiOffset = 0xB0;
  static constexpr uint32_t kXApicSivrOffset = 0xF0;
  static constexpr uint32_t kXApicEsrOffset = 0x280;
  static constexpr uint32_t kXApicIcrLowOffset = 0x300;
  static constexpr uint32_t kXApicIcrHighOffset = 0x310;
  static constexpr uint32_t kXApicLvtTimerOffset = 0x320;
  static constexpr uint32_t kXApicLvtLint0Offset = 0x350;
  static constexpr uint32_t kXApicLvtLint1Offset = 0x360;
  static constexpr uint32_t kXApicLvtErrorOffset = 0x370;
  static constexpr uint32_t kXApicTimerInitCountOffset = 0x380;
  static constexpr uint32_t kXApicTimerCurrCountOffset = 0x390;
  static constexpr uint32_t kXApicTimerDivideOffset = 0x3E0;
 
  static constexpr uint32_t kApicIdShift = 24;
  static constexpr uint32_t kApicIdMask = 0xFF;
  static constexpr uint32_t kApicSoftwareEnableBit = 0x100;
  static constexpr uint32_t kSpuriousVector = 0xFF;
  static constexpr uint32_t kLvtMaskBit = 0x10000;
  static constexpr uint32_t kLvtPeriodicMode = 0x20000;
  static constexpr uint32_t kIcrDeliveryStatusBit = 0x1000;
  static constexpr uint32_t kIcrDestShift = 24;
  static constexpr uint32_t kIcrBroadcastMode = 0xC0000;
  static constexpr uint32_t kInitIpiMode = 0x500;
  static constexpr uint32_t kSipiMode = 0x600;
  static constexpr uint32_t kExtIntMode = 0x700;
  static constexpr uint32_t kNmiMode = 0x400;
  static constexpr uint8_t kErrorVector = 0xEF;
 
  static constexpr uint32_t kDefaultApicClockHz = 100000000;
  static constexpr uint32_t kTimerDivideBy1 = 0x0B;
  static constexpr uint32_t kTimerDivideBy16 = 0x03;
  static constexpr uint32_t kCalibrationCount = 0xFFFFFFFF;
  static constexpr uint32_t kCalibrationDelayLoop = 1000000;
  static constexpr uint32_t kCalibrationMultiplier = 100;
  static constexpr uint32_t kMicrosecondsPerSecond = 1000000;
 
  static constexpr uint64_t kDefaultApicBase = 0xFEE00000;
  static constexpr uint64_t kApicBaseMask = 0xFFFFF000ULL;
  static constexpr uint64_t kApicGlobalEnableBit = 1ULL << 11;
  static constexpr uint64_t kX2ApicEnableBit = 1ULL << 10;
  static constexpr uint64_t kApicBaseControlMask = 0xFFF;
 
  bool is_x2apic_mode_{false};
 
  uint64_t apic_base_{kDefaultApicBase};
 
  [[nodiscard]] auto CheckX2ApicSupport() const -> bool;
 
  [[nodiscard]] auto EnableXApic() const -> bool;
 
  [[nodiscard]] auto DisableXApic() const -> bool;
 
  [[nodiscard]] auto IsXApicEnabled() const -> bool;
 
  [[nodiscard]] auto EnableX2Apic() const -> bool;
 
  [[nodiscard]] auto DisableX2Apic() const -> bool;
 
  [[nodiscard]] auto IsX2ApicEnabled() const -> bool;
};