msp432/
dma.rs

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
// Licensed under the Apache License, Version 2.0 or the MIT License.
// SPDX-License-Identifier: Apache-2.0 OR MIT
// Copyright Tock Contributors 2022.

//! Direct Memory Access (DMA)

use core::cell::Cell;
use kernel::utilities::cells::{OptionalCell, TakeCell};
use kernel::utilities::registers::interfaces::{ReadWriteable, Readable, Writeable};
use kernel::utilities::registers::{
    register_bitfields, register_structs, InMemoryRegister, ReadOnly, ReadWrite, WriteOnly,
};
use kernel::utilities::StaticRef;

const DMA_BASE: StaticRef<DmaRegisters> =
    unsafe { StaticRef::new(0x4000_E000 as *const DmaRegisters) };

static DMA_CONFIG: DmaConfigBlock = DmaConfigBlock([
    // Unfortunately the Default-trait does not support constant functions and the InMemoryRegister
    // structs do not implement the copy-trait, so it's necessary to initialize this array by hand.
    DmaChannelControl::const_default(),
    DmaChannelControl::const_default(),
    DmaChannelControl::const_default(),
    DmaChannelControl::const_default(),
    DmaChannelControl::const_default(),
    DmaChannelControl::const_default(),
    DmaChannelControl::const_default(),
    DmaChannelControl::const_default(),
    DmaChannelControl::const_default(),
    DmaChannelControl::const_default(),
    DmaChannelControl::const_default(),
    DmaChannelControl::const_default(),
    DmaChannelControl::const_default(),
    DmaChannelControl::const_default(),
    DmaChannelControl::const_default(),
    DmaChannelControl::const_default(),
]);

/// Although there are 8bits reserved for selecting a source for the DMA trigger, the
/// MSP432P4x family only supports numbers from 1 to 7. 0 doesn't cause an error, but it's
/// marked as reserved. According to the device-specific datasheet 'reserved' can be used for
/// transfering data from one location in the RAM to another one.
const MAX_SRC_NR: u8 = 7;

/// The MSP432 chips contain 8 DMA channels
pub const AVAILABLE_DMA_CHANNELS: usize = 8;

/// The DMA can perform up to 1024 transfers before it needs to rearbitrate the bus
const MAX_TRANSFERS_LEN: usize = 1024;

register_structs! {
    /// DMA
    DmaRegisters {
        /// Device Configuration Status
        (0x0000 => device_cfg: ReadOnly<u32, DMA_DEVICE_CFG::Register>),
        /// Software Channel Trigger Register
        (0x0004 => sw_chtrig: ReadWrite<u32, DMA_SW_CHTRIG::Register>),
        (0x0008 => _reserved0),
        /// Channel n Source Configuration Registers
        (0x0010 => ch_srccfg: [ReadWrite<u32>; 32]),
        (0x0090 => _reserved1),
        /// Interrupt 1 Source Channel Configuration
        (0x0100 => int1_srccfg: ReadWrite<u32, DMA_INT1_SRCCFG::Register>),
        /// Interrupt 2 Source Channel Configuration Register
        (0x0104 => int2_srccfg: ReadWrite<u32, DMA_INT2_SRCCFG::Register>),
        /// Interrupt 3 Source Channel Configuration Register
        (0x0108 => int3_srccfg: ReadWrite<u32, DMA_INT3_SRCCFG::Register>),
        (0x010C => _reserved2),
        /// Interrupt 0 Source Channel Flag Register
        (0x0110 => int0_srcflg: ReadOnly<u32, DMA_INT0_SRCFLG::Register>),
        /// Interrupt 0 Source Channel Clear Flag Register
        (0x0114 => int0_clrflg: WriteOnly<u32, DMA_INT0_CLRFLG::Register>),
        (0x0118 => _reserved3),
        /// Status Register
        (0x1000 => stat: ReadOnly<u32, DMA_STAT::Register>),
        /// Configuration Register
        (0x1004 => cfg: WriteOnly<u32, DMA_CFG::Register>),
        /// Channel Control Data Base Pointer Register
        (0x1008 => ctlbase: ReadWrite<u32>),
        /// Channel Alternate Control Data Base Pointer Register
        (0x100C => altbase: ReadOnly<u32>),
        /// Channel Wait on Request Status Register
        (0x1010 => waitstat: ReadOnly<u32>),
        /// Channel Software Request Register
        (0x1014 => wreq: WriteOnly<u32>),
        /// Channel Useburst Set Register
        (0x1018 => useburstset: ReadWrite<u32>),
        /// Channel Useburst Clear Register
        (0x101C => useburstclr: WriteOnly<u32>),
        /// Channel Request Mask Set Register
        (0x1020 => reqmaskset: ReadWrite<u32>),
        /// Channel Request Mask Clear Register
        (0x1024 => reqmaskclr: WriteOnly<u32>),
        /// Channel Enable Set Register
        (0x1028 => enaset: ReadWrite<u32>),
        /// Channel Enable Clear Register
        (0x102C => enaclr: WriteOnly<u32>),
        /// Channel Primary-Alternate Set Register
        (0x1030 => altset: ReadWrite<u32>),
        /// Channel Primary-Alternate Clear Register
        (0x1034 => altclr: WriteOnly<u32>),
        /// Channel Priority Set Register
        (0x1038 => prioset: ReadWrite<u32>),
        /// Channel Priority Clear Register
        (0x103C => prioclr: WriteOnly<u32>),
        (0x1040 => _reserved4),
        /// Bus Error Clear Register
        (0x104C => errclr: ReadWrite<u32>),
        (0x1050 => @END),
    }
}

