emc230x 0.6.0

An async driver for the EMC230x family of fan controllers
Documentation 
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

// Copyright (c) 2024 Jake Swensen
// SPDX-License-Identifier: MPL-2.0
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

use super::RegisterOffset;
use emc230x_macros::RegisterOffset;

bitfield::bitfield! {
    #[derive(Clone, Copy, RegisterOffset)]
    #[register(offset = 0x0F, default = 0xF8)]
    pub struct TachReadingLow(u8);
    impl Debug;

    /// Tach Reading Low Byte
    pub fxtr, set_fxtr: 7, 3;
}

bitfield::bitfield! {
    #[derive(Clone, Copy, RegisterOffset)]
    #[register(offset = 0x0E, default = 0xFF)]
    pub struct TachReadingHigh(u8);
    impl Debug;

    /// Tach Reading High Byte
    pub fxtr, set_fxtr: 7, 0;
}

#[derive(Clone, Copy, Debug)]
pub struct TachReading {
    low: TachReadingLow,
    high: TachReadingHigh,
}

impl TachReading {
    /// Return the logical value of the lower byte of the tachometer reading.
    pub fn low(&self) -> u8 {
        self.low.fxtr()
    }

    /// Return the logical value of the higher byte of the tachometer reading.
    pub fn high(&self) -> u8 {
        self.high.fxtr()
    }

    /// Return the raw value of the lower byte of the tachometer reading.
    ///
    /// This is the value that is sent over the I2C bus.
    pub fn raw_low(&self) -> u8 {
        self.low.0
    }

    /// Return the raw value of the higher byte of the tachometer reading.
    ///
    /// This is the value that is sent over the I2C bus.
    pub fn raw_high(&self) -> u8 {
        self.high.0
    }
}

impl From<(TachReadingLow, TachReadingHigh)> for TachReading {
    fn from(val: (TachReadingLow, TachReadingHigh)) -> Self {
        Self {
            low: val.0,
            high: val.1,
        }
    }
}

impl From<TachReading> for (TachReadingLow, TachReadingHigh) {
    fn from(val: TachReading) -> Self {
        (val.low, val.high)
    }
}

impl From<u16> for TachReading {
    fn from(val: u16) -> Self {
        let mut low = TachReadingLow::default();
        low.set_fxtr((val & 0x1F) as u8);

        let mut high = TachReadingHigh::default();
        high.set_fxtr(((val & 0x3FE0) >> 5_u8) as u8);

        Self { low, high }
    }
}

impl From<TachReading> for u16 {
    fn from(val: TachReading) -> Self {
        let low = val.low.fxtr() as u16;
        let high = val.high.fxtr() as u16;
        (high << 5_u16) | low
    }
}

mod tests {
    #[test]
    fn tach_reading() {
        let tach_reading = super::TachReading::from(0x1FFF);
        assert_eq!(tach_reading.low.0, 0b1111_1000);
        assert_eq!(tach_reading.high.0, 0b1111_1111);
        assert_eq!(u16::from(tach_reading), 0x1FFF);

        let tach_reading = super::TachReading::from(0x0F99);
        assert_eq!(tach_reading.low.0, 0b1100_1000);
        assert_eq!(tach_reading.high.0, 0b0111_1100);
        assert_eq!(u16::from(tach_reading), 0x0F99);
    }
}