Plic Class Reference

Plic 驱动 More...

#include <plic.h>

Collaboration diagram for Plic:

Public Types
using	InterruptDelegate = InterruptBase::InterruptDelegate

Public Member Functions
auto	Which () const -> uint32_t
	向 Plic 询问中断
auto	Done (uint32_t source_id) const -> void
	告知 Plic 已经处理了当前 IRQ
auto	Set (uint32_t hart_id, uint32_t source_id, uint32_t priority, bool enable) const -> void
	设置指定中断源的使能状态
auto	Get (uint32_t hart_id, uint32_t source_id) const -> std::tuple< uint32_t, bool, bool >
	获取指定中断源的状态信息
auto	RegisterInterruptFunc (uint8_t cause, InterruptDelegate func) -> void
	注册外部中断处理函数
auto	Do (uint64_t cause, cpu_io::TrapContext *context) -> void
	执行外部中断处理
构造/析构函数
	Plic (uint64_t dev_addr, size_t ndev, size_t context_count)
	构造函数
	Plic ()=default
	Plic (const Plic &)=default
	Plic (Plic &&)=default
auto	operator= (const Plic &) -> Plic &=default
auto	operator= (Plic &&) -> Plic &=default
	~Plic ()=default

Static Public Attributes
static constexpr size_t	kInterruptMaxCount = 16
	最大外部中断数量

Private Member Functions
__always_inline auto	GetContextId (uint32_t hart_id, uint32_t mode=1) const -> uint32_t
	计算 context ID
auto	GetEnableBit (uint32_t context_id, uint32_t source_id) const -> bool
	获取使能位寄存器中指定中断源的状态
auto	SetEnableBit (uint32_t context_id, uint32_t source_id, bool value) const -> void
	设置使能位寄存器中指定中断源的状态
auto	SourcePriority (uint32_t source_id) const -> uint32_t &
	获取中断源优先级寄存器
auto	GetPendingBit (uint32_t source_id) const -> bool
	获取挂起位寄存器中指定中断源的状态
auto	SetPendingBit (uint32_t source_id, bool value) const -> void
	设置挂起位寄存器中指定中断源的状态
auto	PriorityThreshold (uint32_t context_id) const -> uint32_t &
	获取优先级阈值寄存器
auto	ClaimComplete (uint32_t context_id) const -> uint32_t &
	获取声明/完成寄存器

Private Attributes
uint64_t	base_addr_ {0}
size_t	ndev_ {0}
size_t	context_count_ {0}

Static Private Attributes
static constexpr uint64_t	kSourcePriorityOffset = 0x000000
static constexpr uint64_t	kPendingBitsOffset = 0x001000
static constexpr uint64_t	kEnableBitsOffset = 0x002000
static constexpr uint64_t	kContextOffset = 0x200000
static constexpr uint64_t	kContextSize = 0x1000
static constexpr uint64_t	kPriorityThresholdOffset = 0x0
static constexpr uint64_t	kClaimCompleteOffset = 0x4
static constexpr uint64_t	kEnableSize = 0x80
static std::array< InterruptDelegate, kInterruptMaxCount >	interrupt_handlers_
	外部中断处理函数数组

Detailed Description

Plic 驱动

Copyright

Copyright The SimpleKernel Contributors

See also

https://github.com/riscv/riscv-plic

Definition at line 20 of file plic.h.

Member Typedef Documentation

InterruptDelegate

using Plic::InterruptDelegate = InterruptBase::InterruptDelegate

Definition at line 22 of file plic.h.

Constructor & Destructor Documentation

Plic() [1/4]

Plic::Plic ( uint64_t  dev_addr, size_t  ndev, size_t  context_count  )

explicit

构造函数

Parameters

dev_addr	设备地址
ndev	支持的中断源数量 (riscv,ndev)
context_count	上下文数量 (通常为 2 * core_count)

Definition at line 24 of file plic.cpp.

    : base_addr_(dev_addr), ndev_(ndev), context_count_(context_count) {
  // 设置所有中断源的优先级为 0 (禁用)
  klog::Info("Setting all interrupt priorities to 0");
  for (size_t source_id = 0; source_id <= ndev_; source_id++) {
    SourcePriority(source_id) = 0;
  }
 
  klog::Info("Disabling all interrupts for all contexts");
 
  for (size_t context_id = 0; context_id < context_count_; context_id++) {
    // 设置优先级阈值为 0 (允许所有优先级的中断)
    PriorityThreshold(context_id) = 0;
    // 禁用所有中断
    for (size_t source_id = 0; source_id <= ndev_; source_id++) {
      SetEnableBit(context_id, source_id, false);
    }
  }
 
  klog::Info(
      "PLIC initialization: all interrupts disabled, priorities set to 0");
 
  for (auto& h : interrupt_handlers_) {
    h = InterruptDelegate::create<DefaultPlicHandler>();
  }
}

Here is the call graph for this function:

Plic() [2/4]

Plic::Plic ( )

default

Plic() [3/4]

Plic::Plic ( const Plic &  )

default

Plic() [4/4]

Plic::Plic ( Plic &&  )