register_bitfields![u32,
    DMA_DEVICE_CFG [
        /// Number of DMA channels available
        NUM_DMA_CHANNELS OFFSET(0) NUMBITS(8) [],
        /// Number of DMA sources per channel
        NUM_SRC_PER_CHANNEL OFFSET(8) NUMBITS(8) []
    ],
    DMA_SW_CHTRIG [
        /// Write 1, triggers DMA_CHANNEL0
        CH0 OFFSET(0) NUMBITS(1) [],
        /// Write 1, triggers DMA_CHANNEL1
        CH1 OFFSET(1) NUMBITS(1) [],
        /// Write 1, triggers DMA_CHANNEL2
        CH2 OFFSET(2) NUMBITS(1) [],
        /// Write 1, triggers DMA_CHANNEL3
        CH3 OFFSET(3) NUMBITS(1) [],
        /// Write 1, triggers DMA_CHANNEL4
        CH4 OFFSET(4) NUMBITS(1) [],
        /// Write 1, triggers DMA_CHANNEL5
        CH5 OFFSET(5) NUMBITS(1) [],
        /// Write 1, triggers DMA_CHANNEL6
        CH6 OFFSET(6) NUMBITS(1) [],
        /// Write 1, triggers DMA_CHANNEL7
        CH7 OFFSET(7) NUMBITS(1) [],
        /// Write 1, triggers DMA_CHANNEL8
        CH8 OFFSET(8) NUMBITS(1) [],
        /// Write 1, triggers DMA_CHANNEL9
        CH9 OFFSET(9) NUMBITS(1) [],
        /// Write 1, triggers DMA_CHANNEL10
        CH10 OFFSET(10) NUMBITS(1) [],
        /// Write 1, triggers DMA_CHANNEL11
        CH11 OFFSET(11) NUMBITS(1) [],
        /// Write 1, triggers DMA_CHANNEL12
        CH12 OFFSET(12) NUMBITS(1) [],
        /// Write 1, triggers DMA_CHANNEL13
        CH13 OFFSET(13) NUMBITS(1) [],
        /// Write 1, triggers DMA_CHANNEL14
        CH14 OFFSET(14) NUMBITS(1) [],
        /// Write 1, triggers DMA_CHANNEL15
        CH15 OFFSET(15) NUMBITS(1) [],
        /// Write 1, triggers DMA_CHANNEL16
        CH16 OFFSET(16) NUMBITS(1) [],
        /// Write 1, triggers DMA_CHANNEL17
        CH17 OFFSET(17) NUMBITS(1) [],
        /// Write 1, triggers DMA_CHANNEL18
        CH18 OFFSET(18) NUMBITS(1) [],
        /// Write 1, triggers DMA_CHANNEL19
        CH19 OFFSET(19) NUMBITS(1) [],
        /// Write 1, triggers DMA_CHANNEL20
        CH20 OFFSET(20) NUMBITS(1) [],
        /// Write 1, triggers DMA_CHANNEL21
        CH21 OFFSET(21) NUMBITS(1) [],
        /// Write 1, triggers DMA_CHANNEL22
        CH22 OFFSET(22) NUMBITS(1) [],
        /// Write 1, triggers DMA_CHANNEL23
        CH23 OFFSET(23) NUMBITS(1) [],
        /// Write 1, triggers DMA_CHANNEL24
        CH24 OFFSET(24) NUMBITS(1) [],
        /// Write 1, triggers DMA_CHANNEL25
        CH25 OFFSET(25) NUMBITS(1) [],
        /// Write 1, triggers DMA_CHANNEL26
        CH26 OFFSET(26) NUMBITS(1) [],
        /// Write 1, triggers DMA_CHANNEL27
        CH27 OFFSET(27) NUMBITS(1) [],
        /// Write 1, triggers DMA_CHANNEL28
        CH28 OFFSET(28) NUMBITS(1) [],
        /// Write 1, triggers DMA_CHANNEL29
        CH29 OFFSET(29) NUMBITS(1) [],
        /// Write 1, triggers DMA_CHANNEL30
        CH30 OFFSET(30) NUMBITS(1) [],
        /// Write 1, triggers DMA_CHANNEL31
        CH31 OFFSET(31) NUMBITS(1) []
    ],
    DMA_INT1_SRCCFG [
        /// Controls which channel's completion event is mapped as a source of this Interrup
        INT_SRC OFFSET(0) NUMBITS(5) [],
        /// Enables DMA_INT1 mapping
        EN OFFSET(5) NUMBITS(1) []
    ],
    DMA_INT2_SRCCFG [
        /// Controls which channel's completion event is mapped as a source of this Interrup
        INT_SRC OFFSET(0) NUMBITS(5) [],
        /// Enables DMA_INT2 mapping
        EN OFFSET(5) NUMBITS(1) []
    ],
    DMA_INT3_SRCCFG [
        /// Controls which channel's completion event is mapped as a source of this Interrup
        INT_SRC OFFSET(0) NUMBITS(5) [],
        /// Enables DMA_INT3 mapping
        EN OFFSET(5) NUMBITS(1) []
    ],
    DMA_INT0_SRCFLG [
        /// Channel 0 was the source of DMA_INT0
        CH0 OFFSET(0) NUMBITS(1) [],
        /// Channel 1 was the source of DMA_INT0
        CH1 OFFSET(1) NUMBITS(1) [],
        /// Channel 2 was the source of DMA_INT0
        CH2 OFFSET(2) NUMBITS(1) [],
        /// Channel 3 was the source of DMA_INT0
        CH3 OFFSET(3) NUMBITS(1) [],
        /// Channel 4 was the source of DMA_INT0
        CH4 OFFSET(4) NUMBITS(1) [],
        /// Channel 5 was the source of DMA_INT0
        CH5 OFFSET(5) NUMBITS(1) [],
        /// Channel 6 was the source of DMA_INT0
        CH6 OFFSET(6) NUMBITS(1) [],
        /// Channel 7 was the source of DMA_INT0
        CH7 OFFSET(7) NUMBITS(1) [],
        /// Channel 8 was the source of DMA_INT0
        CH8 OFFSET(8) NUMBITS(1) [],
        /// Channel 9 was the source of DMA_INT0
        CH9 OFFSET(9) NUMBITS(1) [],
        /// Channel 10 was the source of DMA_INT0
        CH10 OFFSET(10) NUMBITS(1) [],
        /// Channel 11 was the source of DMA_INT0
        CH11 OFFSET(11) NUMBITS(1) [],
        /// Channel 12 was the source of DMA_INT0
        CH12 OFFSET(12) NUMBITS(1) [],
        /// Channel 13 was the source of DMA_INT0
        CH13 OFFSET(13) NUMBITS(1) [],
        /// Channel 14 was the source of DMA_INT0
        CH14 OFFSET(14) NUMBITS(1) [],
        /// Channel 15 was the source of DMA_INT0
        CH15 OFFSET(15) NUMBITS(1) [],
        /// Channel 16 was the source of DMA_INT0
        CH16 OFFSET(16) NUMBITS(1) [],
        /// Channel 17 was the source of DMA_INT0
        CH17 OFFSET(17) NUMBITS(1) [],
        /// Channel 18 was the source of DMA_INT0
        CH18 OFFSET(18) NUMBITS(1) [],
        /// Channel 19 was the source of DMA_INT0
        CH19 OFFSET(19) NUMBITS(1) [],
        /// Channel 20 was the source of DMA_INT0
        CH20 OFFSET(20) NUMBITS(1) [],
        /// Channel 21 was the source of DMA_INT0
        CH21 OFFSET(21) NUMBITS(1) [],
        /// Channel 22 was the source of DMA_INT0
        CH22 OFFSET(22) NUMBITS(1) [],
        /// Channel 23 was the source of DMA_INT0
        CH23 OFFSET(23) NUMBITS(1) [],
        /// Channel 24 was the source of DMA_INT0
        CH24 OFFSET(24) NUMBITS(1) [],
        /// Channel 25 was the source of DMA_INT0
        CH25 OFFSET(25) NUMBITS(1) [],
        /// Channel 26 was the source of DMA_INT0
        CH26 OFFSET(26) NUMBITS(1) [],
        /// Channel 27 was the source of DMA_INT0
        CH27 OFFSET(27) NUMBITS(1) [],
        /// Channel 28 was the source of DMA_INT0
        CH28 OFFSET(28) NUMBITS(1) [],
        /// Channel 29 was the source of DMA_INT0
        CH29 OFFSET(29) NUMBITS(1) [],
        /// Channel 30 was the source of DMA_INT0
        CH30 OFFSET(30) NUMBITS(1) [],
        /// Channel 31 was the source of DMA_INT0
        CH31 OFFSET(31) NUMBITS(1) []
    ],
    DMA_INT0_CLRFLG [
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH0 OFFSET(0) NUMBITS(1) [],
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH1 OFFSET(1) NUMBITS(1) [],
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH2 OFFSET(2) NUMBITS(1) [],
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH3 OFFSET(3) NUMBITS(1) [],
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH4 OFFSET(4) NUMBITS(1) [],
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH5 OFFSET(5) NUMBITS(1) [],
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH6 OFFSET(6) NUMBITS(1) [],
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH7 OFFSET(7) NUMBITS(1) [],
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH8 OFFSET(8) NUMBITS(1) [],
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH9 OFFSET(9) NUMBITS(1) [],
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH10 OFFSET(10) NUMBITS(1) [],
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH11 OFFSET(11) NUMBITS(1) [],
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH12 OFFSET(12) NUMBITS(1) [],
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH13 OFFSET(13) NUMBITS(1) [],
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH14 OFFSET(14) NUMBITS(1) [],
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH15 OFFSET(15) NUMBITS(1) [],
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH16 OFFSET(16) NUMBITS(1) [],
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH17 OFFSET(17) NUMBITS(1) [],
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH18 OFFSET(18) NUMBITS(1) [],
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH19 OFFSET(19) NUMBITS(1) [],
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH20 OFFSET(20) NUMBITS(1) [],
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH21 OFFSET(21) NUMBITS(1) [],
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH22 OFFSET(22) NUMBITS(1) [],
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH23 OFFSET(23) NUMBITS(1) [],
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH24 OFFSET(24) NUMBITS(1) [],
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH25 OFFSET(25) NUMBITS(1) [],
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH26 OFFSET(26) NUMBITS(1) [],
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH27 OFFSET(27) NUMBITS(1) [],
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH28 OFFSET(28) NUMBITS(1) [],
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH29 OFFSET(29) NUMBITS(1) [],
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH30 OFFSET(30) NUMBITS(1) [],
        /// Clear corresponding DMA_INT0_SRCFLG_REG
        CH31 OFFSET(31) NUMBITS(1) []
    ],
    DMA_STAT [
        /// Enable status of the controller
        MASTEN OFFSET(0) NUMBITS(1) [
            /// Controller disabled
            ControllerDisabled = 0,
            /// Controller enabled
            ControllerEnabled = 1
        ],
        /// Current state of the control state machine.
        /// State can be one of the following:
        STATE OFFSET(4) NUMBITS(4) [
            /// idle
            Idle = 0,
            /// reading channel controller data
            ReadingChannelControllerData = 1,
            /// reading source data end pointer
            ReadingSourceDataEndPointer = 2,
            /// reading destination data end pointer
            ReadingDestinationDataEndPointer = 3,
            /// reading source data
            ReadingSourceData = 4,
            /// writing destination data
            WritingDestinationData = 5,
            /// waiting for DMA request to clear
            WaitingForDMARequestToClear = 6,
            /// writing channel controller data
            WritingChannelControllerData = 7,
            /// stalled
            Stalled = 8,
            /// done
            Done = 9,
            /// peripheral scatter-gather transition
            PeripheralScatterGatherTransition = 10
        ],
        /// Number of available DMA channels minus one.
        DMACHANS OFFSET(16) NUMBITS(5) [
            /// Controller configured to use 1 DMA channel
            ControllerConfiguredToUse1DMAChannel = 0,
            /// Controller configured to use 2 DMA channels
            ControllerConfiguredToUse2DMAChannels = 1,
            /// Controller configured to use 31 DMA channels
            ControllerConfiguredToUse31DMAChannels = 30,
            /// Controller configured to use 32 DMA channels
            ControllerConfiguredToUse32DMAChannels = 31
        ],
        /// To reduce the gate count the controller can be configured to exclude the integra
        TESTSTAT OFFSET(28) NUMBITS(4) [
            /// Controller does not include the integration test logic
            ControllerDoesNotIncludeTheIntegrationTestLogic = 0,
            /// Controller includes the integration test logic
            ControllerIncludesTheIntegrationTestLogic = 1
        ]
    ],
    DMA_CFG [
        /// Enable status of the controller
        MASTEN OFFSET(0) NUMBITS(1) [
            /// Controller disabled
            ControllerDisabled = 0,
            /// Controller enabled
            ControllerEnabled = 1
        ],
        /// Sets the AHB-Lite protection by controlling the HPROT[3:1] signal levels as fol
        CHPROTCTRL OFFSET(5) NUMBITS(3) []
    ]
];

