esp32-hal 0.2.0

A Hardware abstraction layer for Espressif's ESP32 WiFi microcontroller.
Documentation
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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
//! GPIO and pin configuration
//!
//! ESP32 has very flexible pin assignment via the GPIO mux. It also has a separate RTC mux for
//! low power and analog functions.
//!
//! To support this flexibility two sets of traits are supported:
//! - The various embedded_hal properties
//! - Dedicated [InputPin], [OutputPin], [RTCInputPin] and [RTCOutputPin]
//!
//! The advantage of using the dedicated traits in peripherals is that the configuration of the
//! IO can be done inside the peripheral instead of having to be done upfront.

use {
    crate::target::{GPIO, IO_MUX, RTCIO},
    crate::{get_core, Core},
    core::{convert::Infallible, marker::PhantomData},
    embedded_hal::digital::v2::{OutputPin as _, StatefulOutputPin as _},
};

mod mux;
pub use crate::prelude::*;
pub use mux::*;

/// Extension trait to split a GPIO peripheral into independent pins and registers
pub trait GpioExt {
    /// The type to split the GPIO into
    type Parts;

    /// Splits the GPIO block into independent pins and registers
    fn split(self) -> Self::Parts;
}

/// Functions available on all pins
pub trait Pin {
    /// Enable/Disable the sleep mode of the pad
    fn sleep_mode(&mut self, on: bool) -> &mut Self;

    /// Set the alternate function
    fn set_alternate_function(&mut self, alternate: AlternateFunction) -> &mut Self;

    /// Start listening to pin interrupt event
    ///
    /// The event sets the type of edge or level triggering.
    ///
    /// This is a wrapper around [listen_with_options][
    /// Pin::listen_with_options], which enables the interrupt for the current core and disables
    /// all other options.
    ///
    /// *Note: ESP32 has a bug (3.14), which prevents correct triggering of interrupts when
    /// multiple GPIOs are configured for edge triggering in a group (GPIO0-31 is one group,
    /// GPIO32-39 is the other group). This can be worked around by using level triggering on the
    /// GPIO with edge triggering on the CPU.*
    fn listen(&mut self, event: Event) {
        match crate::get_core() {
            crate::Core::PRO => self.listen_with_options(event, true, false, false, false, false),
            crate::Core::APP => self.listen_with_options(event, false, true, false, false, false),
        }
    }

    /// Start listening to pin interrupt event
    ///
    /// The event sets the type of edge or level triggering.
    /// Interrupts can be individually enabled for the app and pro cores and either a regular
    /// interrupt can be fired or a non-maskable interrupt (NMI). Also wake-up from light sleep
    /// can be enabled
    ///
    /// This function overwrites any previous settings, so if any of the boolean are set to false
    /// the interrupt of that type and to that core are disabled.
    ///
    /// *Note: Edge triggering is not supported for wake-up
    ///
    /// *Note: Even though the interrupt is called NMI it can be routed to any level via the
    /// [interrupt::enable_with_priority][crate::interrupt::enable_with_priority] function.*
    ///
    /// *Note: ESP32 has a bug (3.14), which prevents correct triggering of interrupts when
    /// multiple GPIOs are configured for edge triggering in a group (GPIO0-31 is one group,
    /// GPIO32-39 is the other group). This can be worked around by using level triggering on the
    /// GPIO with edge triggering on the CPU.*
    fn listen_with_options(
        &mut self,
        event: Event,
        pro_int: bool,
        app_int: bool,
        pro_nmi: bool,
        app_nmi: bool,
        wake_up_from_light_sleep: bool,
    );

    /// Stop listening to all pin interrupts
    fn unlisten(&mut self);

    /// Clear a pending interrupt
    fn clear_interrupt(&mut self);

    /// Check if interrupt for this pin is set for the current core
    fn is_interrupt_set(&mut self) -> bool;

    /// Check if the non maskable interrupt for this pin is set for the current core
    fn is_non_maskable_interrupt_set(&mut self) -> bool;

    /// Enable/Disable holding of the pads current state even through reset or deep sleep
    fn enable_hold(&mut self, on: bool);
}

/// Functions available on input pins
pub trait InputPin: Pin {
    /// Set pad as input
    ///
    /// Disables output, pull up/down resistors and sleep mode.
    /// Sets function to GPIO. Does not change sleep mode settings
    fn set_to_input(&mut self) -> &mut Self;

    /// Enable/Disable input circuitry
    fn enable_input(&mut self, on: bool) -> &mut Self;

    /// Enable/Disable input circuitry while in sleep mode
    fn enable_input_in_sleep_mode(&mut self, on: bool) -> &mut Self;

    /// Get state of input
    fn is_input_high(&mut self) -> bool;

    /// Connect input to peripheral using default options
    ///
    /// This is a wrapper around [connect_input_to_peripheral_with_options][
    /// InputPin::connect_input_to_peripheral_with_options], which sets
    /// all the options to false.
    fn connect_input_to_peripheral(&mut self, signal: InputSignal) -> &mut Self {
        self.connect_input_to_peripheral_with_options(signal, false, false)
    }

    /// Connect input to peripheral
    ///
    /// `invert` inverts the output signal and `force_via_gpio_mux` forces the signal
    /// to be routed through the gpio mux even when it could be routed directly via
    /// the io mux.
    fn connect_input_to_peripheral_with_options(
        &mut self,
        signal: InputSignal,
        invert: bool,
        force_via_gpio_mux: bool,
    ) -> &mut Self;
}

/// Functions available on pins with pull up/down resistors
//
// This is split into a separate trait from OutputPin, because for pins which also connect to
// the RTCIO mux, the pull up/down needs to be set via the RTCIO mux.
pub trait Pull {
    /// Enable/Disable internal pull up resistor
    fn internal_pull_up(&mut self, on: bool) -> &mut Self;

    /// Enable/Disable internal pull down resistor
    fn internal_pull_down(&mut self, on: bool) -> &mut Self;
}

/// Functions available on output pins
pub trait OutputPin: Pin + Pull {
    /// Set pad to open drain output
    ///
    /// Disables input, pull up/down resistors and sleep mode.
    /// Sets function to GPIO and drive strength to default (20mA).
    /// Does not change sleep mode settings.
    fn set_to_open_drain_output(&mut self) -> &mut Self;

    /// Set pad to push/pull output
    ///
    /// Disables input, pull up/down resistors and sleep mode.
    /// Sets function to GPIO and drive strength to default (20mA).
    /// Does not change sleep mode settings.
    fn set_to_push_pull_output(&mut self) -> &mut Self;

    /// Enable/disable the output
    fn enable_output(&mut self, on: bool) -> &mut Self;

    /// Set the output to high or low
    fn set_output_high(&mut self, on: bool) -> &mut Self;

    /// Set drive strength
    fn set_drive_strength(&mut self, strength: DriveStrength) -> &mut Self;

