emc230x 0.7.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
112
113
114
115
116
117
118
119
120
121
122
123
124
125

// 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 crate::{Error, FanSelect};
pub(crate) use configuration::Configuration;
pub(crate) use drive_fail_band::{DriveFailBandHigh, DriveFailBandLow};
pub(crate) use fan_configuration1::FanConfiguration1;
pub(crate) use fan_configuration2::FanConfiguration2;
pub(crate) use fan_drive_fail_status::FanDriveFailStatus;
pub(crate) use fan_drive_setting::FanDriveSetting;
pub(crate) use fan_interrupt_enable::FanInterruptEnable;
pub(crate) use fan_min_drive::FanMinimumDrive;
pub(crate) use fan_spin_status::FanSpinStatus;
pub(crate) use fan_spin_up_config::FanSpinUpConfig;
pub(crate) use fan_stall_status::FanStallStatus;
pub(crate) use fan_status::FanStatus;
pub(crate) use max_step_size::MaxStepSize;
pub(crate) use pid_gain::PidGain;
pub(crate) use product_features::ProductFeatures;
pub(crate) use product_id::ProductId;
pub(crate) use pwm_base::{PwmBase123, PwmBase45};
pub(crate) use pwm_divide::PwmDivide;
pub(crate) use pwm_output_config::PwmOutputConfig;
pub(crate) use pwm_polarity_config::PwmPolarityConfig;
pub(crate) use software_lock::SoftwareLock;
pub(crate) use tach_reading::{TachReadingHigh, TachReadingLow};
pub(crate) use tach_target::{TachTargetHigh, TachTargetLow};
pub(crate) use valid_tach_count::ValidTachCount;

pub(crate) mod configuration;
pub(crate) mod drive_fail_band;
pub(crate) mod fan_configuration1;
pub(crate) mod fan_configuration2;
pub(crate) mod fan_drive_fail_status;
pub(crate) mod fan_drive_setting;
pub(crate) mod fan_interrupt_enable;
pub(crate) mod fan_min_drive;
pub(crate) mod fan_spin_status;
pub(crate) mod fan_spin_up_config;
pub(crate) mod fan_stall_status;
pub(crate) mod fan_status;
pub(crate) mod max_step_size;
pub(crate) mod pid_gain;
pub(crate) mod product_features;
pub(crate) mod product_id;
pub(crate) mod pwm_base;
pub(crate) mod pwm_divide;
pub(crate) mod pwm_output_config;
pub(crate) mod pwm_polarity_config;
pub(crate) mod software_lock;
pub(crate) mod tach_reading;
pub(crate) mod tach_target;
pub(crate) mod valid_tach_count;

pub(crate) const FAN1_BASE: u8 = 0x30;
pub(crate) const FAN2_BASE: u8 = 0x40;
pub(crate) const FAN3_BASE: u8 = 0x50;
pub(crate) const FAN4_BASE: u8 = 0x60;
pub(crate) const FAN5_BASE: u8 = 0x70;

pub(crate) fn fan_register_address(sel: FanSelect, offset: u8) -> Result<u8, Error> {
    let base = match sel.0 {
        1 => FAN1_BASE,
        2 => FAN2_BASE,
        3 => FAN3_BASE,
        4 => FAN4_BASE,
        5 => FAN5_BASE,
        _ => return Err(Error::InvalidFan),
    };

    Ok(base + offset)
}

#[derive(Clone, Copy, Debug, emc230x_macros::RegisterAddress)]
#[register(address = 0xFE, default = 0x5D)]
pub struct ManufacturerId(u8);

impl ManufacturerId {
    pub fn mfg_id(&self) -> u8 {
        self.0
    }
}

#[derive(Clone, Copy, Debug, emc230x_macros::RegisterAddress)]
#[register(address = 0xFF, default = 0x80)]
pub struct SiliconRevision(u8);

pub(crate) trait RegisterAddress {
    const ADDRESS: u8;
}

pub(crate) trait RegisterOffset {
    const OFFSET: u8;

    #[cfg(test)]
    const FAN1_ADDRESS: u8 = FAN1_BASE + Self::OFFSET;

    #[cfg(test)]
    const FAN2_ADDRESS: u8 = FAN2_BASE + Self::OFFSET;

    #[cfg(test)]
    const FAN3_ADDRESS: u8 = FAN3_BASE + Self::OFFSET;

    #[cfg(test)]
    const FAN4_ADDRESS: u8 = FAN4_BASE + Self::OFFSET;

    #[cfg(test)]
    const FAN5_ADDRESS: u8 = FAN5_BASE + Self::OFFSET;

    #[cfg(test)]
    fn fan_address(select: FanSelect) -> Result<u8, Error> {
        match select.0 {
            1 => Ok(Self::FAN1_ADDRESS),
            2 => Ok(Self::FAN2_ADDRESS),
            3 => Ok(Self::FAN3_ADDRESS),
            4 => Ok(Self::FAN4_ADDRESS),
            5 => Ok(Self::FAN5_ADDRESS),
            _ => Err(Error::InvalidFan),
        }
    }
}