register_bitfields![u32,
    /// DMA control data configuration
    DMA_CTRL [
        /// Cycle control
        CYCLE_CTRL OFFSET(0) NUMBITS(3) [
            /// Stop. indicates that the data-structure is invalid
            Stop = 0,
            /// Basic transfer mode
            Basic = 1,
            /// Auto-request mode
            Auto = 2,
            /// Ping-pong mode
            PingPong = 3,
            /// Memory scatter-gather mode, which uses the primary data-structure
            MemoryScatterGatherPrimary = 4,
            /// Memory scatter-gather mode, which uses the alternate data-structure
            MemoryScatterGatherAlternate = 5,
            /// Peripheral scatter-gather mode, which uses the primary data-structure
            PeripheralScatterGatherPrimary = 6,
            /// Peripheral scatter-gather mode, which uses the alternate data-structure
            PeripheralScatterGatherAlternate = 7
        ],
        /// Controls if the chnl_useburst_set bit is is set to 1
        NEXT_USEBURST OFFSET(3) NUMBITS(1) [],
        /// These bits represent the total number of DMA transfers minus 1
        /// that the DMA cycle contains.
        N_MINUS_1 OFFSET(4) NUMBITS(10) [],
        /// These bits control how many DMA transfers can occur before the controller rearbitrates
        /// the bus. The register-value is the 'ld' of the number of cycles. E.g. 128 cycles ->
        /// regval = ld(128) = 7. The maximum number of cycles is 1024 -> regval = 10
        R_POWER OFFSET(14) NUMBITS(4) [],
        /// These bits set the control state of HPROT[3:1] when the controller reads data. For the
        /// MSP432 family these bits can be ignored, because they have no effect. The DMA in the
        /// MSP432-devices can access all memory, no matter how these bits are set.
        SRC_PROT_CTRL OFFSET(18) NUMBITS(3) [],
        /// These bits set the control state of HPROT[3:1] when the controller writes data. For the
        /// MSP432 family these bits can be ignored, because they have no effect. The DMA in the
        /// MSP432-devices can access all memory, no matter how these bits are set.
        DST_PROT_CTRL OFFSET(21) NUMBITS(3) [],
        /// These bits control the size of the source-data
        SRC_SIZE OFFSET(24) NUMBITS(2) [
            /// Byte -> 8bit
            Byte = 0,
            /// Half-word -> 16bit
            HalfWord = 1,
            /// Word -> 32bit
            Word = 2
        ],
        /// These bits set the source address-increment
        SRC_INC OFFSET(26) NUMBITS(2) [
            /// Byte -> +1
            Byte = 0,
            /// Half-word -> +2
            HalfWord = 1,
            /// Word -> +4
            Word = 2,
            /// No increment -> +0
            NoIncrement = 3
        ],
        /// These bits control the size of the destination-data.
        /// NOTE: DST_SIZE must be the same as SRC_SIZE!
        DST_SIZE OFFSET(28) NUMBITS(2) [
            /// Byte -> 8bit
            Byte = 0,
            /// Half-word -> 16bit
            HalfWord = 1,
            /// Word -> 32bit
            Word = 2
        ],
        /// These bits set the destination address-increment
        DST_INC OFFSET(30) NUMBITS(2) [
            /// Byte -> +1
            Byte = 0,
            /// Half-word -> +2
            HalfWord = 1,
            /// Word -> +4
            Word = 2,
            /// No increment -> +0
            NoIncrement = 3
        ]
    ]
];