    /// Enable/Disable open drain
    fn enable_open_drain(&mut self, on: bool) -> &mut Self;

    /// Enable/disable the output while in sleep mode
    fn enable_output_in_sleep_mode(&mut self, on: bool) -> &mut Self;

    /// Set drive strength while in sleep mode
    fn set_drive_strength_in_sleep_mode(&mut self, strength: DriveStrength) -> &mut Self;

    /// Enable/Disable internal pull up resistor while in sleep mode
    fn internal_pull_up_in_sleep_mode(&mut self, on: bool) -> &mut Self;

    /// Enable/Disable internal pull down resistor while in sleep mode
    fn internal_pull_down_in_sleep_mode(&mut self, on: bool) -> &mut Self;

    /// Connect peripheral to output using default options
    ///
    /// This is a wrapper around [connect_peripheral_to_output_with_options][
    /// OutputPin::connect_peripheral_to_output_with_options], which sets
    /// all the options to false.
    fn connect_peripheral_to_output(&mut self, signal: OutputSignal) -> &mut Self {
        self.connect_peripheral_to_output_with_options(signal, false, false, false, false)
    }

    /// Connect peripheral to output
    ///
    /// `invert` inverts the output signal, `invert_enable` inverts the output
    /// enable signal, `enable_from_gpio` uses the output enable signal from the gpio
    /// control register instead of controlling it by the peripheral and
    /// `force_via_gpio_mux` forces the signal to be routed through the gpio mux even
    /// when it could be routed directly via the io mux.
    fn connect_peripheral_to_output_with_options(
        &mut self,
        signal: OutputSignal,
        invert: bool,
        invert_enable: bool,
        enable_from_gpio: bool,
        force_via_gpio_mux: bool,
    ) -> &mut Self;
}

/// Functions available on RTC input pins
pub trait RTCInputPin {
    /// Enable/Disable the sleep mode of the RTC pad
    fn rtc_sleep_mode(&mut self, on: bool) -> &mut Self;

    /// Enable/Disable RTC input circuitry
    fn rtc_enable_input(&mut self, on: bool) -> &mut Self;

    /// Enable/Disable RTC input circuitry while in sleep mode
    fn rtc_enable_input_in_sleep_mode(&mut self, on: bool) -> &mut Self;

    /// Get state of RTC input
    fn rtc_is_input_high(&mut self) -> bool;
}

/// Functions available on RTC output pins
pub trait RTCOutputPin {
    /// Enable/disable the RTC output
    fn rtc_enable_output(&mut self, on: bool) -> &mut Self;

    /// Set the RTC output to high or low
    fn rtc_set_output_high(&mut self, on: bool) -> &mut Self;

    /// Set RTC drive strength
    fn rtc_set_drive_strength(&mut self, strength: DriveStrength) -> &mut Self;

    /// Enable/Disable RTC open drain
    fn rtc_enable_open_drain(&mut self, on: bool) -> &mut Self;

    /// Enable/disable the RTC output while in sleep mode
    fn rtc_enable_output_in_sleep_mode(&mut self, on: bool) -> &mut Self;
}

/// Interrupt events
///
/// *Note: ESP32 has a bug (3.14), which prevents correct triggering of interrupts when
/// multiple GPIO's are configured for edge triggering in a group (GPIO0-31 is one group,
/// GPIO32-39 is the other group). This can be worked around by using level triggering on the
/// GPIO with edge triggering on the CPU.*
//
// Value must correspond to values in the register
#[derive(Copy, Clone)]
pub enum Event {
    /// Trigger on the rising edge
    RisingEdge = 1,
    /// Trigger on the falling edge
    FallingEdge = 2,
    /// Trigger on any edge
    AnyEdge = 3,
    /// Trigger while low level
    LowLevel = 4,
    /// Trigger while high level
    HighLevel = 5,
}

/// Unknown mode (type state)
pub struct Unknown {}

/// Input mode (type state)
pub struct Input<MODE> {
    _mode: PhantomData<MODE>,
}

/// Input mode via RTC (type state)
pub struct RTCInput<MODE> {
    _mode: PhantomData<MODE>,
}

/// Floating input (type state)
pub struct Floating;

/// Pulled down input (type state)
pub struct PullDown;

/// Pulled up input (type state)
pub struct PullUp;

/// Output mode (type state)
pub struct Output<MODE> {
    _mode: PhantomData<MODE>,
}

/// Output mode via RTC (type state)
pub struct RTCOutput<MODE> {
    _mode: PhantomData<MODE>,
}

/// Open drain input or output (type state)
pub struct OpenDrain;

/// Push pull output (type state)
pub struct PushPull;

/// Analog mode (type state)
pub struct Analog;

/// Alternate function (type state)
pub struct Alternate<MODE> {
    _mode: PhantomData<MODE>,
}

/// Alternate Function 1
pub struct AF1;

/// Alternate Function 2
pub struct AF2;

/// Alternate Function 4
pub struct AF4;

/// Alternate Function 5
pub struct AF5;

/// Alternate Function 6
pub struct AF6;

/// Drive strength (values are approximates)
pub enum DriveStrength {
    I5mA = 0,
    I10mA = 1,
    I20mA = 2,
    I40mA = 3,
}

/// Alternative pin functions
#[derive(PartialEq)]
pub enum AlternateFunction {
    Function1 = 0,
    Function2 = 1,
    Function3 = 2,
    Function4 = 3,
    Function5 = 4,
    Function6 = 5,
}

/// Connect fixed low to peripheral
pub fn connect_low_to_peripheral(signal: InputSignal) {
    unsafe { &*GPIO::ptr() }.func_in_sel_cfg[signal as usize].modify(|_, w| unsafe {
        w.sel()
            .set_bit()
            .in_inv_sel()
            .bit(false)
            .in_sel()
            .bits(0x30)
    });
}

/// Connect fixed high to peripheral
pub fn connect_high_to_peripheral(signal: InputSignal) {
    unsafe { &*GPIO::ptr() }.func_in_sel_cfg[signal as usize].modify(|_, w| unsafe {
        w.sel()
            .set_bit()
            .in_inv_sel()
            .bit(false)
            .in_sel()
            .bits(0x38)
    });
}

