components/
moisture.rs

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
// Licensed under the Apache License, Version 2.0 or the MIT License.
// SPDX-License-Identifier: Apache-2.0 OR MIT
// Copyright Tock Contributors 2022.

//! Component for any moisture sensor.
//!
//! Usage
//! -----
//! ```rust
//!     let moisture = components::moisture::MoistureComponent::new(
//!         board_kernel,
//!         capsules_extra::moisture::DRIVER_NUM,
//!         chirp_moisture,
//!     )
//!     .finalize(components::moisture_component_static!(ChirpI2cMoistureType));
//! ```

use capsules_extra::moisture::MoistureSensor;
use core::mem::MaybeUninit;
use kernel::capabilities;
use kernel::component::Component;
use kernel::create_capability;
use kernel::hil;

#[macro_export]
macro_rules! moisture_component_static {
    ($H: ty $(,)?) => {{
        kernel::static_buf!(capsules_extra::moisture::MoistureSensor<'static, $H>)
    };};
}

pub type MoistureComponentType<H> = capsules_extra::moisture::MoistureSensor<'static, H>;

pub struct MoistureComponent<T: 'static + hil::sensors::MoistureDriver<'static>> {
    board_kernel: &'static kernel::Kernel,
    driver_num: usize,
    sensor: &'static T,
}

impl<T: 'static + hil::sensors::MoistureDriver<'static>> MoistureComponent<T> {
    pub fn new(
        board_kernel: &'static kernel::Kernel,
        driver_num: usize,
        sensor: &'static T,
    ) -> MoistureComponent<T> {
        MoistureComponent {
            board_kernel,
            driver_num,
            sensor,
        }
    }
}

impl<T: 'static + hil::sensors::MoistureDriver<'static>> Component for MoistureComponent<T> {
    type StaticInput = &'static mut MaybeUninit<MoistureSensor<'static, T>>;
    type Output = &'static MoistureSensor<'static, T>;

    fn finalize(self, s: Self::StaticInput) -> Self::Output {
        let grant_cap = create_capability!(capabilities::MemoryAllocationCapability);

        let moisture = s.write(MoistureSensor::new(
            self.sensor,
            self.board_kernel.create_grant(self.driver_num, &grant_cap),
        ));

        hil::sensors::MoistureDriver::set_client(self.sensor, moisture);
        moisture
    }
}