/// The uDMA of the MSP432 family don't offer own registers where the configuration of the
/// individual DMA channels is stored, they require a pointer to a block of memory in the RAM
/// where the actual configuration is stored. Within this block of memory the pointer to the
/// data-source, the pointer to the destination and the configuration is stored. Probably due to
/// alignment reasons the 4th word is unused.
#[repr(align(16))]
struct DmaChannelControl {
    src_ptr: InMemoryRegister<u32>,
    dst_ptr: InMemoryRegister<u32>,
    ctrl: InMemoryRegister<u32, DMA_CTRL::Register>,
    _unused: InMemoryRegister<u32>,
}

/// It's necessary to allocate twice as much buffers as DMA channels are available. This is because
/// the DMA supports modes where a primary buffer and an alternative one can be used.
#[repr(align(256))]
struct DmaConfigBlock([DmaChannelControl; 2 * AVAILABLE_DMA_CHANNELS]);

/// It's necessary to implement `Sync`, otherwise the `DMA_CONFIG` array cannot be instantiated
/// because static variables require the `Sync` trait, otherwise they are not threadsafe.
unsafe impl Sync for DmaConfigBlock {}

/// Trait for handling the callbacks if a DMA transfer finished
pub trait DmaClient {
    fn transfer_done(
        &self,
        tx_buf: Option<&'static mut [u8]>,
        rx_buf: Option<&'static mut [u8]>,
        transmitted_bytes: usize,
    );
}