macro_rules! impl_output {
    ($pxi:ident:
        (
            $pin_num:expr, $bit:expr, $iomux:ident, $out_en_set:ident, $out_en_clear:ident,
            $outs:ident, $outc:ident
        ) $( ,( $( $af_signal:ident: $af:ident ),* ))?
    ) => {
        impl<MODE> embedded_hal::digital::v2::OutputPin for $pxi<Output<MODE>> {
            type Error = Infallible;

            fn set_high(&mut self) -> Result<(), Self::Error> {
                // NOTE(unsafe) atomic write to a stateless register
                unsafe { (*GPIO::ptr()).$outs.write(|w| w.bits(1 << $bit)) };
                Ok(())
            }

            fn set_low(&mut self) -> Result<(), Self::Error> {
                // NOTE(unsafe) atomic write to a stateless register
                unsafe { (*GPIO::ptr()).$outc.write(|w| w.bits(1 << $bit)) };
                Ok(())
            }
        }

        impl<MODE> embedded_hal::digital::v2::StatefulOutputPin for $pxi<Output<MODE>> {
            fn is_set_high(&self) -> Result<bool, Self::Error> {
                // NOTE(unsafe) atomic read to a stateless register
                unsafe { Ok((*GPIO::ptr()).$outs.read().bits() & (1 << $bit) != 0) }
            }

            fn is_set_low(&self) -> Result<bool, Self::Error> {
                Ok(!self.is_set_high()?)
            }
        }

        impl<MODE> embedded_hal::digital::v2::ToggleableOutputPin for $pxi<Output<MODE>> {
            type Error = Infallible;

            fn toggle(&mut self) -> Result<(), Self::Error> {
                if self.is_set_high()? {
                    Ok(self.set_low()?)
                } else {
                    Ok(self.set_high()?)
                }
            }
        }

        impl<MODE> $pxi<MODE> {
            pub fn into_pull_up_input(self) -> $pxi<Input<PullUp>> {
                self.init_input(false, false);
                $pxi { _mode: PhantomData }
            }

            pub fn into_pull_down_input(self) -> $pxi<Input<PullDown>> {
                self.init_input(true, false);
                $pxi { _mode: PhantomData }
            }

            fn init_output(&self, alternate: AlternateFunction, open_drain: bool) {
                let gpio = unsafe { &*GPIO::ptr() };
                let iomux = unsafe { &*IO_MUX::ptr() };

                self.disable_analog();

                // NOTE(unsafe) atomic read to a stateless register
                gpio.$out_en_set.write(|w| unsafe { w.bits(1 << $bit) });
                gpio.pin[$pin_num].modify(|_, w| w.pad_driver().bit(open_drain));
                gpio.func_out_sel_cfg[$pin_num]
                    .modify(|_, w| unsafe { w.out_sel().bits(OutputSignal::GPIO as u16) });

                iomux.$iomux.modify(|_, w| unsafe {
                    w.mcu_sel()
                        .bits(alternate as u8)
                        .fun_ie()
                        .clear_bit()
                        .fun_wpd()
                        .clear_bit()
                        .fun_wpu()
                        .clear_bit()
                        .fun_drv()
                        .bits(DriveStrength::I20mA as u8)
                        .slp_sel()
                        .clear_bit()
                });
            }

            pub fn into_push_pull_output(self) -> $pxi<Output<PushPull>> {
                self.init_output(AlternateFunction::Function3, false);
                $pxi { _mode: PhantomData }
            }

            pub fn into_open_drain_output(self) -> $pxi<Output<OpenDrain>> {
                self.init_output(AlternateFunction::Function3, true);
                $pxi { _mode: PhantomData }
            }

            pub fn into_alternate_1(self) -> $pxi<Alternate<AF1>> {
                self.init_output(AlternateFunction::Function1, false);
                $pxi { _mode: PhantomData }
            }

            pub fn into_alternate_2(self) -> $pxi<Alternate<AF2>> {
                self.init_output(AlternateFunction::Function2, false);
                $pxi { _mode: PhantomData }
            }

            pub fn into_alternate_4(self) -> $pxi<Alternate<AF4>> {
                self.init_output(AlternateFunction::Function4, false);
                $pxi { _mode: PhantomData }
            }

            pub fn into_alternate_5(self) -> $pxi<Alternate<AF5>> {
                self.init_output(AlternateFunction::Function5, false);
                $pxi { _mode: PhantomData }
            }

            pub fn into_alternate_6(self) -> $pxi<Alternate<AF6>> {
                self.init_output(AlternateFunction::Function6, false);
                $pxi { _mode: PhantomData }
            }
        }

        impl<MODE> OutputPin for $pxi<MODE> {

            fn set_to_open_drain_output(&mut self) -> &mut Self {
                self.init_output(AlternateFunction::Function3, true);
                self
            }

            fn set_to_push_pull_output(&mut self) -> &mut Self {
                self.init_output(AlternateFunction::Function3, false);
                self
            }

            fn enable_output(&mut self, on: bool) -> &mut Self {
                // NOTE(unsafe) atomic read to a stateless register
                if on {
                    unsafe { &*GPIO::ptr() }
                        .$out_en_set
                        .write(|w| unsafe { w.bits(1 << $bit) });
                } else {
                    unsafe { &*GPIO::ptr() }
                        .$out_en_clear
                        .write(|w| unsafe { w.bits(1 << $bit) });
                }
                self
            }

            fn set_output_high(&mut self, high: bool) -> &mut Self {
                // NOTE(unsafe) atomic read to a stateless register
                if high {
                    unsafe { (*GPIO::ptr()).$outs.write(|w| w.bits(1 << $bit)) };
                } else {
                    unsafe { (*GPIO::ptr()).$outc.write(|w| w.bits(1 << $bit)) };
                }
                self
            }

            fn set_drive_strength(&mut self, strength: DriveStrength) -> &mut Self {
                unsafe { &*IO_MUX::ptr() }
                    .$iomux
                    .modify(|_, w| unsafe { w.fun_drv().bits(strength as u8) });
                self
            }

            fn enable_open_drain(&mut self, on: bool) -> &mut Self {
                unsafe { &*GPIO::ptr() }.pin[$pin_num].modify(|_, w| w.pad_driver().bit(on));
                self
            }

            fn set_drive_strength_in_sleep_mode(&mut self, strength: DriveStrength) -> &mut Self {
                unsafe { &*IO_MUX::ptr() }
                    .$iomux
                    .modify(|_, w| unsafe { w.mcu_drv().bits(strength as u8) });
                self
            }

            fn internal_pull_up_in_sleep_mode(&mut self, on: bool) -> &mut Self {
                unsafe { &*IO_MUX::ptr() }
                    .$iomux
                    .modify(|_, w| w.mcu_wpu().bit(on));
                self
            }

            fn internal_pull_down_in_sleep_mode(&mut self, on: bool) -> &mut Self {
                unsafe { &*IO_MUX::ptr() }
                    .$iomux
                    .modify(|_, w| w.mcu_wpd().bit(on));
                self
            }

            fn enable_output_in_sleep_mode(&mut self, on: bool) -> &mut Self {
                unsafe { &*IO_MUX::ptr() }
                    .$iomux
                    .modify(|_, w| w.mcu_oe().bit(on));
                self
            }

            fn connect_peripheral_to_output_with_options(
                &mut self,
                signal: OutputSignal,
                invert: bool,
                invert_enable: bool,
                enable_from_gpio: bool,
                force_via_gpio_mux: bool,
            ) -> &mut Self {

                let af = if force_via_gpio_mux {
                    AlternateFunction::Function3
                } else {
                    match signal {
                        $( $(
                            OutputSignal::$af_signal => AlternateFunction::$af,
                        )* )?
                        _ => AlternateFunction::Function3
                    }
                };

                if af == AlternateFunction::Function3 && signal as usize > 256 {
                    panic!("Cannot connect this peripheral to GPIO");
                }

                self.set_alternate_function(af);

                let clipped_signal = if signal as usize <= 256 { signal as u16 } else { 256 };

                unsafe { &*GPIO::ptr() }.func_out_sel_cfg[$pin_num].modify(|_, w| unsafe {
                    w
                        .out_sel().bits(clipped_signal)
                        .out_inv_sel().bit(invert)
                        .oen_sel().bit(enable_from_gpio)
                        .oen_inv_sel().bit(invert_enable)
                });

                self
            }
        }
    };
}

