avr-oxide 0.2.1

An extremely simple Rusty operating system for AVR microcontrollers
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216

/* arduino.rs
 *
 * Developed by Tim Walls <tim.walls@snowgoons.com>
 * Copyright (c) All Rights Reserved, Tim Walls
 */
//! A helper module that maps standard ATmega pins into equivalent Arduino
//! names.
//!
//! # Usage
//! You can create an instance of the `Arduino` type From the generic
//! hardware instance provided by the `avr_oxide::hal::<<device>>::hardware`
//! crate.  This then allows you to refer to pins etc. using the Arduino
//! naming conventions instead of the AVR device's own naming conventions.
//!
//! ```rust
//! use avr_oxide::hal::atmega4809;
//! use avr_oxide::arduino;
//! use avr_oxide::hal::generic::port::{ Pin, PinMode };
//!
//! fn use_arduino_types() {
//!   let hardware = atmega4809::hardware::instance();
//!   let arduino  = arduino::nanoevery::Arduino::from(hardware);
//!
//!   // We can now refer to Pord D, pin 3 on an Arduino Nano Every as
//!   // `arduino.a0`
//!   arduino.a0.set_mode(PinMode::Output);
//!   arduino.a0.set_high();
//! }
//! ```

// Imports ===================================================================

// Declarations ==============================================================
#[cfg(feature="atmega4809")]
pub mod nanoevery {
  use avr_oxide::hal::atmega4809::hardware::Hardware;
  use avr_oxide::hal::atmega4809;
  use avr_oxide::hal::generic::port::PinIdentity;

  /**
   * Arduino-style pin identifier, used to identify a pin event source at
   * runtime
   */
  pub enum ArduinoPinIdentity {
    /// The so-called 'analogue' pins (that is, pins that can be attached to
    /// a timer's PWM output)
    PinA(u8),
    /// The 'digital' pins
    PinD(u8)
  }

  pub mod pintypes {
    pub type A0  = avr_oxide::hal::atmega4809::port::portd::PinImpl;
    pub type A1  = avr_oxide::hal::atmega4809::port::portd::PinImpl;
    pub type A2  = avr_oxide::hal::atmega4809::port::portd::PinImpl;
    pub type A3  = avr_oxide::hal::atmega4809::port::portd::PinImpl;
    pub type A4  = avr_oxide::hal::atmega4809::port::porta::PinImpl;
    pub type A5  = avr_oxide::hal::atmega4809::port::porta::PinImpl;
    pub type A6  = avr_oxide::hal::atmega4809::port::portd::PinImpl;
    pub type A7  = avr_oxide::hal::atmega4809::port::portd::PinImpl;

    pub type D0  = avr_oxide::hal::atmega4809::port::portc::PinImpl;
    pub type D1  = avr_oxide::hal::atmega4809::port::portc::PinImpl;
    pub type D2  = avr_oxide::hal::atmega4809::port::porta::PinImpl;
    pub type D3  = avr_oxide::hal::atmega4809::port::portf::PinImpl;
    pub type D4  = avr_oxide::hal::atmega4809::port::portc::PinImpl;
    pub type D5  = avr_oxide::hal::atmega4809::port::portb::PinImpl;
    pub type D6  = avr_oxide::hal::atmega4809::port::portf::PinImpl;
    pub type D7  = avr_oxide::hal::atmega4809::port::porta::PinImpl;
    pub type D8  = avr_oxide::hal::atmega4809::port::porte::PinImpl;
    pub type D9  = avr_oxide::hal::atmega4809::port::portb::PinImpl;
    pub type D10 = avr_oxide::hal::atmega4809::port::portb::PinImpl;
    pub type D11 = avr_oxide::hal::atmega4809::port::porte::PinImpl;
    pub type D12 = avr_oxide::hal::atmega4809::port::porte::PinImpl;
    pub type D13 = avr_oxide::hal::atmega4809::port::porte::PinImpl;
  }

  pub struct Arduino {
    #[cfg(feature="tcb0")]
    pub timer0: &'static mut atmega4809::timer::tcb0::TimerImpl,
    #[cfg(feature="tcb1")]
    pub timer1: &'static mut atmega4809::timer::tcb1::TimerImpl,
    #[cfg(feature="tcb2")]
    pub timer2: &'static mut atmega4809::timer::tcb2::TimerImpl,
    #[cfg(feature="tcb3")]
    pub timer3: &'static mut atmega4809::timer::tcb3::TimerImpl,
    #[cfg(feature="rtc")]
    pub rtc: &'static mut atmega4809::timer::rtc::TimerImpl,

    pub a0: &'static mut pintypes::A0,
    pub a1: &'static mut pintypes::A1,
    pub a2: &'static mut pintypes::A2,
    pub a3: &'static mut pintypes::A3,
    pub a4: &'static mut pintypes::A4,
    pub a5: &'static mut pintypes::A5,
    pub a6: &'static mut pintypes::A6,
    pub a7: &'static mut pintypes::A7,

    pub d0: &'static mut pintypes::D0,
    pub d1: &'static mut pintypes::D1,
    pub d2: &'static mut pintypes::D2,
    pub d3: &'static mut pintypes::D3,
    pub d4: &'static mut pintypes::D4,
    pub d5: &'static mut pintypes::D5,
    pub d6: &'static mut pintypes::D6,
    pub d7: &'static mut pintypes::D7,
    pub d8: &'static mut pintypes::D8,
    pub d9: &'static mut pintypes::D9,
    pub d10: &'static mut pintypes::D10,
    pub d11: &'static mut pintypes::D11,
    pub d12: &'static mut pintypes::D12,
    pub d13: &'static mut pintypes::D13,