#[repr(u32)]
#[derive(Copy, Clone, PartialEq)]
pub enum DmaMode {
    Basic = 1,
    AutoRequest = 2,
    PingPong = 3,
    MemoryScatterGather = 4,
    PeripheralScatterGather = 6,
}

#[repr(u32)]
#[derive(Copy, Clone)]
pub enum DmaDataWidth {
    Width8Bit,
    Width16Bit,
    Width32Bit,
}

#[repr(u32)]
#[derive(Copy, Clone, PartialEq)]
pub enum DmaPtrIncrement {
    Incr8Bit,
    Incr16Bit,
    Incr32Bit,
    NoIncr,
}

#[derive(Copy, Clone)]
pub struct DmaConfig {
    pub src_chan: u8,
    pub mode: DmaMode,
    pub width: DmaDataWidth,
    pub src_incr: DmaPtrIncrement,
    pub dst_incr: DmaPtrIncrement,
}

#[derive(Copy, Clone, PartialEq)]
enum DmaTransferType {
    PeripheralToMemory,
    PeripheralToMemoryPingPong,
    MemoryToPeripheral,
    MemoryToMemory,
    None,
}

#[derive(Copy, Clone, PartialEq)]
enum ActiveBuffer {
    Primary,
    Alternative,
}

pub struct DmaChannels<'a> {
    pub channels: [DmaChannel<'a>; AVAILABLE_DMA_CHANNELS],
}

impl DmaChannels<'_> {
    pub fn new() -> Self {
        Self {
            channels: [
                crate::dma::DmaChannel::new(0), // Used for UART0 TX
                crate::dma::DmaChannel::new(1), // Used for UART0 RX
                crate::dma::DmaChannel::new(2),
                crate::dma::DmaChannel::new(3),
                crate::dma::DmaChannel::new(4),
                crate::dma::DmaChannel::new(5),
                crate::dma::DmaChannel::new(6),
                crate::dma::DmaChannel::new(7), // Used for ADC
            ],
        }
    }

    pub fn handle_interrupt(&self, int_nr: isize) {
        if int_nr == 0 {
            // For now only use the INT0 because I don't know how to prioritize the channels in order
            // to give them 1 out of 3 'own' interrupts.
            let int = self.channels[0].registers.int0_srcflg.get();

            for i in 0..AVAILABLE_DMA_CHANNELS {
                let bit = (1 << i) as u32;
                if (bit & int) > 0 {
                    // Clear interrupt-bit
                    self.channels[i].registers.int0_clrflg.set(bit);

                    self.channels[i].handle_interrupt();
                }
            }
        } else if int_nr < 0 {
            panic!("DMA: error interrupt");
        } else {
            panic!("DMA: unhandled interrupt-nr: {}", int_nr);
        }
    }
}

impl<'a> core::ops::Index<usize> for DmaChannels<'a> {
    type Output = DmaChannel<'a>;

    fn index(&self, idx: usize) -> &Self::Output {
        &self.channels[idx]
    }
}

pub struct DmaChannel<'a> {
    registers: StaticRef<DmaRegisters>,
    chan_nr: usize,
    in_use: Cell<bool>,
    config: Cell<DmaConfig>,
    transfer_type: Cell<DmaTransferType>,
    active_buf: Cell<ActiveBuffer>,
    tx_buf_prim: TakeCell<'static, [u8]>,
    rx_buf_prim: TakeCell<'static, [u8]>,
    tx_buf_alt: TakeCell<'static, [u8]>,
    rx_buf_alt: TakeCell<'static, [u8]>,
    bytes_to_transmit_prim: Cell<usize>,
    bytes_to_transmit_alt: Cell<usize>,
    remaining_words: Cell<usize>,
    client: OptionalCell<&'a dyn DmaClient>,
}

impl DmaChannelControl {
    const fn const_default() -> Self {
        Self {
            src_ptr: InMemoryRegister::new(0),
            dst_ptr: InMemoryRegister::new(0),
            ctrl: InMemoryRegister::new(0),
            _unused: InMemoryRegister::new(0),
        }
    }
}

impl DmaConfig {
    const fn const_default() -> Self {
        Self {
            src_chan: 1,
            mode: DmaMode::Basic,
            width: DmaDataWidth::Width8Bit,
            // Default is to copy data from a hardware to a buffer
            src_incr: DmaPtrIncrement::NoIncr,
            dst_incr: DmaPtrIncrement::Incr8Bit,
        }
    }
}

