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

//     RustDuino : A generic HAL implementation for Arduino Boards in Rust
//     Copyright (C) 2021  Satender Kumar Yadav, 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 files contain the code for combining all serial ports into one structure for easier implementation.
//! See the section 22 of ATMEGA2560P datasheet.

// Crates which would be used in the implementation.
// We will be using standard volatile and bit_field crates now for a better read and write.
use crate::atmega2560p::com::usart_initialize::{UsartNum, UsartObject};

/// This struct contains all 4 USART in ARDUINO MEGA arranged in a array.
/// First a new Serial is needed to be created to access all USARTs.
/// Each USART can be accesed through the serial struct using
/// serial.usart[n\], where 0 <= n <= 3 and serial is a object of this structure.
#[repr(C, packed)]
pub struct Serial {
    pub usart: [UsartObject; 4],
}

impl Serial {
    /// Creates a new Serial struct object.
    /// The struct serial will contain all the USARTs at one place.
    /// # Returns
    /// * `a struct object` - Which is to be worked upon.
    pub unsafe fn new() -> Serial {
        Serial {
            usart: [
                UsartObject::new(UsartNum::Usart0),
                UsartObject::new(UsartNum::Usart1),
                UsartObject::new(UsartNum::Usart2),
                UsartObject::new(UsartNum::Usart3),
            ],
        }
    }
}