default

~Plic()

Plic::~Plic ( )

default

Member Function Documentation

ClaimComplete()

auto Plic::ClaimComplete ( uint32_t  context_id ) const -> uint32_t&

private

获取声明/完成寄存器

Parameters

context_id

context ID

Returns

uint32_t& 寄存器引用

Definition at line 149 of file plic.cpp.

                                                               {
  return *reinterpret_cast<uint32_t*>(base_addr_ + kContextOffset +
                                      (context_id * kContextSize) +
                                      kClaimCompleteOffset);
}

Here is the caller graph for this function:

Do()

auto Plic::Do	(	uint64_t	cause,
		cpu_io::TrapContext *	context
	)		-> void

执行外部中断处理

Parameters

cause	外部中断号
context	中断上下文

Definition at line 66 of file plic.cpp.

                                                                {
  interrupt_handlers_[cause](cause, context);
}

Done()

auto Plic::Done

(

uint32_t

source_id

)

const -> void

告知 Plic 已经处理了当前 IRQ

Parameters

source_id

中断源 ID (1-1023)

Definition at line 56 of file plic.cpp.

                                                {
  auto context_id = GetContextId(cpu_io::GetCurrentCoreId());
  ClaimComplete(context_id) = source_id;
}

Here is the call graph for this function:

Get()

auto Plic::Get	(	uint32_t	hart_id,
		uint32_t	source_id
	)		const -> std::tuple<uint32_t, bool, bool>

获取指定中断源的状态信息

Parameters

hart_id	hart ID
source_id	中断源 ID (1-1023)

Returns

<优先级, 使能状态, 挂起状态>

Definition at line 80 of file plic.cpp.

                                      {
  // 获取中断优先级
  auto priority = SourcePriority(source_id);
 
  // 获取中断使能状态
  uint32_t context_id = GetContextId(hart_id);
  auto enabled = GetEnableBit(context_id, source_id);
 
  // 获取中断挂起状态
  auto pending = GetPendingBit(source_id);
 
  return {priority, enabled, pending};
}

GetContextId()

__always_inline auto Plic::GetContextId ( uint32_t  hart_id, uint32_t  mode = 1  ) const -> uint32_t

inlineprivate

计算 context ID

Parameters

hart_id	hart ID
mode	模式 (0=M-mode, 1=S-mode)

Returns

uint32_t context ID

Note

2 个模式的 context ID 计算方式为: hart_id * 2 + mode

Definition at line 119 of file plic.h.

                  {
    return hart_id * 2 + mode;
  }

Here is the caller graph for this function:

GetEnableBit()

auto Plic::GetEnableBit ( uint32_t  context_id, uint32_t  source_id  ) const -> bool

private

获取使能位寄存器中指定中断源的状态

Parameters

context_id	context ID
source_id	中断源 ID (1-1023，0 保留)

Returns

bool 对应位的状态

Definition at line 95 of file plic.cpp.

                                                                             {
  uint32_t word_index = source_id / 32;
  uint32_t bit_index = source_id % 32;
  uint32_t* word_addr = reinterpret_cast<uint32_t*>(
      base_addr_ + kEnableBitsOffset + (context_id * kEnableSize) +
      (word_index * 4));
  return (*word_addr >> bit_index) & 1;
}

GetPendingBit()

auto Plic::GetPendingBit ( uint32_t  source_id ) const -> bool

private

获取挂起位寄存器中指定中断源的状态

Parameters

source_id

中断源 ID (1-1023，0 保留)

Returns

bool 对应位的状态

Definition at line 123 of file plic.cpp.

                                                         {
  uint32_t word_index = source_id / 32;
  uint32_t bit_index = source_id % 32;
  uint32_t* word_addr = reinterpret_cast<uint32_t*>(
      base_addr_ + kPendingBitsOffset + (word_index * 4));
  return (*word_addr >> bit_index) & 1;
}

operator=() [1/2]

auto Plic::operator= ( const Plic &  ) -> Plic &=default

default

operator=() [2/2]

auto Plic::operator= ( Plic &&  ) -> Plic &=default

default

PriorityThreshold()

auto Plic::PriorityThreshold ( uint32_t  context_id ) const -> uint32_t&

private

获取优先级阈值寄存器

Parameters

context_id

context ID

Returns

uint32_t& 寄存器引用

Definition at line 143 of file plic.cpp.

                                                                   {
  return *reinterpret_cast<uint32_t*>(base_addr_ + kContextOffset +
                                      (context_id * kContextSize) +
                                      kPriorityThresholdOffset);
}

Here is the caller graph for this function:

RegisterInterruptFunc()

auto Plic::RegisterInterruptFunc	(	uint8_t	cause,
		InterruptDelegate	func
	)		-> void

注册外部中断处理函数

Parameters

cause	外部中断号
func	外部中断处理函数

Definition at line 61 of file plic.cpp.

            {
  interrupt_handlers_[cause] = func;
}

Set()

auto Plic::Set	(	uint32_t	hart_id,
		uint32_t	source_id,
		uint32_t	priority,
		bool	enable
	)		const -> void

设置指定中断源的使能状态

