components/
si7021.rs

1// Licensed under the Apache License, Version 2.0 or the MIT License.
2// SPDX-License-Identifier: Apache-2.0 OR MIT
3// Copyright Tock Contributors 2022.
4
5//! Components for the SI7021 Temperature/Humidity Sensor.
6//!
7//! This provides the SI7021Component which provides access to the SI7021 over
8//! I2C.
9//!
10//! Usage
11//! -----
12//! ```rust
13//! let si7021 = SI7021Component::new(mux_i2c, mux_alarm, 0x40).finalize(
14//!     components::si7021_component_static!(sam4l::ast::Ast));
15//! ```
16
17// Author: Philip Levis <pal@cs.stanford.edu>
18// Last modified: 6/20/2018
19
20use core::mem::MaybeUninit;
21
22use capsules_core::virtualizers::virtual_alarm::{MuxAlarm, VirtualMuxAlarm};
23use capsules_core::virtualizers::virtual_i2c::{I2CDevice, MuxI2C};
24use capsules_extra::si7021::SI7021;
25use kernel::component::Component;
26use kernel::hil::i2c;
27use kernel::hil::time::{self, Alarm};
28
29// Setup static space for the objects.
30#[macro_export]
31macro_rules! si7021_component_static {
32    ($A:ty, $I:ty $(,)? ) => {{
33        let alarm = kernel::static_buf!(
34            capsules_core::virtualizers::virtual_alarm::VirtualMuxAlarm<'static, $A>
35        );
36        let i2c_device =
37            kernel::static_buf!(capsules_core::virtualizers::virtual_i2c::I2CDevice<'static, $I>);
38        let si7021 = kernel::static_buf!(
39            capsules_extra::si7021::SI7021<
40                'static,
41                capsules_core::virtualizers::virtual_alarm::VirtualMuxAlarm<'static, $A>,
42                capsules_core::virtualizers::virtual_i2c::I2CDevice<'static, $I>,
43            >
44        );
45        let buffer = kernel::static_buf!([u8; 14]);
46
47        (alarm, i2c_device, si7021, buffer)
48    };};
49}
50
51pub type SI7021ComponentType<A, I> = capsules_extra::si7021::SI7021<'static, A, I>;
52
53pub struct SI7021Component<A: 'static + time::Alarm<'static>, I: 'static + i2c::I2CMaster<'static>>
54{
55    i2c_mux: &'static MuxI2C<'static, I>,
56    alarm_mux: &'static MuxAlarm<'static, A>,
57    i2c_address: u8,
58}
59
60impl<A: 'static + time::Alarm<'static>, I: 'static + i2c::I2CMaster<'static>>
61    SI7021Component<A, I>
62{
63    pub fn new(
64        i2c: &'static MuxI2C<'static, I>,
65        alarm: &'static MuxAlarm<'static, A>,
66        i2c_address: u8,
67    ) -> Self {
68        SI7021Component {
69            i2c_mux: i2c,
70            alarm_mux: alarm,
71            i2c_address,
72        }
73    }
74}
75
76impl<A: 'static + time::Alarm<'static>, I: 'static + i2c::I2CMaster<'static>> Component
77    for SI7021Component<A, I>
78{
79    type StaticInput = (
80        &'static mut MaybeUninit<VirtualMuxAlarm<'static, A>>,
81        &'static mut MaybeUninit<I2CDevice<'static, I>>,
82        &'static mut MaybeUninit<
83            SI7021<'static, VirtualMuxAlarm<'static, A>, I2CDevice<'static, I>>,
84        >,
85        &'static mut MaybeUninit<[u8; 14]>,
86    );
87    type Output = &'static SI7021<'static, VirtualMuxAlarm<'static, A>, I2CDevice<'static, I>>;
88
89    fn finalize(self, static_buffer: Self::StaticInput) -> Self::Output {
90        let si7021_i2c = static_buffer
91            .1
92            .write(I2CDevice::new(self.i2c_mux, self.i2c_address));
93
94        let si7021_alarm = static_buffer.0.write(VirtualMuxAlarm::new(self.alarm_mux));
95        si7021_alarm.setup();
96
97        let buffer = static_buffer.3.write([0; 14]);
98
99        let si7021 = static_buffer
100            .2
101            .write(SI7021::new(si7021_i2c, si7021_alarm, buffer));
102
103        si7021_i2c.set_client(si7021);
104        si7021_alarm.set_alarm_client(si7021);
105        si7021
106    }
107}
components/si7021.rs

components/
si7021.rs