macro_rules! impl_input {
    ($pxi:ident:
        ($pin_num:expr, $bit:expr, $iomux:ident, $out_en_clear:ident, $reg:ident, $reader:ident,
            $status_w1tc:ident, $acpu_int:ident, $acpu_nmi:ident, $pcpu_int:ident, $pcpu_nmi:ident
        ) $( ,( $( $af_signal:ident : $af:ident ),* ))?
    ) => {
        impl<MODE> embedded_hal::digital::v2::InputPin for $pxi<Input<MODE>> {
            type Error = Infallible;

            fn is_high(&self) -> Result<bool, Self::Error> {
                Ok(unsafe { &*GPIO::ptr() }.$reg.read().$reader().bits() & (1 << $bit) != 0)
            }

            fn is_low(&self) -> Result<bool, Self::Error> {
                Ok(!self.is_high()?)
            }
        }

        impl<MODE> $pxi<MODE> {
            fn init_input(&self, pull_down: bool, pull_up: bool) {
                let gpio = unsafe { &*GPIO::ptr() };
                let iomux = unsafe { &*IO_MUX::ptr() };
                self.disable_analog();

                // NOTE(unsafe) atomic read to a stateless register
                gpio.$out_en_clear
                    .modify(|_, w| unsafe { w.bits(1 << $bit) });

                gpio.func_out_sel_cfg[$pin_num]
                    .modify(|_, w| unsafe { w.out_sel().bits(OutputSignal::GPIO as u16) });

                iomux.$iomux.modify(|_, w| unsafe {
                    w.mcu_sel()
                        .bits(2)
                        .fun_ie()
                        .set_bit()
                        .fun_wpd()
                        .bit(pull_down)
                        .fun_wpu()
                        .bit(pull_up)
                        .slp_sel()
                        .clear_bit()
                });
            }

            pub fn into_floating_input(self) -> $pxi<Input<Floating>> {
                self.init_input(false, false);
                $pxi { _mode: PhantomData }
            }
        }

        impl<MODE> InputPin for $pxi<MODE> {
            fn set_to_input(&mut self) -> &mut Self {
                self.init_input(false, false);
                self
            }

            fn enable_input(&mut self, on: bool) -> &mut Self {
                unsafe { &*IO_MUX::ptr() }
                    .$iomux
                    .modify(|_, w| w.fun_ie().bit(on));
                self
            }

            fn enable_input_in_sleep_mode(&mut self, on: bool) -> &mut Self {
                unsafe { &*IO_MUX::ptr() }
                    .$iomux
                    .modify(|_, w| w.mcu_ie().bit(on));
                self
            }

            fn is_input_high(&mut self) -> bool {
                unsafe { &*GPIO::ptr() }.$reg.read().$reader().bits() & (1 << $bit) != 0
            }

            fn connect_input_to_peripheral_with_options(
                &mut self,
                signal: InputSignal,
                invert: bool,
                force_via_gpio_mux: bool,
            ) -> &mut Self {

                let af = if force_via_gpio_mux
                {
                    AlternateFunction::Function3
                }
                else {
                    match signal {
                        $( $(
                            InputSignal::$af_signal => AlternateFunction::$af,
                        )* )?
                        _ => AlternateFunction::Function3
                    }
                };

                if af == AlternateFunction::Function3 && signal as usize > 256 {
                    panic!("Cannot connect GPIO to this peripheral");
                }

                self.set_alternate_function(af);

                if (signal as usize) < 256 {
                    unsafe { &*GPIO::ptr() }.func_in_sel_cfg[signal as usize].modify(|_, w| unsafe {
                        w.sel()
                            .set_bit()
                            .in_inv_sel()
                            .bit(invert)
                            .in_sel()
                            .bits($pin_num)
                    });
                }
                self
            }
        }

        impl<MODE> Pin for $pxi<MODE> {
            fn sleep_mode(&mut self, on: bool) -> &mut Self {
                unsafe { &*IO_MUX::ptr() }
                    .$iomux
                    .modify(|_, w| w.slp_sel().bit(on));
                self
            }

            fn set_alternate_function(&mut self, alternate: AlternateFunction) -> &mut Self {
                unsafe { &*IO_MUX::ptr() }
                    .$iomux
                    .modify(|_, w| unsafe { w.mcu_sel().bits(alternate as u8) });
                self
            }

            fn listen_with_options(&mut self, event: Event,
                pro_int: bool, app_int: bool, pro_nmi: bool, app_nmi: bool,
                wake_up_from_light_sleep: bool
            ) {
                if wake_up_from_light_sleep {
                    match event {
                        Event::AnyEdge | Event::RisingEdge | Event::FallingEdge => {
                            panic!("Edge triggering is not supported for wake-up from light sleep");
                        },
                        _ => {}
                    }
                }
                unsafe {
                    (&*GPIO::ptr()).pin[$pin_num].modify(|_, w|
                        w
                            .int_ena().bits(app_int as u8 | ((app_nmi as u8) << 1)
                                | ((pro_int as u8) << 2) | ((pro_nmi as u8) << 3))
                            .int_type().bits(event as u8)
                            .wakeup_enable().bit(wake_up_from_light_sleep)
                    );
                }
                self.rtc_enable_wake_up_from_light_sleep(event, wake_up_from_light_sleep);
            }

            fn unlisten(&mut self) {
                unsafe { (&*GPIO::ptr()).pin[$pin_num].modify(|_, w|
                    w.int_ena().bits(0).int_type().bits(0).int_ena().bits(0) );
                }
                self.rtc_enable_wake_up_from_light_sleep(Event::HighLevel, false);
            }

            fn clear_interrupt(&mut self) {
                unsafe {&*GPIO::ptr()}.$status_w1tc.write(|w|
                    unsafe {w.bits(1 << $bit)})
            }

            fn is_interrupt_set(&mut self) -> bool {
                match get_core() {
                    Core::PRO =>
                        (unsafe {&*GPIO::ptr()}.$pcpu_int.read().bits() & (1 << $bit)) !=0,
                    Core::APP =>
                        (unsafe {&*GPIO::ptr()}.$acpu_int.read().bits() & (1 << $bit)) !=0,
                }
            }

            fn is_non_maskable_interrupt_set(&mut self) -> bool {
                match get_core() {
                    Core::PRO =>
                        (unsafe {&*GPIO::ptr()}.$pcpu_nmi.read().bits() & (1 << $bit)) !=0,
                    Core::APP =>
                        (unsafe {&*GPIO::ptr()}.$acpu_nmi.read().bits() & (1 << $bit)) !=0,
                }
            }

            fn enable_hold(&mut self, on: bool) {
                self.enable_hold_internal(on)
            }
        }
    };
}