Parameters

hart_id	hart ID
source_id	中断源 ID (1-1023)
priority	中断优先级 (0-7, 0 表示禁用)
enable	是否使能该中断

Definition at line 70 of file plic.cpp.

                                          {
  // 设置中断优先级
  SourcePriority(source_id) = priority;
 
  // 设置中断使能状态
  uint32_t context_id = GetContextId(hart_id);
  SetEnableBit(context_id, source_id, enable);
}

SetEnableBit()

auto Plic::SetEnableBit ( uint32_t  context_id, uint32_t  source_id, bool  value  ) const -> void

private

设置使能位寄存器中指定中断源的状态

Parameters

context_id	context ID
source_id	中断源 ID (1-1023，0 保留)
value	要设置的值

Definition at line 104 of file plic.cpp.

                                                  {
  uint32_t word_index = source_id / 32;
  uint32_t bit_index = source_id % 32;
  uint32_t* word_addr = reinterpret_cast<uint32_t*>(
      base_addr_ + kEnableBitsOffset + (context_id * kEnableSize) +
      (word_index * 4));
  if (value) {
    *word_addr |= (1U << bit_index);
  } else {
    *word_addr &= ~(1U << bit_index);
  }
}

Here is the caller graph for this function:

SetPendingBit()

auto Plic::SetPendingBit ( uint32_t  source_id, bool  value  ) const -> void

private

设置挂起位寄存器中指定中断源的状态

Parameters

source_id	中断源 ID (1-1023，0 保留)
value	要设置的值

Definition at line 131 of file plic.cpp.

                                                                     {
  uint32_t word_index = source_id / 32;
  uint32_t bit_index = source_id % 32;
  uint32_t* word_addr = reinterpret_cast<uint32_t*>(
      base_addr_ + kPendingBitsOffset + (word_index * 4));
  if (value) {
    *word_addr |= (1U << bit_index);
  } else {
    *word_addr &= ~(1U << bit_index);
  }
}

SourcePriority()

auto Plic::SourcePriority ( uint32_t  source_id ) const -> uint32_t&

private

获取中断源优先级寄存器

Parameters

source_id

中断源 ID (1-1023，0 保留)

Returns

uint32_t& 寄存器引用

Definition at line 118 of file plic.cpp.

                                                               {
  return *reinterpret_cast<uint32_t*>(base_addr_ + kSourcePriorityOffset +
                                      (source_id * sizeof(uint32_t)));
}

Here is the caller graph for this function:

Which()

auto Plic::Which

(

)

const -> uint32_t

向 Plic 询问中断

Returns

uint32_t 中断源 ID (1-1023)

Definition at line 51 of file plic.cpp.

                                   {
  auto context_id = GetContextId(cpu_io::GetCurrentCoreId());
  return ClaimComplete(context_id);
}

Here is the call graph for this function:

Member Data Documentation

base_addr_

uint64_t Plic::base_addr_ {0}

private

Definition at line 108 of file plic.h.

{0};

context_count_

size_t Plic::context_count_ {0}

private

Definition at line 110 of file plic.h.

{0};

interrupt_handlers_

std::array< Plic::InterruptDelegate, Plic::kInterruptMaxCount > Plic::interrupt_handlers_

staticprivate

外部中断处理函数数组

Definition at line 106 of file plic.h.

kClaimCompleteOffset

constexpr uint64_t Plic::kClaimCompleteOffset = 0x4

staticconstexprprivate

Definition at line 100 of file plic.h.

kContextOffset

constexpr uint64_t Plic::kContextOffset = 0x200000

staticconstexprprivate

Definition at line 95 of file plic.h.

kContextSize

constexpr uint64_t Plic::kContextSize = 0x1000

staticconstexprprivate

Definition at line 98 of file plic.h.

kEnableBitsOffset

constexpr uint64_t Plic::kEnableBitsOffset = 0x002000

staticconstexprprivate

Definition at line 94 of file plic.h.

kEnableSize

constexpr uint64_t Plic::kEnableSize = 0x80

staticconstexprprivate

Definition at line 103 of file plic.h.

kInterruptMaxCount

constexpr size_t Plic::kInterruptMaxCount = 16

staticconstexpr

最大外部中断数量

Definition at line 25 of file plic.h.

kPendingBitsOffset

constexpr uint64_t Plic::kPendingBitsOffset = 0x001000

staticconstexprprivate

Definition at line 93 of file plic.h.

kPriorityThresholdOffset

constexpr uint64_t Plic::kPriorityThresholdOffset = 0x0

staticconstexprprivate

Definition at line 99 of file plic.h.

kSourcePriorityOffset

constexpr uint64_t Plic::kSourcePriorityOffset = 0x000000

staticconstexprprivate

Definition at line 92 of file plic.h.

ndev_

size_t Plic::ndev_ {0}

private

Definition at line 109 of file plic.h.

{0};

---

The documentation for this class was generated from the following files:

• /workspaces/SimpleKernel/src/arch/riscv64/plic/include/plic.h
• /workspaces/SimpleKernel/src/arch/riscv64/plic/plic.cpp