rustduino 0.2.2

A generic HAL implementation for Arduino Boards in Rust
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

//     RustDuino : A generic HAL implementation for Arduino Boards in Rust
//     Copyright (C) 2021  Ayush Agarwal, Indian Institute of Technology Kanpur
//
//     This program is free software: you can redistribute it and/or modify
//     it under the terms of the GNU Affero General Public License as published
//     by the Free Software Foundation, either version 3 of the License, or
//     (at your option) any later version.
//
//     This program is distributed in the hope that it will be useful,
//     but WITHOUT ANY WARRANTY; without even the implied warranty of
//     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//     GNU Affero General Public License for more details.
//
//     You should have received a copy of the GNU Affero General Public License
//     along with this program.  If not, see <https://www.gnu.org/licenses/>

//! This source code creates a array for controlling all digital pins at one place in form
//! Pins array which would be used so that we get meaningful functions to work upon and
//! also the implementation of rustduino library is easier for the user.
//! Refer to section 14,15,22 and 23 of ATMEGA328P datasheet.

// Include the required crates for the code.
use crate::atmega328p::hal::pin::*;
use core::ptr::{read_volatile, write_volatile};

impl DigitalPin {
    /// Toggles the appropriate bit in PINxn register so that the mode of the pin
    /// is changed from high to low or vice versa.
    pub fn toggle(&mut self) {
        unsafe { write_volatile(&mut (*self.pin.port).pin, 0x1 << self.pin.pin) }
    }

    /// Set the pin to high output value.
    pub fn high(&mut self) {
        // Checks if pin number is valid.
        if self.pin.pin >= 8 {
            return;
        }
        let mut p = unsafe { read_volatile(&mut (*self.pin.port).port) }; // Reading the value of PORTxn.
        p = p & (1 << self.pin.pin);
        let ddr_value = unsafe { read_volatile(&mut (*self.pin.port).ddr) }; // Read the DDRxn register.
        if p == 0 && ddr_value == (0x1 << self.pin.pin) {
            // Toggling the value of PORTxn, if it isn't set to high.
            self.toggle();
        }
    }

    /// Sets the pin to low output value.
    pub fn low(&mut self) {
        // Check if pin number is valid.
        if self.pin.pin >= 8 {
            return;
        }
        let mut p = unsafe { read_volatile(&mut (*self.pin.port).port) }; //Reading the value of PORTxn.
        p = p & (1 << self.pin.pin);
        let ddr_value = unsafe { read_volatile(&mut (*self.pin.port).ddr) }; // Read the DDRxn register.
        if p != 0 && ddr_value == (0x1 << self.pin.pin) {
            //Toggling the value of PORTxn, if it isn't set to low.
            self.toggle();
        }
    }
}