macro_rules! impl_pin_wrap {
    ($pxi:ident, $pin_num:expr, Bank0, $iomux:ident, $TYPE:ident
        $( ,( $( $af_input_signal:ident : $af_input:ident ),* ) )?
    ) => {
        impl_input!($pxi: ($pin_num, $pin_num % 32, $iomux, enable_w1tc, in_, in_data,
            status_w1tc, acpu_int, acpu_nmi_int, pcpu_int, pcpu_nmi_int)
            $( ,( $( $af_input_signal: $af_input ),* ) )? );
    };
    ($pxi:ident, $pin_num:expr, Bank1, $iomux:ident, $TYPE:ident
        $( ,( $( $af_input_signal:ident: $af_input:ident ),* ))?
    ) => {
        impl_input!($pxi: ($pin_num, $pin_num % 32, $iomux, enable1_w1tc, in1, in1_data,
            status1_w1tc, acpu_int1, acpu_nmi_int1, pcpu_int1, pcpu_nmi_int1)
            $( ,( $( $af_input_signal: $af_input ),* ) )? );
    };
}

macro_rules! impl_output_wrap {
    ($pxi:ident, $pin_num:expr, Bank0, $iomux:ident, IO
        $( ,( $( $af_output_signal:ident : $af_output:ident ),* ))?
    ) => {
        impl_output!($pxi:
            ($pin_num, $pin_num % 32, $iomux,  enable_w1ts, enable_w1tc, out_w1ts, out_w1tc)

            $( ,( $( $af_output_signal: $af_output ),* ) )? );
    };
    ($pxi:ident, $pin_num:expr, Bank1, $iomux:ident, IO
        $( ,( $( $af_output_signal:ident: $af_output:ident ),* ))?
    ) => {
        impl_output!($pxi:
            ($pin_num, $pin_num % 32, $iomux, enable1_w1ts, enable1_w1tc, out1_w1ts, out1_w1tc)
            $( ,( $( $af_output_signal: $af_output ),* ) )? );
    };
    ($pxi:ident, $pin_num:expr, $bank:ident, $iomux:ident, Input) => {
        // Output not implemented for this pin
    };
}

static RTCIO_LOCK: CriticalSectionSpinLockMutex<()> = CriticalSectionSpinLockMutex::new(());

macro_rules! impl_no_rtc {
    ($pxi:ident, $pin_num:expr, $bank:ident, $iomux:ident, IO, RTC) => {
        // Pull up/down controlled via RTC mux (to address errata 3.6)
    };
    ($pxi:ident, $pin_num:expr, $bank:ident, $iomux:ident, Input, RTC) => {
        // Output not implemented for this pin, so pull up/down not available
    };
    ($pxi:ident, $pin_num:expr, $bank:ident, $iomux:ident, IO, $hold_bit:expr) => {
        impl<MODE> Pull for $pxi<MODE> {
            fn internal_pull_up(&mut self, on: bool) -> &mut Self {
                unsafe { &*IO_MUX::ptr() }
                    .$iomux
                    .modify(|_, w| w.fun_wpu().bit(on));
                self
            }

            fn internal_pull_down(&mut self, on: bool) -> &mut Self {
                unsafe { &*IO_MUX::ptr() }
                    .$iomux
                    .modify(|_, w| w.fun_wpd().bit(on));
                self
            }
        }

        impl<MODE> $pxi<MODE> {
            #[inline(always)]

            // No analog functionality on this pin, so nothing to do, function is implemented
            // for convenience so it can be called on any GPIO pin
            fn disable_analog(&self) {}

            // No rtc functionality on this pin, so nothing to do, function is implemented
            // for convenience so it can be called on any GPIO pin
            #[inline(always)]
            fn rtc_enable_wake_up_from_light_sleep(&self, _event: Event, _enable: bool) {}

            #[inline(always)]
            fn enable_hold_internal(&self, on: bool) {
                (&RTCIO_LOCK).lock(|_| unsafe {
                    // shared register without set/clear functionality, so needs lock
                    (&*RTCIO::ptr()).dig_pad_hold.modify(|r, w| {
                        w.bits(r.bits() & !((on as u32) << $hold_bit) | ((on as u32) << $hold_bit))
                    })
                });
            }
        }
    };
}

macro_rules! gpio {
    ( $($pxi:ident: ($pname:ident, $bank:ident, $pin_num:literal, $iomux:ident,
        $type:ident, $rtc:tt ),
        $(
            ( $( $af_input_signal:ident: $af_input:ident ),* ),
            $(
            ( $( $af_output_signal:ident: $af_output:ident ),* ),
            )?
        )?
        )+ ) => {

        impl GpioExt for GPIO {
            type Parts = Parts;

            fn split(self) -> Self::Parts {
                Parts {
                    $(
                        $pname: $pxi { _mode: PhantomData },
                    )+
                }
            }
        }

        /// Collection of all GPIO pins
        pub struct Parts {
            $(
                /// Pin
                pub $pname: $pxi<Unknown>,
            )+
        }

        // create all the pins, we can also add functionality
        // applicable to all pin states here
        $(
            /// Pin
            pub struct $pxi<MODE> {
                _mode: PhantomData<MODE>,
            }

            impl_pin_wrap!($pxi, $pin_num, $bank, $iomux, $type
                $( ,( $( $af_input_signal: $af_input ),* ) )? );
            impl_output_wrap!($pxi, $pin_num, $bank, $iomux, $type
                $($( ,( $( $af_output_signal: $af_output ),* ) )? )? );
            impl_no_rtc!($pxi, $pin_num, $bank, $iomux, $type, $rtc);
        )+
    };
}

