1 use core::{any::Any, fmt::Debug}; 2 3 use alloc::sync::{Arc, Weak}; 4 5 use crate::libs::spinlock::SpinLock; 6 7 use super::{ 8 irqchip::{IrqChip, IrqChipData}, 9 irqdomain::IrqDomain, 10 msi::MsiDesc, 11 HardwareIrqNumber, IrqNumber, 12 }; 13 14 /// per irq chip data passed down to chip functions 15 /// 16 /// 该结构体用于表示每个Irq的私有数据,且与具体的中断芯片绑定 17 /// 18 /// 参考: https://code.dragonos.org.cn/xref/linux-6.1.9/include/linux/irq.h#179 19 #[allow(dead_code)] 20 #[derive(Debug)] 21 pub struct IrqData { 22 /// 中断号, 用于表示软件逻辑视角的中断号,全局唯一 23 irq: IrqNumber, 24 inner: SpinLock<InnerIrqData>, 25 } 26 27 impl IrqData { 28 pub fn new( 29 irq: IrqNumber, 30 hwirq: HardwareIrqNumber, 31 common_data: Arc<IrqCommonData>, 32 chip: Arc<dyn IrqChip>, 33 ) -> Self { 34 return IrqData { 35 irq, 36 inner: SpinLock::new(InnerIrqData { 37 hwirq, 38 common_data, 39 chip, 40 chip_data: None, 41 domain: None, 42 parent_data: None, 43 }), 44 }; 45 } 46 47 pub fn irqd_set(&self, status: IrqStatus) { 48 // clone是为了释放inner锁 49 let common_data = self.inner.lock().common_data.clone(); 50 common_data.irqd_set(status); 51 } 52 53 #[allow(dead_code)] 54 pub fn irqd_clear(&self, status: IrqStatus) { 55 // clone是为了释放inner锁 56 let common_data = self.inner.lock().common_data.clone(); 57 common_data.irqd_clear(status); 58 } 59 60 pub fn irq(&self) -> IrqNumber { 61 self.irq 62 } 63 } 64 65 #[allow(dead_code)] 66 #[derive(Debug)] 67 struct InnerIrqData { 68 /// 硬件中断号, 用于表示在某个IrqDomain中的中断号 69 hwirq: HardwareIrqNumber, 70 /// 涉及的所有irqchip之间共享的数据 71 common_data: Arc<IrqCommonData>, 72 /// 绑定到的中断芯片 73 chip: Arc<dyn IrqChip>, 74 /// 中断芯片的私有数据(与当前irq相关) 75 chip_data: Option<Arc<dyn IrqChipData>>, 76 /// 中断域 77 domain: Option<Arc<IrqDomain>>, 78 /// 中断的父中断(如果具有中断域继承的话) 79 parent_data: Option<Weak<IrqData>>, 80 } 81 82 /// per irq data shared by all irqchips 83 /// 84 /// 参考 https://code.dragonos.org.cn/xref/linux-6.1.9/include/linux/irq.h#147 85 #[derive(Debug)] 86 pub struct IrqCommonData { 87 inner: SpinLock<InnerIrqCommonData>, 88 } 89 90 impl IrqCommonData { 91 pub fn new() -> Self { 92 let inner = InnerIrqCommonData { 93 state: IrqStatus::empty(), 94 handler_data: None, 95 msi_desc: None, 96 }; 97 return IrqCommonData { 98 inner: SpinLock::new(inner), 99 }; 100 } 101 102 pub fn irqd_set(&self, status: IrqStatus) { 103 self.inner.lock_irqsave().irqd_set(status); 104 } 105 106 pub fn irqd_clear(&self, status: IrqStatus) { 107 self.inner.lock_irqsave().irqd_clear(status); 108 } 109 } 110 111 #[allow(dead_code)] 112 #[derive(Debug)] 113 struct InnerIrqCommonData { 114 /// status information for irq chip functions. 115 state: IrqStatus, 116 /// per-IRQ data for the irq_chip methods 117 handler_data: Option<Arc<dyn IrqHandlerData>>, 118 msi_desc: Option<Arc<MsiDesc>>, 119 // todo: affinity 120 } 121 122 impl InnerIrqCommonData { 123 pub fn irqd_set(&mut self, status: IrqStatus) { 124 self.state.insert(status); 125 } 126 127 pub fn irqd_clear(&mut self, status: IrqStatus) { 128 self.state.remove(status); 129 } 130 } 131 132 pub trait IrqHandlerData: Send + Sync + Any + Debug {} 133 134 bitflags! { 135 /// 中断线状态 136 /// https://code.dragonos.org.cn/xref/linux-6.1.9/include/linux/irq.h?fi=IRQ_TYPE_PROBE#77 137 pub struct IrqLineStatus: u32 { 138 /// 默认,未指明类型 139 const IRQ_TYPE_NONE = 0x00000000; 140 /// 上升沿触发 141 const IRQ_TYPE_EDGE_RISING = 0x00000001; 142 /// 下降沿触发 143 const IRQ_TYPE_EDGE_FALLING = 0x00000002; 144 /// 上升沿和下降沿触发 145 const IRQ_TYPE_EDGE_BOTH = Self::IRQ_TYPE_EDGE_RISING.bits | Self::IRQ_TYPE_EDGE_FALLING.bits; 146 /// 高电平触发 147 const IRQ_TYPE_LEVEL_HIGH = 0x00000004; 148 /// 低电平触发 149 const IRQ_TYPE_LEVEL_LOW = 0x00000008; 150 /// 过滤掉电平位的掩码 151 const IRQ_TYPE_LEVEL_MASK = Self::IRQ_TYPE_LEVEL_LOW.bits | Self::IRQ_TYPE_LEVEL_HIGH.bits; 152 /// 上述位掩码的掩码 153 const IRQ_TYPE_SENSE_MASK = 0x0000000f; 154 /// 某些PICs使用此类型要求 `IrqChip::irq_set_type()` 设置硬件到一个合理的默认值 155 /// (由irqdomain的map()回调使用,以便为新分配的描述符同步硬件状态和软件标志位)。 156 const IRQ_TYPE_DEFAULT = Self::IRQ_TYPE_SENSE_MASK.bits; 157 158 /// 特定于探测的过程中的特殊标志 159 const IRQ_TYPE_PROBE = 0x00000010; 160 161 /// 中断是电平类型。当上述触发位通过`IrqChip::irq_set_type()` 修改时,也会在代码中更新 162 const IRQ_LEVEL = 1 << 8; 163 /// 标记一个PER_CPU的中断。将保护其免受亲和性设置的影响 164 const IRQ_PER_CPU = 1 << 9; 165 /// 中断不能被自动探测 166 const IRQ_NOPROBE = 1 << 10; 167 /// 中断不能通过request_irq()请求 168 const IRQ_NOREQUEST = 1 << 11; 169 /// 中断在request/setup_irq()中不会自动启用 170 const IRQ_NOAUTOEN = 1 << 12; 171 /// 中断不能被平衡(亲和性设置) 172 const IRQ_NO_BALANCING = 1 << 13; 173 /// 中断可以从进程上下文中迁移 174 const IRQ_MOVE_PCNTXT = 1 << 14; 175 /// 中断嵌套在另一个线程中 176 const IRQ_NESTED_THREAD = 1 << 15; 177 /// 中断不能被线程化 178 const IRQ_NOTHREAD = 1 << 16; 179 /// Dev_id是一个per-CPU变量 180 const IRQ_PER_CPU_DEVID = 1 << 17; 181 /// 总是由另一个中断轮询。将其从错误的中断检测机制和核心侧轮询中排除 182 const IRQ_IS_POLLED = 1 << 18; 183 /// 禁用延迟的中断禁用 (Disable lazy irq disable) 184 const IRQ_DISABLE_UNLAZY = 1 << 19; 185 /// 在/proc/interrupts中不显示 186 const IRQ_HIDDEN = 1 << 20; 187 /// 从note_interrupt()调试中排除 188 const IRQ_NO_DEBUG = 1 << 21; 189 } 190 191 192 193 } 194 bitflags! { 195 /// 中断状态(存储在IrqCommonData) 196 /// 197 /// 参考: https://code.dragonos.org.cn/xref/linux-6.1.9/include/linux/irq.h#227 198 pub struct IrqStatus: u32 { 199 /// 触发类型位的掩码 200 const IRQD_TRIGGER_MASK = 0xf; 201 /// 亲和性设置待处理 202 const IRQD_SETAFFINITY_PENDING = 1 << 8; 203 /// 中断已激活 204 const IRQD_ACTIVATED = 1 << 9; 205 /// 对此IRQ禁用平衡 206 const IRQD_NO_BALANCING = 1 << 10; 207 /// 中断是每个CPU特定的 208 const IRQD_PER_CPU = 1 << 11; 209 /// 中断亲和性已设置 210 const IRQD_AFFINITY_SET = 1 << 12; 211 /// 中断是电平触发 212 const IRQD_LEVEL = 1 << 13; 213 /// 中断配置为从挂起状态唤醒 214 const IRQD_WAKEUP_STATE = 1 << 14; 215 /// 中断可以在进程上下文中移动 216 const IRQD_MOVE_PCNTXT = 1 << 15; 217 /// 中断被禁用 218 const IRQD_IRQ_DISABLED = 1 << 16; 219 /// 中断被屏蔽 220 const IRQD_IRQ_MASKED = 1 << 17; 221 /// 中断正在处理中 222 const IRQD_IRQ_INPROGRESS = 1 << 18; 223 /// 唤醒模式已准备就绪 224 const IRQD_WAKEUP_ARMED = 1 << 19; 225 /// 中断被转发到一个虚拟CPU 226 const IRQD_FORWARDED_TO_VCPU = 1 << 20; 227 /// 亲和性由内核自动管理 228 const IRQD_AFFINITY_MANAGED = 1 << 21; 229 /// 中断已启动 230 const IRQD_IRQ_STARTED = 1 << 22; 231 /// 由于空亲和性掩码而关闭的中断。仅适用于亲和性管理的中断。 232 const IRQD_MANAGED_SHUTDOWN = 1 << 23; 233 /// IRQ只允许单个亲和性目标 234 const IRQD_SINGLE_TARGET = 1 << 24; 235 /// 预期的触发器已设置 236 const IRQD_DEFAULT_TRIGGER_SET = 1 << 25; 237 /// 可以使用保留模式 238 const IRQD_CAN_RESERVE = 1 << 26; 239 /// Non-maskable MSI quirk for affinity change required 240 const IRQD_MSI_NOMASK_QUIRK = 1 << 27; 241 /// 强制要求`handle_irq_()`只能在真实的中断上下文中调用 242 const IRQD_HANDLE_ENFORCE_IRQCTX = 1 << 28; 243 /// 激活时设置亲和性。在禁用时不要调用irq_chip::irq_set_affinity()。 244 const IRQD_AFFINITY_ON_ACTIVATE = 1 << 29; 245 /// 如果irqpm具有标志 IRQCHIP_ENABLE_WAKEUP_ON_SUSPEND,则在挂起时中断被启用。 246 const IRQD_IRQ_ENABLED_ON_SUSPEND = 1 << 30; 247 } 248 } 249 250 #[allow(dead_code)] 251 impl IrqStatus { 252 pub const fn is_set_affinity_pending(&self) -> bool { 253 self.contains(Self::IRQD_SETAFFINITY_PENDING) 254 } 255 256 pub const fn is_per_cpu(&self) -> bool { 257 self.contains(Self::IRQD_PER_CPU) 258 } 259 260 pub const fn can_balance(&self) -> bool { 261 !((self.bits & (Self::IRQD_PER_CPU.bits | Self::IRQD_NO_BALANCING.bits)) != 0) 262 } 263 264 pub const fn affinity_was_set(&self) -> bool { 265 self.contains(Self::IRQD_AFFINITY_SET) 266 } 267 268 pub fn mark_affinity_set(&mut self) { 269 self.insert(Self::IRQD_AFFINITY_SET); 270 } 271 272 pub const fn trigger_type_was_set(&self) -> bool { 273 self.contains(Self::IRQD_DEFAULT_TRIGGER_SET) 274 } 275 276 pub fn mark_trigger_type_set(&mut self) { 277 self.insert(Self::IRQD_DEFAULT_TRIGGER_SET); 278 } 279 280 pub const fn trigger_type(&self) -> IrqLineStatus { 281 IrqLineStatus::from_bits_truncate(self.bits & Self::IRQD_TRIGGER_MASK.bits) 282 } 283 284 /// Must only be called inside irq_chip.irq_set_type() functions or 285 /// from the DT/ACPI setup code. 286 pub const fn set_trigger_type(&mut self, trigger: IrqLineStatus) { 287 self.bits &= !Self::IRQD_TRIGGER_MASK.bits; 288 self.bits |= trigger.bits & Self::IRQD_TRIGGER_MASK.bits; 289 290 self.bits |= Self::IRQD_DEFAULT_TRIGGER_SET.bits; 291 } 292 293 pub const fn is_level_type(&self) -> bool { 294 self.contains(Self::IRQD_LEVEL) 295 } 296 297 /// Must only be called of irqchip.irq_set_affinity() or low level 298 /// hierarchy domain allocation functions. 299 pub fn set_single_target(&mut self) { 300 self.insert(Self::IRQD_SINGLE_TARGET); 301 } 302 303 pub const fn is_single_target(&self) -> bool { 304 self.contains(Self::IRQD_SINGLE_TARGET) 305 } 306 307 pub fn set_handle_enforce_irqctx(&mut self) { 308 self.insert(Self::IRQD_HANDLE_ENFORCE_IRQCTX); 309 } 310 311 pub const fn is_handle_enforce_irqctx(&self) -> bool { 312 self.contains(Self::IRQD_HANDLE_ENFORCE_IRQCTX) 313 } 314 315 pub const fn is_enabled_on_suspend(&self) -> bool { 316 self.contains(Self::IRQD_IRQ_ENABLED_ON_SUSPEND) 317 } 318 319 pub const fn is_wakeup_set(&self) -> bool { 320 self.contains(Self::IRQD_WAKEUP_STATE) 321 } 322 323 pub const fn can_move_in_process_context(&self) -> bool { 324 self.contains(Self::IRQD_MOVE_PCNTXT) 325 } 326 327 pub const fn is_irq_disabled(&self) -> bool { 328 self.contains(Self::IRQD_IRQ_DISABLED) 329 } 330 331 pub const fn is_irq_masked(&self) -> bool { 332 self.contains(Self::IRQD_IRQ_MASKED) 333 } 334 335 pub const fn is_irq_in_progress(&self) -> bool { 336 self.contains(Self::IRQD_IRQ_INPROGRESS) 337 } 338 339 pub const fn is_wakeup_armed(&self) -> bool { 340 self.contains(Self::IRQD_WAKEUP_ARMED) 341 } 342 343 pub const fn is_forwarded_to_vcpu(&self) -> bool { 344 self.contains(Self::IRQD_FORWARDED_TO_VCPU) 345 } 346 347 pub fn set_forwarded_to_vcpu(&mut self) { 348 self.insert(Self::IRQD_FORWARDED_TO_VCPU); 349 } 350 351 pub const fn is_affinity_managed(&self) -> bool { 352 self.contains(Self::IRQD_AFFINITY_MANAGED) 353 } 354 355 pub const fn is_activated(&self) -> bool { 356 self.contains(Self::IRQD_ACTIVATED) 357 } 358 359 pub fn set_activated(&mut self) { 360 self.insert(Self::IRQD_ACTIVATED); 361 } 362 363 pub fn clear_activated(&mut self) { 364 self.remove(Self::IRQD_ACTIVATED); 365 } 366 367 pub const fn is_started(&self) -> bool { 368 self.contains(Self::IRQD_IRQ_STARTED) 369 } 370 371 pub const fn is_managed_and_shutdown(&self) -> bool { 372 self.contains(Self::IRQD_MANAGED_SHUTDOWN) 373 } 374 375 pub fn set_can_reserve(&mut self) { 376 self.insert(Self::IRQD_CAN_RESERVE); 377 } 378 379 pub const fn can_reserve(&self) -> bool { 380 self.contains(Self::IRQD_CAN_RESERVE) 381 } 382 383 pub fn clear_can_reserve(&mut self) { 384 self.remove(Self::IRQD_CAN_RESERVE); 385 } 386 387 pub fn set_msi_nomask_quirk(&mut self) { 388 self.insert(Self::IRQD_MSI_NOMASK_QUIRK); 389 } 390 391 pub fn clear_msi_nomask_quirk(&mut self) { 392 self.remove(Self::IRQD_MSI_NOMASK_QUIRK); 393 } 394 395 pub const fn is_msi_nomask_quirk(&self) -> bool { 396 self.contains(Self::IRQD_MSI_NOMASK_QUIRK) 397 } 398 399 pub fn set_affinity_on_activate(&mut self) { 400 self.insert(Self::IRQD_AFFINITY_ON_ACTIVATE); 401 } 402 403 pub const fn is_affinity_on_activate(&self) -> bool { 404 self.contains(Self::IRQD_AFFINITY_ON_ACTIVATE) 405 } 406 } 407