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
use core::marker::PhantomData;
use super::constants::{
    NUM_ENDPOINTS,
    EP_MEM_ADDR,
};
use crate::traits::usb::UsbSpeed;

static mut ENDPOINT_REGISTERS_ATTACHED: bool = false;

pub struct Instance {
    pub(crate) addr: u32,
    pub(crate) _marker: PhantomData<*const RegisterBlock>,
}

type EndpointRegisters = [EP; NUM_ENDPOINTS];

#[doc = r"Register block"]
#[repr(C)]
pub struct RegisterBlock {
    // TODO: Consider turning this struct into a newtype with dereferencing
    pub eps: EndpointRegisters,
}

#[doc = "logical endpoint register"]
#[repr(C)]
pub struct EP {
    // double-buffered, for single-buffered use only first
    pub ep_out: [EPR; 2],
    // double-buffered, for single-buffered use only first
    pub ep_in: [EPR; 2],
}

#[doc = "physical endpoint register"]
pub struct EPR {
    register: vcell::VolatileCell<u32>,
}

impl core::ops::Deref for Instance {
    type Target = RegisterBlock;
    #[inline(always)]
    fn deref(&self) -> &RegisterBlock {
        unsafe { &*(self.addr as *const _) }
    }
}

unsafe impl Send for Instance {}
unsafe impl Send for RegisterBlock {}

impl Instance {
    pub fn addr(&self) -> u32 {
        self.addr
    }

    fn reset(&mut self) {
        for ep in self.eps.iter() {
            ep.ep_out[0].reset();
            ep.ep_out[1].reset();
            ep.ep_in[0].reset();
            ep.ep_in[1].reset();
        }
    }

}

pub fn new(addr: u32) -> Instance {
    let mut instance = Instance {
        addr,
        _marker: PhantomData,
    };
    instance.reset();
    instance
}

pub fn attach() -> Option<Instance> {
    cortex_m::interrupt::free(|_| unsafe {
        if ENDPOINT_REGISTERS_ATTACHED {
            None
        } else {
            ENDPOINT_REGISTERS_ATTACHED = true;
            Some(new(EP_MEM_ADDR as u32))
        }
    })
}

/// Does not zero the memory
pub unsafe fn steal() -> Instance {
    ENDPOINT_REGISTERS_ATTACHED = true;
    Instance {
        addr: EP_MEM_ADDR as u32,
        _marker: PhantomData,
    }
}

// NOTE: It would be cleaner to use this approach, since the rule
// for access are different for control vs non-control, and SETUP
// is special-cased.
// But then the indices into RegisterBlock.eps need to be offset
// by 1, which is annoying.
// TODO: Consider using a union.

// #[doc = r"Register block"]
// #[repr(C)]
// pub struct RegisterBlock {
//     // logical control endpoint
//     pub ep0out: EPR,
//     pub setup: EPR,
//     pub ep0in: EPR,
//     pub __: EPR,
//     // logical non-control endpoints (four)
//     pub eps: [EP; 4],
// }


pub mod epr {
    use super::UsbSpeed;
    use crate::typestates::init_state;
    use crate::traits::usb::Usb;

    struct NbytesField {
        mask: u32,
        offset: u32,
    }
    struct AddrOffField{
        mask: u32,
        offset: u32,
    }

    impl From<UsbSpeed> for NbytesField {
        fn from(speed: UsbSpeed) -> Self {
            match speed {
                UsbSpeed::FullSpeed => {
                    const MASK: u32 = (1 << 10) - 1;
                    const OFFSET: u32 = 16;
                    NbytesField {mask: MASK, offset: OFFSET}
                }
                UsbSpeed::HighSpeed => {
                    const MASK: u32 = (1 << 15) - 1;
                    const OFFSET: u32 = 11;
                    NbytesField {mask: MASK, offset: OFFSET}
                }
            }
        }
    }

