xref: /DragonOS/kernel/src/driver/clocksource/acpi_pm.rs (revision dd8e74ef0d7f91a141bd217736bef4fe7dc6df3d)
1 use crate::{
2     alloc::string::ToString,
3     arch::{io::PortIOArch, CurrentPortIOArch},
4     driver::acpi::{
5         acpi_manager,
6         pmtmr::{ACPI_PM_MASK, PMTMR_TICKS_PER_SEC},
7     },
8     libs::spinlock::SpinLock,
9     time::{
10         clocksource::{Clocksource, ClocksourceData, ClocksourceFlags, ClocksourceMask, CycleNum},
11         PIT_TICK_RATE,
12     },
13 };
14 use acpi::fadt::Fadt;
15 use alloc::sync::{Arc, Weak};
16 use core::intrinsics::unlikely;
17 use core::sync::atomic::{AtomicU32, Ordering};
18 use system_error::SystemError;
19 
20 // 参考:https://code.dragonos.org.cn/xref/linux-6.6.21/drivers/clocksource/acpi_pm.c
21 
22 /// acpi_pmtmr所在的I/O端口
23 pub static mut PMTMR_IO_PORT: AtomicU32 = AtomicU32::new(0);
24 
25 /// # 读取acpi_pmtmr当前值,并对齐进行掩码操作
26 #[inline(always)]
27 fn read_pmtmr() -> u32 {
28     return unsafe { CurrentPortIOArch::in32(PMTMR_IO_PORT.load(Ordering::SeqCst) as u16) }
29         & ACPI_PM_MASK as u32;
30 }
31 
32 //参考: https://code.dragonos.org.cn/xref/linux-6.6.21/drivers/clocksource/acpi_pm.c#41
33 /// # 读取acpi_pmtmr的值,并进行多次读取以保证获取正确的值
34 ///
35 /// ## 返回值
36 /// - u32: 读取到的acpi_pmtmr值
37 pub fn acpi_pm_read_verified() -> u32 {
38     let mut v2: u32;
39 
40     // 因为某些损坏芯片组(如ICH4、PIIX4和PIIX4E)可能导致APCI PM时钟源未锁存
41     // 因此需要多次读取以保证获取正确的值
42     loop {
43         let v1 = read_pmtmr();
44         v2 = read_pmtmr();
45         let v3 = read_pmtmr();
46 
47         if !(unlikely((v2 > v3 || v1 < v3) && v1 > v2 || v1 < v3 && v2 > v3)) {
48             break;
49         }
50     }
51 
52     return v2;
53 }
54 
55 /// # 作为时钟源的读取函数
56 ///
57 /// ## 返回值
58 /// - u64: acpi_pmtmr的当前值
59 fn acpi_pm_read() -> u64 {
60     return read_pmtmr() as u64;
61 }
62 
63 pub static mut CLOCKSOURCE_ACPI_PM: Option<Arc<Acpipm>> = None;
64 
65 pub fn clocksource_acpi_pm() -> Arc<Acpipm> {
66     return unsafe { CLOCKSOURCE_ACPI_PM.as_ref().unwrap().clone() };
67 }
68 
69 #[derive(Debug)]
70 pub struct Acpipm(SpinLock<InnerAcpipm>);
71 
72 #[derive(Debug)]
73 struct InnerAcpipm {
74     data: ClocksourceData,
75     self_reaf: Weak<Acpipm>,
76 }
77 
78 impl Acpipm {
79     pub fn new() -> Arc<Self> {
80         let data = ClocksourceData {
81             name: "acpi_pm".to_string(),
82             rating: 200,
83             mask: ClocksourceMask::new(ACPI_PM_MASK),
84             mult: 0,
85             shift: 0,
86             max_idle_ns: Default::default(),
87             flags: ClocksourceFlags::CLOCK_SOURCE_IS_CONTINUOUS,
88             watchdog_last: CycleNum::new(0),
89             uncertainty_margin: 0,
90             maxadj: 0,
91         };
92         let acpi_pm = Arc::new(Acpipm(SpinLock::new(InnerAcpipm {
93             data,
94             self_reaf: Default::default(),
95         })));
96         acpi_pm.0.lock().self_reaf = Arc::downgrade(&acpi_pm);
97 
98         return acpi_pm;
99     }
100 }
101 
102 impl Clocksource for Acpipm {
103     fn read(&self) -> CycleNum {
104         return CycleNum::new(acpi_pm_read());
105     }
106 
107     fn clocksource_data(&self) -> ClocksourceData {
108         let inner = self.0.lock_irqsave();
109         return inner.data.clone();
110     }
111 
112     fn clocksource(&self) -> Arc<dyn Clocksource> {
113         return self.0.lock_irqsave().self_reaf.upgrade().unwrap();
114     }
115 
116     fn update_clocksource_data(&self, data: ClocksourceData) -> Result<(), SystemError> {
117         let d = &mut self.0.lock_irqsave().data;
118         d.set_flags(data.flags);
119         d.set_mask(data.mask);
120         d.set_max_idle_ns(data.max_idle_ns);
121         d.set_mult(data.mult);
122         d.set_name(data.name);
123         d.set_rating(data.rating);
124         d.set_shift(data.shift);
125         d.watchdog_last = data.watchdog_last;
126         return Ok(());
127     }
128 }
129 
130 // 参考:https://code.dragonos.org.cn/xref/linux-6.6.21/arch/x86/include/asm/mach_timer.h?fi=mach_prepare_counter
131 #[allow(dead_code)]
132 pub const CALIBRATE_TIME_MSEC: u64 = 30;
133 pub const CALIBRATE_LATCH: u64 = (PIT_TICK_RATE * CALIBRATE_TIME_MSEC + 1000 / 2) / 1000;
134 
135 #[inline(always)]
136 #[allow(dead_code)]
137 pub fn mach_prepare_counter() {
138     unsafe {
139         // 将Gate位设置为高电平,从而禁用扬声器
140         CurrentPortIOArch::out8(0x61, (CurrentPortIOArch::in8(0x61) & !0x02) | 0x01);
141 
142         // 针对计数器/定时器控制器的通道2进行配置,设置为模式0,二进制计数
143         CurrentPortIOArch::out8(0x43, 0xb0);
144         CurrentPortIOArch::out8(0x42, (CALIBRATE_LATCH & 0xff) as u8);
145         CurrentPortIOArch::out8(0x42, (CALIBRATE_LATCH >> 8) as u8);
146     }
147 }
148 
149 #[allow(dead_code)]
150 pub fn mach_countup(count: &mut u32) {
151     let mut tmp: u32 = 0;
152     loop {
153         tmp += 1;
154         if (unsafe { CurrentPortIOArch::in8(0x61) } & 0x20) != 0 {
155             break;
156         }
157     }
158     *count = tmp;
159 }
160 
161 #[allow(dead_code)]
162 const PMTMR_EXPECTED_RATE: u64 =
163     (CALIBRATE_LATCH * (PMTMR_TICKS_PER_SEC >> 10)) / (PIT_TICK_RATE >> 10);
164 
165 /// # 验证ACPI PM Timer的运行速率是否在预期范围内(在x86_64架构以外的情况下验证)
166 ///
167 /// ## 返回值
168 /// - i32:如果为0则表示在预期范围内,否则不在
169 #[cfg(not(target_arch = "x86_64"))]
170 fn verify_pmtmr_rate() -> bool {
171     let mut count: u32 = 0;
172 
173     mach_prepare_counter();
174     let value1 = clocksource_acpi_pm().read().data();
175     mach_countup(&mut count);
176     let value2 = clocksource_acpi_pm().read().data();
177     let delta = (value2 - value1) & ACPI_PM_MASK;
178 
179     if (delta < (PMTMR_EXPECTED_RATE * 19) / 20) || (delta > (PMTMR_EXPECTED_RATE * 21) / 20) {
180         kinfo!(
181             "PM Timer running at invalid rate: {}",
182             100 * delta / PMTMR_EXPECTED_RATE
183         );
184         return false;
185     }
186 
187     return true;
188 }
189 #[cfg(target_arch = "x86_64")]
190 fn verify_pmtmr_rate() -> bool {
191     return true;
192 }
193 
194 const ACPI_PM_MONOTONIC_CHECKS: u32 = 10;
195 const ACPI_PM_READ_CHECKS: u32 = 10000;
196 
197 /// # 解析fadt
198 fn find_acpi_pm_clock() -> Result<(), SystemError> {
199     let fadt = acpi_manager()
200         .tables()
201         .unwrap()
202         .find_table::<Fadt>()
203         .expect("failed to find FADT table");
204     let pm_timer_block = fadt.pm_timer_block().map_err(|_| SystemError::ENODEV)?;
205     let pm_timer_block = pm_timer_block.ok_or(SystemError::ENODEV)?;
206     let pmtmr_addr = pm_timer_block.address;
207     unsafe {
208         PMTMR_IO_PORT.store(pmtmr_addr as u32, Ordering::SeqCst);
209     }
210     kinfo!("apic_pmtmr I/O port: {}", unsafe {
211         PMTMR_IO_PORT.load(Ordering::SeqCst)
212     });
213 
214     return Ok(());
215 }
216 
217 /// # 初始化ACPI PM Timer作为系统时钟源
218 // #[unified_init(INITCALL_FS)]
219 pub fn init_acpi_pm_clocksource() -> Result<(), SystemError> {
220     let acpi_pm = Acpipm::new();
221     unsafe {
222         CLOCKSOURCE_ACPI_PM = Some(acpi_pm);
223     }
224 
225     // 解析fadt
226     find_acpi_pm_clock()?;
227 
228     // 检查pmtmr_io_port是否被设置
229     if unsafe { PMTMR_IO_PORT.load(Ordering::SeqCst) } == 0 {
230         return Err(SystemError::ENODEV);
231     }
232 
233     // 验证ACPI PM Timer作为时钟源的稳定性和一致性
234     for j in 0..ACPI_PM_MONOTONIC_CHECKS {
235         let mut cnt = 100 * j;
236         while cnt > 0 {
237             cnt -= 1;
238         }
239 
240         let value1 = clocksource_acpi_pm().read().data();
241         let mut i = 0;
242         for _ in 0..ACPI_PM_READ_CHECKS {
243             let value2 = clocksource_acpi_pm().read().data();
244             if value2 == value1 {
245                 i += 1;
246                 continue;
247             }
248             if value2 > value1 {
249                 break;
250             }
251             if (value2 < value1) && (value2 < 0xfff) {
252                 break;
253             }
254             kinfo!("PM Timer had inconsistens results: {} {}", value1, value2);
255             unsafe {
256                 PMTMR_IO_PORT.store(0, Ordering::SeqCst);
257             }
258             return Err(SystemError::EINVAL);
259         }
260         if i == ACPI_PM_READ_CHECKS {
261             kinfo!("PM Timer failed consistency check: {}", value1);
262             unsafe {
263                 PMTMR_IO_PORT.store(0, Ordering::SeqCst);
264             }
265             return Err(SystemError::EINVAL);
266         }
267     }
268 
269     // 检查ACPI PM Timer的频率是否正确
270     if !verify_pmtmr_rate() {
271         unsafe {
272             PMTMR_IO_PORT.store(0, Ordering::SeqCst);
273         }
274     }
275 
276     // 检查TSC时钟源的监视器是否被禁用,如果被禁用则将时钟源的标志设置为CLOCK_SOURCE_MUST_VERIFY
277     // 没有实现clocksource_selecet_watchdog函数,所以这里设置为false
278     let tsc_clocksource_watchdog_disabled = false;
279     if tsc_clocksource_watchdog_disabled {
280         clocksource_acpi_pm().0.lock_irqsave().data.flags |=
281             ClocksourceFlags::CLOCK_SOURCE_MUST_VERIFY;
282     }
283 
284     // 注册ACPI PM Timer
285     let acpi_pmtmr = clocksource_acpi_pm() as Arc<dyn Clocksource>;
286     match acpi_pmtmr.register(100, PMTMR_TICKS_PER_SEC as u32) {
287         Ok(_) => {
288             kinfo!("ACPI PM Timer registered as clocksource sccessfully");
289             return Ok(());
290         }
291         Err(_) => {
292             kinfo!("ACPI PM Timer init registered failed");
293             return Err(SystemError::ENOSYS);
294         }
295     };
296 }
297