    pub watchdog: &'static mut atmega4809::watchdog::WatchdogImpl,

    pub eeprom: &'static mut atmega4809::eeprom::eeprom::EepromImpl,
    pub userrow: &'static mut atmega4809::eeprom::userrow::EepromImpl,

    #[cfg(feature="usart3")]
    pub usb_serial: &'static mut atmega4809::serial::usart3::SerialImpl,
    #[cfg(feature="usart3")]
    pub usb_serial_tx: &'static mut atmega4809::port::portb::PinImpl,
    #[cfg(feature="usart3")]
    pub usb_serial_rx: &'static mut atmega4809::port::portb::PinImpl,
  }


  impl From<&'static mut avr_oxide::hal::atmega4809::hardware::Hardware> for Arduino {
    fn from(avr: &'static mut Hardware) -> Self {
      Arduino {
        #[cfg(feature="tcb0")]
        timer0: avr.timerb0,
        #[cfg(feature="tcb1")]
        timer1: avr.timerb1,
        #[cfg(feature="tcb2")]
        timer2: avr.timerb2,
        #[cfg(feature="tcb3")]
        timer3: avr.timerb3,
        #[cfg(feature="rtc")]
        rtc: avr.rtc,

        a0: atmega4809::port::portd::pin_instance(3),
        a1: atmega4809::port::portd::pin_instance(2),
        a2: atmega4809::port::portd::pin_instance(1),
        a3: atmega4809::port::portd::pin_instance(0),
        a4: atmega4809::port::porta::pin_instance(2),
        a5: atmega4809::port::porta::pin_instance(3),
        a6: atmega4809::port::portd::pin_instance(4),
        a7: atmega4809::port::portd::pin_instance(5),
        d0: atmega4809::port::portc::pin_instance(4),
        d1: atmega4809::port::portc::pin_instance(5),
        d2: atmega4809::port::porta::pin_instance(0),
        d3: atmega4809::port::portf::pin_instance(5),
        d4: atmega4809::port::portc::pin_instance(6),
        d5: atmega4809::port::portb::pin_instance(2),
        d6: atmega4809::port::portf::pin_instance(4),
        d7: atmega4809::port::porta::pin_instance(1),
        d8: atmega4809::port::porte::pin_instance(3),
        d9: atmega4809::port::portb::pin_instance(0),
        d10: atmega4809::port::portb::pin_instance(1),
        d11: atmega4809::port::porte::pin_instance(0),
        d12: atmega4809::port::porte::pin_instance(1),
        d13: atmega4809::port::porte::pin_instance(2),

        watchdog: avr.watchdog,

        eeprom: avr.eeprom,
        userrow: avr.userrow,

        #[cfg(feature="usart3")]
        usb_serial: avr.usart3.mux(atmega4809::serial::usart3::SerialPortPins::PortB54),
        #[cfg(feature="usart3")]
        usb_serial_tx: atmega4809::port::portb::pin_instance(4),
        #[cfg(feature="usart3")]
        usb_serial_rx: atmega4809::port::portb::pin_instance(5),
      }
    }
  }

  impl From<PinIdentity> for ArduinoPinIdentity {
    fn from(id: PinIdentity) -> Self {
      match id {
        PinIdentity::PortA(0) => ArduinoPinIdentity::PinD(2),
        PinIdentity::PortA(1) => ArduinoPinIdentity::PinD(7),
        PinIdentity::PortA(2) => ArduinoPinIdentity::PinA(4),
        PinIdentity::PortA(3) => ArduinoPinIdentity::PinA(5),

        PinIdentity::PortB(0) => ArduinoPinIdentity::PinD(9),
        PinIdentity::PortB(1) => ArduinoPinIdentity::PinD(10),
        PinIdentity::PortB(2) => ArduinoPinIdentity::PinD(5),

        PinIdentity::PortC(4) => ArduinoPinIdentity::PinD(0),
        PinIdentity::PortC(5) => ArduinoPinIdentity::PinD(1),
        PinIdentity::PortC(6) => ArduinoPinIdentity::PinD(4),

        PinIdentity::PortD(0) => ArduinoPinIdentity::PinA(3),
        PinIdentity::PortD(1) => ArduinoPinIdentity::PinA(2),
        PinIdentity::PortD(2) => ArduinoPinIdentity::PinA(1),
        PinIdentity::PortD(3) => ArduinoPinIdentity::PinA(0),
        PinIdentity::PortD(4) => ArduinoPinIdentity::PinA(6),
        PinIdentity::PortD(5) => ArduinoPinIdentity::PinA(7),

        PinIdentity::PortE(3) => ArduinoPinIdentity::PinD(8),
        PinIdentity::PortE(0) => ArduinoPinIdentity::PinD(11),
        PinIdentity::PortE(1) => ArduinoPinIdentity::PinD(12),
        PinIdentity::PortE(2) => ArduinoPinIdentity::PinD(13),

        PinIdentity::PortF(5) => ArduinoPinIdentity::PinD(3),
        PinIdentity::PortF(4) => ArduinoPinIdentity::PinD(6),

        _ => panic!()
      }
    }
  }
}
// Tests =====================================================================