impl<'a> DmaChannel<'a> {
    pub fn new(chan_nr: usize) -> DmaChannel<'a> {
        DmaChannel {
            registers: DMA_BASE,
            chan_nr,
            in_use: Cell::new(false),
            config: Cell::new(DmaConfig::const_default()),
            transfer_type: Cell::new(DmaTransferType::None),
            active_buf: Cell::new(ActiveBuffer::Primary),
            tx_buf_prim: TakeCell::empty(),
            rx_buf_prim: TakeCell::empty(),
            tx_buf_alt: TakeCell::empty(),
            rx_buf_alt: TakeCell::empty(),
            bytes_to_transmit_prim: Cell::new(0),
            bytes_to_transmit_alt: Cell::new(0),
            remaining_words: Cell::new(0),
            client: OptionalCell::empty(),
        }
    }

    fn dma_is_enabled(&self) -> bool {
        self.registers.stat.is_set(DMA_STAT::MASTEN)
    }

    fn enable_dma(&self) {
        // Enable the DMA module
        self.registers.cfg.write(DMA_CFG::MASTEN::ControllerEnabled);

        // Set the pointer to the configuration-memory
        // Since the config needs exactly 256 bytes, mask out the lower 256 bytes
        let addr = (core::ptr::from_ref::<DmaChannelControl>(&DMA_CONFIG.0[0]) as u32) & (!0xFFu32);
        self.registers.ctlbase.set(addr);
    }

    fn apply_config(&self) {
        let conf = self.config.get();

        if conf.mode == DmaMode::MemoryScatterGather {
            panic!("DMA: Memory scatter-gather mode currently not supported!");
        }
        if conf.mode == DmaMode::PeripheralScatterGather {
            panic!("DMA: Peripheral scatter-gather mode currently not supported!");
        }

        // The memory acces protection fields 'dst_prot_ctrl' and 'src_prot_ctrl' are not necessary
        // to configure for the MSP432P4x chips because they don't affect the privileges of the
        // DMA module. In other words, the DMA can access every memory and register at every time.
        // For more information see datasheet p. 625 section 11.2.2.3.

        DMA_CONFIG.0[self.chan_nr].ctrl.modify(
            DMA_CTRL::SRC_SIZE.val(conf.width as u32)
                + DMA_CTRL::DST_SIZE.val(conf.width as u32)
                + DMA_CTRL::SRC_INC.val(conf.src_incr as u32)
                + DMA_CTRL::DST_INC.val(conf.dst_incr as u32),
        );

        // Set the source-peripheral for the DMA channel
        self.registers.ch_srccfg[self.chan_nr].set((conf.src_chan % (MAX_SRC_NR + 1)) as u32);
    }

    fn enable_dma_channel(&self) {
        self.registers
            .enaset
            .set(self.registers.enaset.get() | ((1 << self.chan_nr) as u32));
    }

    fn setup_transfer_primary_buffer(&self, len: usize) {
        self.configure_channel(len, self.chan_nr);

        // Store to transmitting bytes
        self.bytes_to_transmit_prim.set(len);
    }

    fn setup_transfer_alternate_buffer(&self, len: usize) {
        self.configure_channel(len, self.chan_nr + AVAILABLE_DMA_CHANNELS);

        // Store to transmitting bytes
        self.bytes_to_transmit_alt.set(len);
    }

    fn update_buffer_ptr(&self) {
        let rem_words = self.remaining_words.get();
        let tt = self.transfer_type.get();
        let conf = self.config.get();
        let (len, chan_nr) = if tt == DmaTransferType::PeripheralToMemoryPingPong
            && self.active_buf.get() == ActiveBuffer::Alternative
        {
            (
                self.bytes_to_transmit_alt.get(),
                self.chan_nr + AVAILABLE_DMA_CHANNELS,
            )
        } else {
            (self.bytes_to_transmit_prim.get(), self.chan_nr)
        };

        // Update the buffer-pointers
        if tt == DmaTransferType::PeripheralToMemory
            || tt == DmaTransferType::MemoryToMemory
            || tt == DmaTransferType::PeripheralToMemoryPingPong
        {
            // Update the destination-buffer pointer
            DMA_CONFIG.0[chan_nr].dst_ptr.set(
                DMA_CONFIG.0[chan_nr].dst_ptr.get()
                    + ((MAX_TRANSFERS_LEN as u32) << (conf.width as u32)),
            );
        }

        if (tt == DmaTransferType::MemoryToPeripheral) || (tt == DmaTransferType::MemoryToMemory) {
            // Update the source-buffer pointer
            DMA_CONFIG.0[chan_nr].src_ptr.set(
                DMA_CONFIG.0[chan_nr].src_ptr.get()
                    + ((MAX_TRANSFERS_LEN as u32) << (conf.width as u32)),
            );
        }

        // Update the remaining words
        if rem_words > MAX_TRANSFERS_LEN {
            self.remaining_words.set(rem_words - MAX_TRANSFERS_LEN);
        } else {
            self.remaining_words.set(0);
        }

        // If the transfer type is MemoryToMemory, the R_POWER register can have a different
        // value than 0, since the source- and destination address are incremented and it's not
        // necessary to wait for any hardware module to process or 'generate' data.
        let r_power = if tt == DmaTransferType::MemoryToMemory {
            if rem_words > MAX_TRANSFERS_LEN {
                31 - (MAX_TRANSFERS_LEN as u32).leading_zeros()
            } else {
                31 - (len as u32).leading_zeros()
            }
        } else {
            0
        };

        // Set the DMA mode since the DMA module sets it back to stop after every cycle
        // Set the DMA cycles to the amount of remaining words
        // Set the number of DMA-transfers after the DMA has to rearbitrate the bus
        DMA_CONFIG.0[chan_nr].ctrl.modify(
            DMA_CTRL::CYCLE_CTRL.val(conf.mode as u32)
                + DMA_CTRL::N_MINUS_1.val(((rem_words - 1) % MAX_TRANSFERS_LEN) as u32)
                + DMA_CTRL::R_POWER.val(r_power),
        );
    }

    fn calc_remaining_words(&self, bytes_to_transmit: usize) {
        let transfers = bytes_to_transmit >> (self.config.get().width as usize);

        // Store the remaining words
        if transfers > MAX_TRANSFERS_LEN {
            self.remaining_words.set(transfers - MAX_TRANSFERS_LEN);
        } else {
            self.remaining_words.set(0);
        }
    }

    fn configure_channel(&self, bytes_to_transmit: usize, chan_nr: usize) {
        let conf = self.config.get();
        let transfers = bytes_to_transmit >> (conf.width as usize);
        // The DMA can only transmit 1024 words with 1 transfer
        // Reset the bits in case they were set before to a different value
        // Set the DMA mode since it the DMA module sets it back to to stop after every cycle
        DMA_CONFIG.0[chan_nr].ctrl.modify(
            DMA_CTRL::N_MINUS_1.val(((transfers - 1) % MAX_TRANSFERS_LEN) as u32)
                + DMA_CTRL::R_POWER.val(0)
                + DMA_CTRL::CYCLE_CTRL.val(conf.mode as u32),
        );
    }

    fn set_primary_buffer(&self, src_end_ptr: u32, dst_end_ptr: u32) {
        DMA_CONFIG.0[self.chan_nr].src_ptr.set(src_end_ptr);
        DMA_CONFIG.0[self.chan_nr].dst_ptr.set(dst_end_ptr);
    }

    fn set_alternative_buffer(&self, src_end_ptr: u32, dst_end_ptr: u32) {
        DMA_CONFIG.0[self.chan_nr + AVAILABLE_DMA_CHANNELS]
            .src_ptr
            .set(src_end_ptr);
        DMA_CONFIG.0[self.chan_nr + AVAILABLE_DMA_CHANNELS]
            .dst_ptr
            .set(dst_end_ptr);
    }

    fn set_dma_mode(&self, mode: DmaMode) {
        let mut conf = self.config.get();
        conf.mode = mode;
        self.config.set(conf);
    }

    fn handle_interrupt(&self) {
        if self.remaining_words.get() > 0 {
            self.update_buffer_ptr();
        } else {
            if self.transfer_type.get() != DmaTransferType::PeripheralToMemoryPingPong {
                // Disable the DMA channel since the data transfer has finished
                self.registers.enaclr.set((1 << self.chan_nr) as u32);
            }
            // Fire the callback and return the buffer-references
            match self.transfer_type.get() {
                DmaTransferType::PeripheralToMemory => {
                    self.client.map(|cl| {
                        self.rx_buf_prim.take().map(|rx_buf| {
                            cl.transfer_done(None, Some(rx_buf), self.bytes_to_transmit_prim.get())
                        })
                    });
                }
                DmaTransferType::MemoryToPeripheral => {
                    self.client.map(|cl| {
                        self.tx_buf_prim.take().map(|tx_buf| {
                            cl.transfer_done(Some(tx_buf), None, self.bytes_to_transmit_prim.get())
                        })
                    });
                }
                DmaTransferType::MemoryToMemory => {
                    self.client.map(|cl| {
                        self.tx_buf_prim.take().map(|tx_buf| {
                            self.rx_buf_prim.take().map(move |rx_buf| {
                                cl.transfer_done(
                                    Some(tx_buf),
                                    Some(rx_buf),
                                    self.bytes_to_transmit_prim.get(),
                                )
                            })
                        })
                    });
                }
                DmaTransferType::PeripheralToMemoryPingPong => {
                    let (buf, len) = if self.active_buf.get() == ActiveBuffer::Primary {
                        self.active_buf.set(ActiveBuffer::Alternative);
                        self.calc_remaining_words(self.bytes_to_transmit_alt.get());
                        (self.rx_buf_prim.take(), self.bytes_to_transmit_prim.get())
                    } else {
                        self.active_buf.set(ActiveBuffer::Primary);
                        self.calc_remaining_words(self.bytes_to_transmit_prim.get());
                        (self.rx_buf_alt.take(), self.bytes_to_transmit_alt.get())
                    };

                    self.client
                        .map(|cl| buf.map(|buf| cl.transfer_done(None, Some(buf), len)));
                }
                _ => {}
            }
        }
    }

    pub fn set_client(&self, client: &'a dyn DmaClient) {
        if self.client.is_some() {
            panic!("DMA: channel {} is already in use!", self.chan_nr);
        }
        self.client.set(client);
    }

    pub fn initialize(&self, config: &DmaConfig) {
        if self.in_use.get() {
            panic!("DMA: channel {} is already in use!", self.chan_nr);
        }

        if !self.dma_is_enabled() {
            self.enable_dma();
        }

        self.in_use.set(true);
        self.config.set(*config);
        self.apply_config();
    }

    /// Start a DMA transfer where one buffer is copied into another one
    pub fn transfer_mem_to_mem(
        &self,
        src_buf: &'static mut [u8],
        dst_buf: &'static mut [u8],
        len: usize,
    ) {
        // Note: This function is currently entirely untested, since there is currently no driver
        // available where this function might be used.

        let width = self.config.get().width as u32;

        // Divide the byte-length by the width to get the number of necessary transfers
        let transfers = len >> width;

        // The pointers must point to the end of the buffer, for detailed calculation see
        // datasheet p. 646, section 11.2.4.4.
        let src_end_ptr = (core::ptr::from_ref::<u8>(&src_buf[0]) as u32) + ((len as u32) - 1);
        let dst_end_ptr = (core::ptr::from_ref::<u8>(&dst_buf[0]) as u32) + ((len as u32) - 1);

        // Setup the DMA configuration
        self.set_dma_mode(DmaMode::Basic);
        self.set_primary_buffer(src_end_ptr, dst_end_ptr);
        self.setup_transfer_primary_buffer(len);

        // Store remaining words
        self.calc_remaining_words(len);

        // Set the the number of cycles after the module rearbitrates the bus.
        // The 'register-value' for this is ld(cycles), e.g. cycles = 256 -> ld(256) = 8
        // In order to get the number of cycles, just get the closest 2^n value of transfers
        let r_power = if transfers > MAX_TRANSFERS_LEN {
            31 - (MAX_TRANSFERS_LEN as u32).leading_zeros()
        } else {
            31 - (len as u32).leading_zeros()
        };

        // Set the number of cycles before a bus rearbitration
        DMA_CONFIG.0[self.chan_nr]
            .ctrl
            .modify(DMA_CTRL::R_POWER.val(r_power));

        // Store the buffers
        self.rx_buf_prim.replace(dst_buf);
        self.tx_buf_prim.replace(src_buf);

        // Store transfer-type
        self.transfer_type.set(DmaTransferType::MemoryToMemory);

        // Enable the DMA channel
        self.enable_dma_channel();
    }

    /// Start a DMA transfer where the contents of any register will be copied into a provided buffer
    pub fn transfer_periph_to_mem(&self, src_reg: *const (), buf: &'static mut [u8], len: usize) {
        // The pointers must point to the end of the buffer, for detailed calculation see
        // datasheet p. 646, section 11.2.4.4.
        let src_end_ptr = src_reg as u32;
        let dst_end_ptr = (core::ptr::from_ref::<u8>(&buf[0]) as u32) + ((len as u32) - 1);

        // Setup the DMA configuration
        self.set_dma_mode(DmaMode::Basic);
        self.set_primary_buffer(src_end_ptr, dst_end_ptr);
        self.setup_transfer_primary_buffer(len);

        // Store the buffer
        self.rx_buf_prim.replace(buf);

        // Store remaining words
        self.calc_remaining_words(len);

        // Store transfer-type
        self.transfer_type.set(DmaTransferType::PeripheralToMemory);

        self.enable_dma_channel();
    }

    /// Start a DMA transfer where the contents of a buffer will be copied into a register
    pub fn transfer_mem_to_periph(&self, dst_reg: *const (), buf: &'static mut [u8], len: usize) {
        // The pointers must point to the end of the buffer, for detailed calculation see
        // datasheet p. 646, section 11.2.4.4.
        let src_end_ptr = (core::ptr::from_ref::<u8>(&buf[0]) as u32) + ((len as u32) - 1);
        let dst_end_ptr = dst_reg as u32;

        // Setup the DMA configuration
        self.set_dma_mode(DmaMode::Basic);
        self.set_primary_buffer(src_end_ptr, dst_end_ptr);
        self.setup_transfer_primary_buffer(len);

        // Store the buffer
        self.tx_buf_prim.replace(buf);

        // Store remaining words
        self.calc_remaining_words(len);

        // Store transfer-type
        self.transfer_type.set(DmaTransferType::MemoryToPeripheral);

        self.enable_dma_channel();
    }

    /// Start a ping-pong transfer from a peripheral to a certain location in memory
    pub fn transfer_periph_to_mem_pingpong(
        &self,
        src_reg: *const (),
        buf1: &'static mut [u8],
        len1: usize,
        buf2: &'static mut [u8],
        len2: usize,
    ) {
        // The pointers must point to the end of the buffer, for detailed calculation see
        // datasheet p. 646, section 11.2.4.4.

        let src_end_ptr = src_reg as u32;
        let dst_end_ptr1 = (core::ptr::from_ref::<u8>(&buf1[0]) as u32) + ((len1 as u32) - 1);
        let dst_end_ptr2 = (core::ptr::from_ref::<u8>(&buf2[0]) as u32) + ((len2 as u32) - 1);

        // Setup the DMA configuration
        self.set_dma_mode(DmaMode::PingPong);
        self.set_primary_buffer(src_end_ptr, dst_end_ptr1);
        self.set_alternative_buffer(src_end_ptr, dst_end_ptr2);
        self.setup_transfer_primary_buffer(len1);
        self.setup_transfer_alternate_buffer(len2);

        // Store the buffers
        self.rx_buf_prim.replace(buf1);
        self.rx_buf_alt.replace(buf2);

        // Store remaining words
        self.calc_remaining_words(len1);

        // Store transfer-type
        self.transfer_type
            .set(DmaTransferType::PeripheralToMemoryPingPong);

        self.enable_dma_channel();
    }

    /// Provide a new buffer for a ping-pong transfer
    pub fn provide_new_buffer(&self, buf: &'static mut [u8], len: usize) {
        let buf_end_ptr = (core::ptr::from_ref::<u8>(&buf[0]) as u32) + ((len as u32) - 1);

        if self.transfer_type.get() == DmaTransferType::PeripheralToMemoryPingPong {
            if self.active_buf.get() == ActiveBuffer::Primary {
                // Replace alternative buffer, overwrite only destination pointer!
                DMA_CONFIG.0[self.chan_nr + AVAILABLE_DMA_CHANNELS]
                    .dst_ptr
                    .set(buf_end_ptr);
                self.setup_transfer_alternate_buffer(len);
                self.rx_buf_alt.replace(buf);
                self.bytes_to_transmit_alt.set(len);
            } else {
                // Replace primary buffer, overwrite only destination pointer!
                DMA_CONFIG.0[self.chan_nr].dst_ptr.set(buf_end_ptr);
                self.setup_transfer_primary_buffer(len);
                self.rx_buf_prim.replace(buf);
                self.bytes_to_transmit_prim.set(len);
            }
        }
    }

    /// Stop any ongoing DMA transfer
    ///
    /// Returnvalues:
    /// usize:                      Number of transferred bytes until the transfer was stopped
    /// Option<&'static mut [u8]>:  Option to the primary TX buffer
    /// Option<&'static mut [u8]>:  Option to the primary RX buffer
    /// Option<&'static mut [u8]>:  Option to the alternate TX buffer
    /// Option<&'static mut [u8]>:  Option to the alternate RX buffer
    pub fn stop(
        &self,
    ) -> (
        usize,
        Option<&'static mut [u8]>,
        Option<&'static mut [u8]>,
        Option<&'static mut [u8]>,
        Option<&'static mut [u8]>,
    ) {
        // Disable the channel
        self.registers.enaclr.set((1 << self.chan_nr) as u32);
        // Set cycle-ctrl to stop in order to cancel an ongoing transaction
        DMA_CONFIG.0[self.chan_nr]
            .ctrl
            .modify(DMA_CTRL::CYCLE_CTRL::Stop);

        // Calculate the already transferred bytes
        let n_minus_1 = DMA_CONFIG.0[self.chan_nr].ctrl.read(DMA_CTRL::N_MINUS_1) as usize;
        let transferred_bytes = if self.active_buf.get() == ActiveBuffer::Primary {
            self.bytes_to_transmit_prim.get() - n_minus_1 + 1
        } else {
            self.bytes_to_transmit_alt.get() - n_minus_1 + 1
        };

        (
            transferred_bytes,
            self.tx_buf_prim.take(),
            self.rx_buf_prim.take(),
            self.tx_buf_alt.take(),
            self.rx_buf_alt.take(),
        )
    }
}