1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
//! Module containing the fan sensors and their related functionality.
use super::*;
use crate::hwmon::sync_hwmon::Hwmon;
use crate::units::{AngularVelocity, FanDivisor, Raw};
use std::path::{Path, PathBuf};
/// Helper trait that sums up all functionality of a read-only fan sensor.
pub trait FanSensor: SyncSensor + std::fmt::Debug {
/// Reads the target_revs subfunction of this fan sensor.
///
/// Only makes sense if the chip supports closed-loop fan speed control based on the measured fan speed.
/// Returns an error, if this sensor doesn't support the subfunction.
fn read_target(&self) -> Result<AngularVelocity> {
let raw = self.read_raw(SensorSubFunctionType::Target)?;
AngularVelocity::from_raw(&raw).map_err(Error::from)
}
/// Reads the div subfunction of this fan sensor.
/// Returns an error, if this sensor doesn't support the subfunction.
fn read_div(&self) -> Result<FanDivisor> {
let raw = self.read_raw(SensorSubFunctionType::Div)?;
FanDivisor::from_raw(&raw).map_err(Error::from)
}
/// Reads whether or not this sensor is enabled.
/// Returns an error, if the sensor doesn't support the feature.
fn read_enable(&self) -> Result<bool> {
let raw = self.read_raw(SensorSubFunctionType::Enable)?;
bool::from_raw(&raw).map_err(Error::from)
}
/// Reads the input subfunction of this temp sensor.
/// Returns an error, if this sensor doesn't support the subtype.
fn read_input(&self) -> Result<AngularVelocity> {
if self.read_faulty().unwrap_or(false) {
return Err(Error::FaultySensor);
}
let raw = self.read_raw(SensorSubFunctionType::Input)?;
AngularVelocity::from_raw(&raw).map_err(Error::from)
}
/// Reads this sensor's min value.
/// Returns an error, if this sensor doesn't support the feature.
fn read_min(&self) -> Result<AngularVelocity> {
let raw = self.read_raw(SensorSubFunctionType::Min)?;
AngularVelocity::from_raw(&raw).map_err(Error::from)
}
/// Reads this sensor's max value.
/// Returns an error, if this sensor doesn't support the feature.
fn read_max(&self) -> Result<AngularVelocity> {
let raw = self.read_raw(SensorSubFunctionType::Max)?;
AngularVelocity::from_raw(&raw).map_err(Error::from)
}
/// Reads whether this sensor is faulty or not.
/// Returns an error, if this sensor doesn't support the feature.
fn read_faulty(&self) -> Result<bool> {
let raw = self.read_raw(SensorSubFunctionType::Fault)?;
bool::from_raw(&raw).map_err(Error::from)
}
/// Reads whether or not an alarm condition exists for the sensor.
/// Returns an error, if the sensor doesn't support the feature.
fn read_alarm(&self) -> Result<bool> {
let raw = self.read_raw(SensorSubFunctionType::Alarm)?;
bool::from_raw(&raw).map_err(Error::from)
}
/// Reads whether or not an alarm condition exists for the min subfunction of the sensor.
/// Returns an error, if the sensor doesn't support the feature.
fn read_min_alarm(&self) -> Result<bool> {
let raw = self.read_raw(SensorSubFunctionType::MinAlarm)?;
bool::from_raw(&raw).map_err(Error::from)
}
/// Reads whether or not an alarm condition exists for the max subfunction of the sensor.
/// Returns an error, if the sensor doesn't support the feature.
fn read_max_alarm(&self) -> Result<bool> {
let raw = self.read_raw(SensorSubFunctionType::MaxAlarm)?;
bool::from_raw(&raw).map_err(Error::from)
}
/// Reads whether or not an alarm condition for the sensor also triggers beeping.
/// Returns an error, if the sensor doesn't support the feature.
fn read_beep(&self) -> Result<bool> {
let raw = self.read_raw(SensorSubFunctionType::Beep)?;
bool::from_raw(&raw).map_err(Error::from)
}
}
/// Struct that represents a read only fan sensor.
#[derive(Debug, Clone)]
pub(crate) struct FanSensorStruct {
hwmon_path: PathBuf,
index: u16,
}
impl Sensor for FanSensorStruct {
fn static_base() -> &'static str where Self: Sized {
"fan"
}
fn base(&self) -> &'static str {
"fan"
}
fn index(&self) -> u16 {
self.index
}
fn hwmon_path(&self) -> &Path {
self.hwmon_path.as_path()
}
}
impl SyncSensor for FanSensorStruct {}
impl SyncSensorExt for FanSensorStruct {
fn parse(hwmon: &Hwmon, index: u16) -> Result<Self> {
let sensor = Self {
hwmon_path: hwmon.path().to_path_buf(),
index,
};
inspect_sensor(sensor, SensorSubFunctionType::Input)
}
}
impl FanSensor for FanSensorStruct {}
#[cfg(feature = "writeable")]
impl WriteableSensor for FanSensorStruct {}
#[cfg(feature = "writeable")]
/// Helper trait that sums up all functionality of a read-write fan sensor.
pub trait WriteableFanSensor: FanSensor + WriteableSensor {
/// Converts target and writes it to this fan's target subfunction.
///
/// Only makes sense if the chip supports closed-loop fan speed control based on the measured fan speed.
/// Returns an error, if this sensor doesn't support the subfunction.
fn write_target(&self, target: AngularVelocity) -> Result<()> {
self.write_raw(SensorSubFunctionType::Target, &target.to_raw())
}
/// Converts div and writes it to this fan's divisor subfunction.
/// Returns an error, if this sensor doesn't support the subfunction.
fn write_div(&self, div: FanDivisor) -> Result<()> {
self.write_raw(SensorSubFunctionType::Div, &div.to_raw())
}
/// Sets this sensor's enabled state.
/// Returns an error, if the sensor doesn't support the feature.
fn write_enable(&self, enable: bool) -> Result<()> {
self.write_raw(SensorSubFunctionType::Enable, &enable.to_raw())
}
/// Writes this sensor's min value.
/// Returns an error, if the sensor doesn't support the feature.
fn write_min(&self, min: AngularVelocity) -> Result<()> {
self.write_raw(SensorSubFunctionType::Min, &min.to_raw())
}
/// Writes this sensor's max value.
/// Returns an error, if the sensor doesn't support the feature.
fn write_max(&self, max: AngularVelocity) -> Result<()> {
self.write_raw(SensorSubFunctionType::Max, &max.to_raw())
}
/// Sets whether or not an alarm condition for the sensor also triggers beeping.
/// Returns an error, if the sensor doesn't support the feature.
fn write_beep(&self, beep: bool) -> Result<()> {
self.write_raw(SensorSubFunctionType::Beep, &beep.to_raw())
}
}
#[cfg(feature = "writeable")]
impl WriteableFanSensor for FanSensorStruct {}