// All info on reset state pulled from 4.10 IO_MUX Pad List in the reference manual
// TODO these pins have a reset mode of 0 (apart from Gpio27),
// input disable, does that mean they are actually in output mode on reset?
gpio! {
    Gpio0:  (gpio0,  Bank0, 0,  gpio0, IO, RTC),
        (EMAC_TX_CLK: Function6),
        (CLK_OUT1: Function2),
    Gpio1:  (gpio1,  Bank0, 1,  u0txd, IO, 0),
        (EMAC_RXD2: Function6),
        (U0TXD: Function1, CLK_OUT3: Function2),
    Gpio2:  (gpio2,  Bank0, 2,  gpio2, IO, RTC),
        (HSPIWP: Function2, HS2_DATA0: Function4, SD_DATA0: Function5),
        (HS2_DATA0: Function4, SD_DATA0: Function5),
    Gpio3:  (gpio3,  Bank0, 3,  u0rxd, IO, 1),
        (U0RXD: Function1),
        (CLK_OUT2: Function2),
    Gpio4:  (gpio4,  Bank0, 4,  gpio4, IO, RTC),
        (HSPIHD: Function2, HS2_DATA1: Function4, SD_DATA1: Function5, EMAC_TX_ER: Function6),
        (HS2_DATA1: Function4, SD_DATA1: Function5),
    Gpio5:  (gpio5,  Bank0, 5,  gpio5, IO, 8),
        (VSPICS0: Function2, HS1_DATA6: Function4, EMAC_RX_CLK: Function6),
        (HS1_DATA6: Function4),
    Gpio6:  (gpio6,  Bank0, 6,  sd_clk, IO, 2),
        (U1CTS: Function5),
        (SD_CLK: Function1, SPICLK: Function2, HS1_CLK: Function4),
    Gpio7:  (gpio7,  Bank0, 7,  sd_data0, IO, 3),
        (SD_DATA0: Function1, SPIQ: Function2, HS1_DATA0: Function4),
        (SD_DATA0: Function1, SPIQ: Function2, HS1_DATA0: Function4, U2RTS: Function5),
    Gpio8:  (gpio8,  Bank0, 8,  sd_data1, IO, 4),
        (SD_DATA1: Function1, SPID: Function2, HS1_DATA1: Function4, U2CTS: Function5),
        (SD_DATA1: Function1, SPID: Function2, HS1_DATA1: Function4),
    Gpio9:  (gpio9,  Bank0, 9,  sd_data2, IO, 5),
        (SD_DATA2: Function1, SPIHD: Function2, HS1_DATA2: Function4, U1RXD: Function5),
        (SD_DATA2: Function1, SPIHD: Function2, HS1_DATA2: Function4),
    Gpio10: (gpio10, Bank0, 10, sd_data3, IO, 6),
        (SD_DATA3: Function1, SPIWP: Function2, HS1_DATA3: Function4),
        (SD_DATA3: Function1, SPIWP: Function2, HS1_DATA3: Function4, U1TXD: Function5),
    Gpio11: (gpio11, Bank0, 11, sd_cmd, IO, 7),
        (SPICS0: Function2),
        (SD_CMD: Function1, SPICS0: Function2, HS1_CMD: Function4, U1RTS: Function5),
    Gpio12: (gpio12, Bank0, 12, mtdi, IO, RTC),
        (MTDI: Function1, HSPIQ: Function2, HS2_DATA2: Function4, SD_DATA2: Function5),
        (HSPIQ: Function2, HS2_DATA2: Function4, SD_DATA2: Function5, EMAC_TXD3: Function6),
    Gpio13: (gpio13, Bank0, 13, mtck, IO, RTC),
        (MTCK: Function1, HSPID: Function2, HS2_DATA3: Function4, SD_DATA3: Function5),
        (HSPID: Function2, HS2_DATA3: Function4, SD_DATA3: Function5, EMAC_RX_ER: Function6),
    Gpio14: (gpio14, Bank0, 14, mtms, IO, RTC),
        (MTMS: Function1, HSPICLK: Function2),
        (HSPICLK: Function2, HS2_CLK: Function4, SD_CLK: Function5, EMAC_TXD2: Function6),
    Gpio15: (gpio15, Bank0, 15, mtdo, IO, RTC),
        (HSPICS0: Function2, EMAC_RXD3: Function6),
        (MTDO: Function1, HSPICS0: Function2, HS2_CMD: Function4, SD_CMD: Function5),
    Gpio16: (gpio16, Bank0, 16, gpio16, IO, 9),
        (HS1_DATA4: Function4, U2RXD: Function5),
        (HS1_DATA4: Function4, EMAC_CLK_OUT: Function6),
    Gpio17: (gpio17, Bank0, 17, gpio17, IO, 10),
        (HS1_DATA5: Function4),
        (HS1_DATA5: Function4, U2TXD: Function5, EMAC_CLK_180: Function6),
    Gpio18: (gpio18, Bank0, 18, gpio18, IO, 11),
        (VSPICLK: Function2, HS1_DATA7: Function4),
        (VSPICLK: Function2, HS1_DATA7: Function4),
    Gpio19: (gpio19, Bank0, 19, gpio19, IO, 12),
        (VSPIQ: Function2, U0CTS: Function4),
        (VSPIQ: Function2, EMAC_TXD0: Function6),
    Gpio20: (gpio20, Bank0, 20, gpio20, IO, 13), // pin logic present, but no external pad
    Gpio21: (gpio21, Bank0, 21, gpio21, IO, 14),
        (VSPIHD: Function2),
        (VSPIHD: Function2, EMAC_TX_EN: Function6),
    Gpio22: (gpio22, Bank0, 22, gpio22, IO, 15),
        (VSPIWP: Function2),
        (VSPIWP: Function2, U0RTS: Function4, EMAC_TXD1: Function6),
    Gpio23: (gpio23, Bank0, 23, gpio23, IO, 16),
        (VSPID: Function2),
        (VSPID: Function2, HS1_STROBE: Function4),
    Gpio25: (gpio25, Bank0, 25, gpio25, IO, RTC),
        (EMAC_RXD0: Function6),
        (),
    Gpio26: (gpio26, Bank0, 26, gpio26, IO, RTC),
        (EMAC_RXD1: Function6),
        (),
    Gpio27: (gpio27, Bank0, 27, gpio27, IO, RTC),
        (EMAC_RX_DV: Function6),
        (),

    Gpio32: (gpio32, Bank1, 32, gpio32, IO, RTC),
    Gpio33: (gpio33, Bank1, 33, gpio33, IO, RTC),
    Gpio34: (gpio34, Bank1, 34, gpio34, Input, RTC),
    Gpio35: (gpio35, Bank1, 35, gpio35, Input, RTC),
    Gpio36: (gpio36, Bank1, 36, gpio36, Input, RTC),
    Gpio37: (gpio37, Bank1, 37, gpio37, Input, RTC),
    Gpio38: (gpio38, Bank1, 38, gpio38, Input, RTC),
    Gpio39: (gpio39, Bank1, 39, gpio39, Input, RTC),
}