    impl From<UsbSpeed> for AddrOffField {
        fn from(speed: UsbSpeed) -> Self {
            match speed {
                UsbSpeed::FullSpeed => {
                    const MASK: u32 = 0xffff;
                    const OFFSET: u32 = 0;
                    AddrOffField {mask: MASK, offset: OFFSET}
                }
                UsbSpeed::HighSpeed => {
                    const MASK: u32 = (1 << 11) - 1;
                    const OFFSET: u32 = 0;
                    AddrOffField {mask: MASK, offset: OFFSET}
                }
            }
        }
    }

    impl super::EPR {
        pub fn modify<F>(&self, f: F) where
            for<'w> F: FnOnce(&R, &'w mut W) -> &'w mut W
        {
            let bits = self.register.get();
            let r = R { bits };
            let mut w = W { bits };
            f(&r, &mut w);
            self.register.set(w.bits);
        }

        pub fn read(&self) -> R {
            R {
                bits: self.register.get(),
            }
        }

        pub fn write<F>(&self, f: F) where
            F: FnOnce(&mut W) -> &mut W,
        {
            let mut w = W::reset_value();
            f(&mut w);
            self.register.set(w.bits);
        }

        pub fn reset(&self) {
            self.write(|w| w)
        }
    }

    pub struct R {
        bits: u32,
    }
    pub struct W {
        bits: u32,
    }

    pub struct ADDROFFR {
        bits: u16,
    }
    impl ADDROFFR {
        #[inline]
        pub fn bits(&self) -> u16 {
            self.bits
        }
    }

    pub struct _ADDROFFW<'a> {
        w: &'a mut W,
        field: AddrOffField,
    }
    impl<'a> _ADDROFFW<'a> {
        #[inline]
        pub fn bits(self, value: u16) -> &'a mut W {
            self.w.bits &= !((self.field.mask) << self.field.offset);
            self.w.bits |= ((value as u32) & self.field.mask ) << self.field.offset;
            self.w
        }
    }

    pub struct NBYTESR {
        bits: u16,
    }
    impl NBYTESR {
        #[inline]
        pub fn bits(&self) -> u16 {
            self.bits
        }
    }

    pub struct _NBYTESW<'a> {
        w: &'a mut W,
        field: NbytesField,
    }
    impl<'a> _NBYTESW<'a> {
        #[inline]
        pub fn bits(self, value: u16) -> &'a mut W {
            self.w.bits &= !((self.field.mask) << self.field.offset);
            self.w.bits |= ((value as u32) & self.field.mask ) << self.field.offset;
            self.w
        }
    }

    #[derive(Clone, Copy, Debug, PartialEq)]
    pub enum TR {
        #[doc = "Generic endpoint (bulk or interrupt)"]
        GENERIC,
        #[doc = "Isochronous endpoint"]
        ISOCHRONOUS,
    }
    impl TR {
        #[doc = "Value of the field as raw bits"]
        #[inline]
        pub fn bits(&self) -> u8 {
            match *self {
                TR::GENERIC => 0,
                TR::ISOCHRONOUS => 1,
            }
        }
        #[allow(missing_docs)]
        #[doc(hidden)]
        #[inline]
        pub fn _from(value: bool) -> TR {
            match value {
                false => TR::GENERIC,
                true => TR::ISOCHRONOUS,
            }
        }
        pub fn is_generic(&self) -> bool {
            *self == TR::GENERIC
        }
        pub fn is_isochronous(&self) -> bool {
            *self == TR::ISOCHRONOUS
        }
    }

    pub enum TW {
        #[doc = "Generic endpoint (bulk or interrupt)"]
        GENERIC,
        #[doc = "Isochronous endpoint"]
        ISOCHRONOUS,
    }
    impl TW {
        #[allow(missing_docs)]
        #[doc(hidden)]
        #[inline]
        pub fn _bit(&self) -> bool {
            match *self {
                TW::GENERIC => false,
                TW::ISOCHRONOUS => true,
            }
        }
    }

    pub struct _TW<'a> {
        w: &'a mut W,
    }
    impl<'a> _TW<'a> {
        #[inline]
        pub fn variant(self, variant: TW) -> &'a mut W {
            self.bit(variant._bit())
        }
        #[inline]
        pub fn generic(self) -> &'a mut W {
            self.variant(TW::GENERIC)
        }
        #[inline]
        pub fn isochronous(self) -> &'a mut W {
            self.variant(TW::ISOCHRONOUS)
        }
        #[inline]
        pub fn bit(self, value: bool) -> &'a mut W {
            const MASK: bool = true;
            const OFFSET: u8 = 26;
            self.w.bits &= !((MASK as u32) << OFFSET);
            self.w.bits |= ((value & MASK) as u32) << OFFSET;
            self.w
        }
    }

    #[derive(Clone, Copy, Debug, PartialEq)]
    pub enum SR {
        NotStalled,
        Stalled,
    }
    impl SR {
        #[inline]
        pub fn bits(&self) -> u8 {
            match *self {
                SR::NotStalled => 0,
                SR::Stalled => 1,
            }
        }
        #[allow(missing_docs)]
        #[doc(hidden)]
        #[inline]
        pub fn _from(value: bool) -> SR {
            match value {
                false => SR::NotStalled,
                true => SR::Stalled,
            }
        }
        pub fn is_not_stalled(&self) -> bool {
            *self == SR::NotStalled
        }
        pub fn is_stalled(&self) -> bool {
            *self == SR::Stalled
        }
    }

    pub enum SW {
        NotStalled,
        Stalled,
    }
    impl SW {
        #[allow(missing_docs)]
        #[doc(hidden)]
        #[inline]
        pub fn _bit(&self) -> bool {
            match *self {
                SW::NotStalled => false,
                SW::Stalled => true,
            }
        }
    }

    pub struct _SW<'a> {
        w: &'a mut W,
    }
    impl<'a> _SW<'a> {
        #[inline]
        pub fn variant(self, variant: SW) -> &'a mut W {
            self.bit(variant._bit())
        }
        #[inline]
        pub fn not_stalled(self) -> &'a mut W {
            self.variant(SW::NotStalled)
        }
        #[inline]
        pub fn stalled(self) -> &'a mut W {
            self.variant(SW::Stalled)
        }
        #[inline]
        pub fn bit(self, value: bool) -> &'a mut W {
            const MASK: bool = true;
            const OFFSET: u8 = 29;
            self.w.bits &= !((MASK as u32) << OFFSET);
            self.w.bits |= ((value & MASK) as u32) << OFFSET;
            self.w
        }
    }

    #[derive(Clone, Copy, Debug, PartialEq)]
    pub enum DR {
        ENABLED,
        DISABLED,
    }
    impl DR {
        #[inline]
        pub fn bits(&self) -> u8 {
            match *self {
                DR::ENABLED => 0,
                DR::DISABLED => 1,
            }
        }
        #[allow(missing_docs)]
        #[doc(hidden)]
        #[inline]
        pub fn _from(value: bool) -> DR {
            match value {
                false => DR::ENABLED,
                true => DR::DISABLED,
            }
        }
        pub fn is_enabled(&self) -> bool {
            *self == DR::ENABLED
        }
        pub fn is_disabled(&self) -> bool {
            *self == DR::DISABLED
        }
    }

    pub enum DW {
        ENABLED,
        DISABLED,
    }
    impl DW {
        #[allow(missing_docs)]
        #[doc(hidden)]
        #[inline]
        pub fn _bit(&self) -> bool {
            match *self {
                DW::ENABLED => false,
                DW::DISABLED => true,
            }
        }
    }

    pub struct _DW<'a> {
        w: &'a mut W,
    }
    impl<'a> _DW<'a> {
        #[inline]
        pub fn variant(self, variant: DW) -> &'a mut W {
            self.bit(variant._bit())
        }
        #[inline]
        pub fn enabled(self) -> &'a mut W {
            self.variant(DW::ENABLED)
        }
        #[inline]
        pub fn disabled(self) -> &'a mut W {
            self.variant(DW::DISABLED)
        }
        #[inline]
        pub fn bit(self, value: bool) -> &'a mut W {
            const MASK: bool = true;
            const OFFSET: u8 = 30;
            self.w.bits &= !((MASK as u32) << OFFSET);
            self.w.bits |= ((value & MASK) as u32) << OFFSET;
            self.w
        }
    }

    #[derive(Clone, Copy, Debug, PartialEq)]
    pub enum AR {
        NotActive,
        Active,
    }
    impl AR {
        #[inline]
        pub fn bits(&self) -> u8 {
            match *self {
                AR::NotActive => 0,
                AR::Active => 1,
            }
        }
        #[allow(missing_docs)]
        #[doc(hidden)]
        #[inline]
        pub fn _from(value: bool) -> AR {
            match value {
                false => AR::NotActive,
                true => AR::Active,
            }
        }
        pub fn is_not_active(&self) -> bool {
            *self == AR::NotActive
        }
        pub fn is_active(&self) -> bool {
            *self == AR::Active
        }
    }

    pub enum AW {
        NotActive,
        Active,
    }
    impl AW {
        #[allow(missing_docs)]
        #[doc(hidden)]
        #[inline]
        pub fn _bit(&self) -> bool {
            match *self {
                AW::NotActive => false,
                AW::Active => true,
            }
        }
    }

    pub struct _AW<'a> {
        w: &'a mut W,
    }
    impl<'a> _AW<'a> {
        #[inline]
        pub fn variant(self, variant: AW) -> &'a mut W {
            self.bit(variant._bit())
        }
        #[inline]
        pub fn not_active(self) -> &'a mut W {
            self.variant(AW::NotActive)
        }
        #[inline]
        pub fn active(self) -> &'a mut W {
            self.variant(AW::Active)
        }
        #[inline]
        pub fn bit(self, value: bool) -> &'a mut W {
            const MASK: bool = true;
            const OFFSET: u8 = 31;
            self.w.bits &= !((MASK as u32) << OFFSET);
            self.w.bits |= ((value & MASK) as u32) << OFFSET;
            self.w
        }
    }

    // pub struct SR {
    //     bits: bool,
    // }
    // impl SR {
    //     #[inline]
    //     pub fn bit(&self) -> bool {
    //         self.bits
    //     }
    //     #[inline]
    //     pub fn bit_is_clear(&self) -> bool {
    //         !self.bit()
    //     }
    //     #[inline]
    //     pub fn bit_is_set(&self) -> bool {
    //         self.bit()
    //     }
    // }

    // pub struct _SW<'a> {
    //     w: &'a mut W,
    // }
    // impl<'a> _SW<'a> {
    //     #[inline]
    //     pub fn set_bit(self) -> &'a mut W {
    //         self.bit(true)
    //     }
    //     #[inline]
    //     pub fn clear_bit(self) -> &'a mut W {
    //         self.bit(false)
    //     }
    //     #[inline]
    //     pub fn bit(self, value: bool) -> &'a mut W {
    //         const MASK: bool = true;
    //         const OFFSET: u8 = 29;
    //         self.w.bits &= !((MASK as u32) << OFFSET);
    //         self.w.bits |= ((value & MASK) as u32) << OFFSET;
    //         self.w
    //     }
    // }

    impl R {
        #[doc = r"Value of the register as raw bits"]
        #[inline]
        pub fn bits(&self) -> u32 {
            self.bits
        }
        #[doc = "Bits 0:15 - Endpoint buffer address offset for full speed, or bits 0:10 for high speed"]
        #[inline]
        pub fn addroff<USB: Usb<init_state::Enabled>>(&self) -> ADDROFFR {
            let field = AddrOffField::from(USB::SPEED);
            ADDROFFR { bits: ((self.bits >> field.offset) & field.mask as u32) as u16 }
        }
        #[doc = "Bits 16:25 - Endpoint buffer NBytes while in full speed operation, or bits 11:25 for high speed operation."]
        #[inline]
        pub fn nbytes<USB: Usb<init_state::Enabled>>(&self) -> NBYTESR {
            let field = NbytesField::from(USB::SPEED);
            NBYTESR { bits: ((self.bits >> field.offset) & field.mask as u32) as u16 }
        }
        #[doc = "Bit 26 - Endpoint type"]
        #[inline]
        pub fn t(&self) -> TR {
            TR::_from({
                const MASK: bool = true;
                const OFFSET: u8 = 26;
                ((self.bits >> OFFSET) & MASK as u32) != 0
            })
        }
        // #[doc = "Bit 27 - Rate Feedback mode / Toggle Value"]
        // #[inline]
        // pub fn rftv(&self) -> RFTVR {
        //     let bits = {
        //         const MASK: u8 = true;
        //         const OFFSET: u8 = 27;
        //         ((self.bits >> OFFSET) & MASK as u32) != 0
        //     };
        //     RFTVR { bits }
        // }
        // #[doc = "Bit 28 - Toggle reset"]
        // #[inline]
        // pub fn tr(&self) -> TRR {
        //     let bits = {
        //         const MASK: u8 = true;
        //         const OFFSET: u8 = 28;
        //         ((self.bits >> OFFSET) & MASK as u32) != 0
        //     };
        //     TRR { bits }
        // }
        #[doc = "Bit 29 - Stall"]
        #[inline]
        pub fn s(&self) -> SR {
            SR::_from({
                const MASK: bool = true;
                const OFFSET: u8 = 29;
                ((self.bits >> OFFSET) & MASK as u32) != 0
            })
        }
        #[doc = "Bit 30 - Disabled"]
        #[inline]
        pub fn d(&self) -> DR {
            DR::_from({
                const MASK: bool = true;
                const OFFSET: u8 = 30;
                ((self.bits >> OFFSET) & MASK as u32) != 0
            })
        }
        #[doc = "Bit 31 - Active"]
        #[inline]
        pub fn a(&self) -> AR {
            AR::_from({
                const MASK: bool = true;
                const OFFSET: u8 = 31;
                ((self.bits >> OFFSET) & MASK as u32) != 0
            })
        }
    }

    impl W {
        #[doc = r"Reset value of the register"]
        #[inline]
        pub fn reset_value() -> W {
            W { bits: 1 << 30 }
        }
        #[doc = r"Writes raw bits to the register"]
        #[inline]
        pub unsafe fn bits(&mut self, bits: u32) -> &mut Self {
            self.bits = bits;
            self
        }
        #[doc = "Bits 0:15 - Endpoint buffer address offset for full speed, or bits 0:10 for high speed"]
        #[inline]
        pub fn addroff<USB: Usb<init_state::Enabled>>(&mut self) -> _ADDROFFW {
            _ADDROFFW {
                w: self,
                field: AddrOffField::from(USB::SPEED),
            }
        }
        #[doc = "Bits 16:25 - Endpoint buffer NBytes for full speed, or bits 25:11 for high speed"]
        #[inline]
        pub fn nbytes<USB: Usb<init_state::Enabled>>(&mut self) -> _NBYTESW {
            _NBYTESW {
                w: self,
                field: NbytesField::from(USB::SPEED),
            }
        }
        #[doc = "Bit 26 - Endpoint type"]
        #[inline]
        pub fn t(&mut self) -> _TW {
            _TW { w: self }
        }
        // #[doc = "Bit 27 - Rate Feedback mode / Toggle Value"]
        // #[inline]
        // pub fn rftv(&self) -> _RFTVW {
        //     _RFTVW { w: self }
        // }
        // #[doc = "Bit 28 - Toggle reset"]
        // #[inline]
        // pub fn tr(&self) -> _TRW {
        //     _TRW { w: self }
        // }
        #[doc = "Bit 29 - Stall"]
        #[inline]
        pub fn s(&mut self) -> _SW {
            _SW { w: self }
        }
        #[doc = "Bit 30 - Disabled"]
        #[inline]
        pub fn d(&mut self) -> _DW {
            _DW { w: self }
        }
        #[doc = "Bit 31 - Active"]
        #[inline]
        pub fn a(&mut self) -> _AW {
            _AW { w: self }
        }
    }
}