macro_rules! impl_analog {
    ([
        $($pxi:ident: ($pin_num:expr, $pin_reg:ident, $hold: ident, $mux_sel:ident,
            $fun_sel:ident, $fun_ie:ident, $slp_ie:ident, $slp_sel:ident
            $(, $rue:ident, $rde:ident, $drv:ident, $slp_oe:ident)?),)+
    ]) => {
        $(
            impl<MODE> embedded_hal::digital::v2::InputPin for $pxi<RTCInput<MODE>> {
                type Error = Infallible;

                fn is_high(&self) -> Result<bool, Self::Error> {
                    // NOTE(unsafe) atomic read to a stateless register
                    Ok(unsafe{&*RTCIO::ptr()}.in_.read().in_next().bits() & (1 << $pin_num) != 0)
                }

                fn is_low(&self) -> Result<bool, Self::Error> {
                    Ok(!self.is_high()?)
                }
            }

            impl<MODE> RTCInputPin for $pxi<MODE> {
                fn rtc_sleep_mode(&mut self, on: bool) -> &mut Self {
                    // shared register without set/clear functionality, so needs lock
                    (&RTCIO_LOCK).lock(|_|
                        unsafe{ &*RTCIO::ptr() }.$pin_reg.modify(|_,w| w.$slp_sel().bit(on))
                    );
                    self
                }

                fn rtc_enable_input(&mut self, on: bool) -> &mut Self {
                    // shared register without set/clear functionality, so needs lock
                    (&RTCIO_LOCK).lock(|_|
                        unsafe{ &*RTCIO::ptr() }.$pin_reg.modify(|_,w| w.$fun_ie().bit(on))
                    );
                    self
                }

                fn rtc_enable_input_in_sleep_mode(&mut self, on: bool) -> &mut Self {
                    // shared register without set/clear functionality, so needs lock
                    (&RTCIO_LOCK).lock(|_|
                        unsafe{ &*RTCIO::ptr() }.$pin_reg.modify(|_,w| w.$slp_ie().bit(on))
                    );
                    self
                }

                fn rtc_is_input_high(&mut self) -> bool {
                    unsafe{&*RTCIO::ptr()}.in_.read().in_next().bits() & (1 << $pin_num) != 0
                }
            }

            $(
                impl<MODE> embedded_hal::digital::v2::OutputPin for $pxi<RTCOutput<MODE>> {
                    type Error = Infallible;

                    fn set_high(&mut self) -> Result<(), Self::Error> {
                        self.rtc_set_output_high(true);
                        Ok(())
                    }

                    fn set_low(&mut self) -> Result<(), Self::Error> {
                        self.rtc_set_output_high(false);
                        Ok(())
                    }
                }

                impl<MODE> embedded_hal::digital::v2::StatefulOutputPin for $pxi<RTCOutput<MODE>> {
                    fn is_set_high(&self) -> Result<bool, Self::Error> {
                        // NOTE(unsafe) atomic read to a stateless register
                        Ok(unsafe{&*RTCIO::ptr()}.out.read().out_data().bits() & (1 << $pin_num) != 0)
                    }

                    fn is_set_low(&self) -> Result<bool, Self::Error> {
                        Ok(!self.is_set_high()?)
                    }
                }

                impl<MODE> embedded_hal::digital::v2::ToggleableOutputPin for $pxi<RTCOutput<MODE>> {
                    type Error = Infallible;

                    fn toggle(&mut self) -> Result<(), Self::Error> {
                        if self.is_set_high()? {
                            Ok(self.set_low()?)
                        } else {
                            Ok(self.set_high()?)
                        }
                    }
                }

                impl<MODE> RTCOutputPin for $pxi<MODE> {
                    /// Enable/disable the output
                    fn rtc_enable_output(&mut self, on: bool) -> &mut Self {
                        unsafe {
                            if on {
                                (&*RTCIO::ptr()).enable_w1ts.modify(|_,w|
                                    w.enable_w1ts().bits(1 << $pin_num));
                            } else {
                                (&*RTCIO::ptr()).enable_w1tc.modify(|_,w|
                                    w.enable_w1tc().bits(1 << $pin_num));
                            }
                        }
                        self
                    }

                    /// Set the output to high or low
                    fn rtc_set_output_high(&mut self, on: bool) -> &mut Self {
                        unsafe {
                            if on {
                                (&*RTCIO::ptr()).out_w1ts.modify(|_,w|
                                    w.out_data_w1ts().bits(1 << $pin_num));
                            } else {
                                (&*RTCIO::ptr()).out_w1tc.modify(|_,w|
                                    w.out_data_w1tc().bits(1 << $pin_num));
                            }
                        }
                        self
                    }

                    /// Set drive strength
                    fn rtc_set_drive_strength(&mut self, strength: DriveStrength) -> &mut Self {
                        // shared register without set/clear functionality, so needs lock
                        (&RTCIO_LOCK).lock(|_|
                            unsafe{ &*RTCIO::ptr() }.$pin_reg.modify(|_,w|
                                unsafe {w.$drv().bits(strength as u8)}
                            )
                        );
                        self
                    }

                    /// Enable/Disable open drain
                    fn rtc_enable_open_drain(&mut self, on: bool) -> &mut Self {
                        unsafe{ &*RTCIO::ptr() }.pin[$pin_num].modify(|_,w|
                            w.pad_driver().bit(on));
                        self
                    }

                    /// Enable/disable the output while in sleep mode
                    fn rtc_enable_output_in_sleep_mode(&mut self, on: bool) -> &mut Self {
                        // shared register without set/clear functionality, so needs lock
                        (&RTCIO_LOCK).lock(|_|
                            unsafe{ &*RTCIO::ptr() }.$pin_reg.modify(|_,w| w.$slp_oe().bit(on))
                        );
                        self
                    }
                }
            )?

            impl<MODE> $pxi<MODE> {

                fn init_rtc(&mut self, input: bool, _output: bool, _open_drain: bool, _pull_up: bool, _pull_down:bool) {
                    // shared registers without set/clear functionality, so needs lock
                    self.rtc_enable_input(input);

                    $(
                        self.rtc_enable_output(_output);
                        self.rtc_enable_open_drain(_open_drain);

                        (&RTCIO_LOCK).lock(|_| {
                            let rtcio = unsafe{ &*RTCIO::ptr() };

                            rtcio.$pin_reg.modify(|_,w| {
                                // Connect pin to analog / RTC module instead of standard GPIO
                                w.$mux_sel().set_bit();

                                // Select function "RTC function 1" (GPIO) for analog use
                                unsafe { w.$fun_sel().bits(0b00) }
                            });

                                // Disable pull-up and pull-down resistors on the pin, if it has them
                            rtcio.$pin_reg.modify(|_,w| {
                                w
                                .$rue().bit(_pull_up)
                                .$rde().bit(_pull_down)
                            });
                        });
                    )?
                }

                pub fn into_analog(mut self) -> $pxi<Analog> {
                    self.init_rtc(false, false, false, false, false);
                    $pxi { _mode: PhantomData }
                }

                pub fn into_floating_rtc_input(mut self) -> $pxi<RTCInput<Floating>> {
                    self.init_rtc(true, false, false, false, false);
                    $pxi { _mode: PhantomData }
                }

                pub fn into_pull_up_rtc_input(mut self) -> $pxi<RTCInput<PullUp>> {
                    self.init_rtc(true, false, false, false, false);
                    $pxi { _mode: PhantomData }
                }

                pub fn into_pull_down_rtc_input(mut self) -> $pxi<RTCInput<PullDown>> {
                    self.init_rtc(true, false, false, false, false);
                    $pxi { _mode: PhantomData }
                }

                $(
                    pub fn into_push_pull_rtc_output(mut self) -> $pxi<RTCOutput<PushPull>> {
                        #[allow(unused_variables)]
                        let $rde:();

                        self.init_rtc(false, true, false, false, false);
                        $pxi { _mode: PhantomData }
                    }

                    pub fn into_open_drain_rtc_output(mut self) -> $pxi<RTCOutput<OpenDrain>> {
                        self.init_rtc(false, true, true, false, false);
                        $pxi { _mode: PhantomData }
                    }
                )?

                #[inline(always)]
                fn disable_analog(&self) {
                    // shared register without set/clear functionality, so needs lock
                    (&RTCIO_LOCK).lock(|_| {
                        let rtcio = unsafe{ &*RTCIO::ptr() };

                        rtcio.$pin_reg.modify(|_,w| w.$mux_sel().clear_bit());

                        // Disable pull-up and -down resistors by default
                        $(
                            rtcio.$pin_reg.modify(|_,w|
                                w.$rue().clear_bit().$rde().clear_bit()
                            );
                        )?
                    });
                }

                fn rtc_enable_wake_up_from_light_sleep(&self, event: Event, enable: bool) {
                    unsafe{ &*RTCIO::ptr() }.pin[$pin_num].modify(|_,w| unsafe{
                        w
                            .wakeup_enable().bit(enable)
                            .int_type().bits(if enable {event as u8} else {0})
                    });
                }

                fn enable_hold_internal(&self, on: bool) {
                    // shared register without set/clear functionality, so needs lock
                    (&RTCIO_LOCK).lock(|_|
                        unsafe{ &*RTCIO::ptr() }.$pin_reg.modify(|_, w| { w.$hold().bit(on) })
                    );
                }
            }

            $(
                // addresses errata 3.6: pull up/down on pins with RTC can be only controlled
                // via RTC_MUX
                impl<MODE> Pull for $pxi<MODE> {
                    fn internal_pull_up(&mut self, on: bool) -> &mut Self {
                    // shared register without set/clear functionality, so needs lock
                    (&RTCIO_LOCK).lock(|_|
                            unsafe{ &*RTCIO::ptr() }.$pin_reg.modify(|_,w| { w.$rue().bit(on) })
                        );
                        self
                    }

                    fn internal_pull_down(&mut self, on: bool) -> &mut Self {
                        // shared register without set/clear functionality, so needs lock
                        (&RTCIO_LOCK).lock(|_|
                            unsafe{ &*RTCIO::ptr() }.$pin_reg.modify(|_,w| { w.$rde().bit(on) })
                        );
                        self
                    }
                }
            )?

        )+
    }
}

impl_analog! {[
    Gpio36: (0,  sensor_pads,  sense1_hold, sense1_mux_sel, sense1_fun_sel, sense1_fun_ie, sense1_slp_ie, sense1_slp_sel ),
    Gpio37: (1,  sensor_pads,  sense2_hold, sense2_mux_sel, sense2_fun_sel, sense2_fun_ie, sense2_slp_ie, sense2_slp_sel ),
    Gpio38: (2,  sensor_pads,  sense3_hold, sense3_mux_sel, sense3_fun_sel, sense3_fun_ie, sense3_slp_ie, sense3_slp_sel ),
    Gpio39: (3,  sensor_pads,  sense4_hold, sense4_mux_sel, sense4_fun_sel, sense4_fun_ie, sense4_slp_ie, sense4_slp_sel ),
    Gpio34: (4,  adc_pad,      adc1_hold,   adc1_mux_sel,   adc1_fun_sel,   adc1_fun_ie,   adc1_slp_ie,   adc1_slp_sel   ),
    Gpio35: (5,  adc_pad,      adc2_hold,   adc2_mux_sel,   adc2_fun_sel,   adc1_fun_ie,   adc1_slp_ie,   adc1_slp_sel   ),
    Gpio25: (6,  pad_dac1,     pdac1_hold,  pdac1_mux_sel,  pdac1_fun_sel,  pdac1_fun_ie,  pdac1_slp_ie,  pdac1_slp_sel,  pdac1_rue, pdac1_rde, pdac1_drv, pdac1_slp_oe),
    Gpio26: (7,  pad_dac2,     pdac2_hold,  pdac2_mux_sel,  pdac2_fun_sel,  pdac2_fun_ie,  pdac2_slp_ie,  pdac2_slp_sel,  pdac2_rue, pdac2_rde, pdac2_drv, pdac2_slp_oe),
    Gpio33: (8,  xtal_32k_pad, x32n_hold,   x32n_mux_sel,   x32n_fun_sel,   x32n_fun_ie,   x32n_slp_ie,   x32n_slp_sel,   x32n_rue,  x32n_rde,  x32n_drv,  x32n_slp_oe),
    Gpio32: (9,  xtal_32k_pad, x32p_hold,   x32p_mux_sel,   x32p_fun_sel,   x32p_fun_ie,   x32p_slp_ie,   x32p_slp_sel,   x32p_rue,  x32p_rde,  x32p_drv,  x32p_slp_oe),
    Gpio4:  (10, touch_pad0,   hold,        mux_sel,        fun_sel,        fun_ie,        slp_ie,        slp_sel,        rue,       rde,       drv,       slp_oe),
    Gpio0:  (11, touch_pad1,   hold,        mux_sel,        fun_sel,        fun_ie,        slp_ie,        slp_sel,        rue,       rde,       drv,       slp_oe),
    Gpio2:  (12, touch_pad2,   hold,        mux_sel,        fun_sel,        fun_ie,        slp_ie,        slp_sel,        rue,       rde,       drv,       slp_oe),
    Gpio15: (13, touch_pad3,   hold,        mux_sel,        fun_sel,        fun_ie,        slp_ie,        slp_sel,        rue,       rde,       drv,       slp_oe),
    Gpio13: (14, touch_pad4,   hold,        mux_sel,        fun_sel,        fun_ie,        slp_ie,        slp_sel,        rue,       rde,       drv,       slp_oe),
    Gpio12: (15, touch_pad5,   hold,        mux_sel,        fun_sel,        fun_ie,        slp_ie,        slp_sel,        rue,       rde,       drv,       slp_oe),
    Gpio14: (16, touch_pad6,   hold,        mux_sel,        fun_sel,        fun_ie,        slp_ie,        slp_sel,        rue,       rde,       drv,       slp_oe),
    Gpio27: (17, touch_pad7,   hold,        mux_sel,        fun_sel,        fun_ie,        slp_ie,        slp_sel,        rue,       rde,       drv,       slp_oe),
]}