      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

    //! Core peripherals
    //!
    //! # API
    //!
    //! To use (most of) the peripheral API first you must get an *instance* of the peripheral. All the
    //! core peripherals are modeled as singletons (there can only ever be, at most, one instance of any
    //! one of them at any given point in time) and the only way to get an instance of them is through
    //! the [`Peripherals::take`](struct.Peripherals.html#method.take) method.
    //!
    //! ``` no_run
    //! extern crate cortex_m;
    //!
    //! use cortex_m::peripheral::Peripherals;
    //!
    //! fn main() {
    //!     let mut peripherals = Peripherals::take().unwrap();
    //!     peripherals.DWT.enable_cycle_counter();
    //! }
    //! ```
    //!
    //! This method can only be successfully called *once* -- this is why the method returns an
    //! `Option`. Subsequent calls to the method will result in a `None` value being returned.
    //!
    //! ``` no_run
    //! extern crate cortex_m;
    //!
    //! use cortex_m::peripheral::Peripherals;
    //!
    //! fn main() {
    //!     let ok = Peripherals::take().unwrap();
    //!     let panics = Peripherals::take().unwrap();
    //! }
    //! ```
    //! A part of the peripheral API doesn't require access to a peripheral instance. This part of the
    //! API is provided as static methods on the peripheral types. One example is the
    //! [`DWT::get_cycle_count`](struct.DWT.html#method.get_cycle_count) method.
    //!
    //! ``` no_run
    //! extern crate cortex_m;
    //!
    //! use cortex_m::peripheral::{DWT, Peripherals};
    //!
    //! fn main() {
    //!     {
    //!         let mut peripherals = Peripherals::take().unwrap();
    //!         peripherals.DWT.enable_cycle_counter();
    //!     } // all the peripheral singletons are destroyed here
    //!
    //!     // but this method can be called without a DWT instance
    //!     let cyccnt = DWT::get_cycle_count();
    //! }
    //! ```
    //!
    //! The singleton property can be *unsafely* bypassed using the `ptr` static method which is
    //! available on all the peripheral types. This method is a useful building block for implementing
    //! safe higher level abstractions.
    //!
    //! ``` no_run
    //! extern crate cortex_m;
    //!
    //! use cortex_m::peripheral::{DWT, Peripherals};
    //!
    //! fn main() {
    //!     {
    //!         let mut peripherals = Peripherals::take().unwrap();
    //!         peripherals.DWT.enable_cycle_counter();
    //!     } // all the peripheral singletons are destroyed here
    //!
    //!     // actually safe because this is an atomic read with no side effects
    //!     let cyccnt = unsafe { (*DWT::ptr()).cyccnt.read() };
    //! }
    //! ```
    //!
    //! # References
    //!
    //! - ARMv7-M Architecture Reference Manual (Issue E.b) - Chapter B3

    // TODO stand-alone registers: ICTR, ACTLR and STIR

    #![allow(private_no_mangle_statics)]

    use core::marker::PhantomData;
    use core::ops;

    use interrupt;

    #[cfg(not(armv6m))]
    pub mod cbp;
    pub mod cpuid;
    pub mod dcb;
    pub mod dwt;
    #[cfg(not(armv6m))]
    pub mod fpb;
    // NOTE(target_arch) is for documentation purposes
    #[cfg(any(has_fpu, target_arch = "x86_64"))]
    pub mod fpu;
    #[cfg(not(armv6m))]
    pub mod itm;
    pub mod mpu;
    pub mod nvic;
    pub mod scb;
    pub mod syst;
    #[cfg(not(armv6m))]
    pub mod tpiu;

    #[cfg(test)]
    mod test;

    // NOTE the `PhantomData` used in the peripherals proxy is to make them `Send` but *not* `Sync`

    /// Core peripherals
    #[allow(non_snake_case)]
    pub struct Peripherals {
        /// Cache and branch predictor maintenance operations (not present on Cortex-M0 variants)
        pub CBP: CBP,

        /// CPUID
        pub CPUID: CPUID,

        /// Debug Control Block
        pub DCB: DCB,

        /// Data Watchpoint and Trace unit
        pub DWT: DWT,

        /// Flash Patch and Breakpoint unit (not present on Cortex-M0 variants)
        pub FPB: FPB,

        /// Floating Point Unit (only present on `thumbv7em-none-eabihf`)
        pub FPU: FPU,

        /// Instrumentation Trace Macrocell (not present on Cortex-M0 variants)
        pub ITM: ITM,

        /// Memory Protection Unit
        pub MPU: MPU,

        /// Nested Vector Interrupt Controller
        pub NVIC: NVIC,

        /// System Control Block
        pub SCB: SCB,

        /// SysTick: System Timer
        pub SYST: SYST,

        /// Trace Port Interface Unit (not present on Cortex-M0 variants)
        pub TPIU: TPIU,
    }

    // NOTE `no_mangle` is used here to prevent linking different minor versions of this crate as that
    // would let you `take` the core peripherals more than once (one per minor version)
    #[no_mangle]
    static mut CORE_PERIPHERALS: bool = false;

    impl Peripherals {
        /// Returns all the core peripherals *once*
        #[inline]
        pub fn take() -> Option<Self> {
            interrupt::free(|_| {
                if unsafe { CORE_PERIPHERALS } {
                    None
                } else {
                    Some(unsafe { Peripherals::steal() })
                }
            })
        }

        /// Unchecked version of `Peripherals::take`
        pub unsafe fn steal() -> Self {
            debug_assert!(!CORE_PERIPHERALS);

            CORE_PERIPHERALS = true;

            Peripherals {
                CBP: CBP {
                    _marker: PhantomData,
                },
                CPUID: CPUID {
                    _marker: PhantomData,
                },
                DCB: DCB {
                    _marker: PhantomData,
                },
                DWT: DWT {
                    _marker: PhantomData,
                },
                FPB: FPB {
                    _marker: PhantomData,
                },
                FPU: FPU {
                    _marker: PhantomData,
                },
                ITM: ITM {
                    _marker: PhantomData,
                },
                MPU: MPU {
                    _marker: PhantomData,
                },
                NVIC: NVIC {
                    _marker: PhantomData,
                },
                SCB: SCB {
                    _marker: PhantomData,
                },
                SYST: SYST {
                    _marker: PhantomData,
                },
                TPIU: TPIU {
                    _marker: PhantomData,
                },
            }
        }
    }

    /// Cache and branch predictor maintenance operations
    pub struct CBP {
        _marker: PhantomData<*const ()>,
    }

    unsafe impl Send for CBP {}

    #[cfg(not(armv6m))]
    impl CBP {
        pub(crate) unsafe fn new() -> Self {
            CBP {
                _marker: PhantomData,
            }
        }

        /// Returns a pointer to the register block
        pub fn ptr() -> *const self::cbp::RegisterBlock {
            0xE000_EF50 as *const _
        }
    }

    #[cfg(not(armv6m))]
    impl ops::Deref for CBP {
        type Target = self::cbp::RegisterBlock;

        fn deref(&self) -> &Self::Target {
            unsafe { &*Self::ptr() }
        }
    }

    /// CPUID
    pub struct CPUID {
        _marker: PhantomData<*const ()>,
    }

    unsafe impl Send for CPUID {}

    impl CPUID {
        /// Returns a pointer to the register block
        pub fn ptr() -> *const self::cpuid::RegisterBlock {
            0xE000_ED00 as *const _
        }
    }

    impl ops::Deref for CPUID {
        type Target = self::cpuid::RegisterBlock;

        fn deref(&self) -> &Self::Target {
            unsafe { &*Self::ptr() }
        }
    }

    /// Debug Control Block
    pub struct DCB {
        _marker: PhantomData<*const ()>,
    }

    unsafe impl Send for DCB {}

    impl DCB {
        /// Returns a pointer to the register block
        pub fn ptr() -> *const dcb::RegisterBlock {
            0xE000_EDF0 as *const _
        }
    }

    impl ops::Deref for DCB {
        type Target = self::dcb::RegisterBlock;

        fn deref(&self) -> &Self::Target {
            unsafe { &*DCB::ptr() }
        }
    }

    /// Data Watchpoint and Trace unit
    pub struct DWT {
        _marker: PhantomData<*const ()>,
    }

    unsafe impl Send for DWT {}

    impl DWT {
        /// Returns a pointer to the register block
        pub fn ptr() -> *const dwt::RegisterBlock {
            0xE000_1000 as *const _
        }
    }

    impl ops::Deref for DWT {
        type Target = self::dwt::RegisterBlock;

        fn deref(&self) -> &Self::Target {
            unsafe { &*Self::ptr() }
        }
    }

    /// Flash Patch and Breakpoint unit
    pub struct FPB {
        _marker: PhantomData<*const ()>,
    }

    unsafe impl Send for FPB {}

    #[cfg(not(armv6m))]
    impl FPB {
        /// Returns a pointer to the register block
        pub fn ptr() -> *const fpb::RegisterBlock {
            0xE000_2000 as *const _
        }
    }

    #[cfg(not(armv6m))]
    impl ops::Deref for FPB {
        type Target = self::fpb::RegisterBlock;

        fn deref(&self) -> &Self::Target {
            unsafe { &*Self::ptr() }
        }
    }

    /// Floating Point Unit
    pub struct FPU {
        _marker: PhantomData<*const ()>,
    }

    unsafe impl Send for FPU {}

    #[cfg(any(has_fpu, target_arch = "x86_64"))]
    impl FPU {
        /// Returns a pointer to the register block
        pub fn ptr() -> *const fpu::RegisterBlock {
            0xE000_EF30 as *const _
        }
    }

    #[cfg(any(has_fpu, target_arch = "x86_64"))]
    impl ops::Deref for FPU {
        type Target = self::fpu::RegisterBlock;

        fn deref(&self) -> &Self::Target {
            unsafe { &*Self::ptr() }
        }
    }

    /// Instrumentation Trace Macrocell
    pub struct ITM {
        _marker: PhantomData<*const ()>,
    }

    unsafe impl Send for ITM {}

    #[cfg(not(armv6m))]
    impl ITM {
        /// Returns a pointer to the register block
        pub fn ptr() -> *mut itm::RegisterBlock {
            0xE000_0000 as *mut _
        }
    }

    #[cfg(not(armv6m))]
    impl ops::Deref for ITM {
        type Target = self::itm::RegisterBlock;

        fn deref(&self) -> &Self::Target {
            unsafe { &*Self::ptr() }
        }
    }

    #[cfg(not(armv6m))]
    impl ops::DerefMut for ITM {
        fn deref_mut(&mut self) -> &mut Self::Target {
            unsafe { &mut *Self::ptr() }
        }
    }

    /// Memory Protection Unit
    pub struct MPU {
        _marker: PhantomData<*const ()>,
    }

    unsafe impl Send for MPU {}

    impl MPU {
        /// Returns a pointer to the register block
        pub fn ptr() -> *const mpu::RegisterBlock {
            0xE000_ED90 as *const _
        }
    }

    impl ops::Deref for MPU {
        type Target = self::mpu::RegisterBlock;

        fn deref(&self) -> &Self::Target {
            unsafe { &*Self::ptr() }
        }
    }

    /// Nested Vector Interrupt Controller
    pub struct NVIC {
        _marker: PhantomData<*const ()>,
    }

    unsafe impl Send for NVIC {}

    impl NVIC {
        /// Returns a pointer to the register block
        pub fn ptr() -> *const nvic::RegisterBlock {
            0xE000_E100 as *const _
        }
    }

    impl ops::Deref for NVIC {
        type Target = self::nvic::RegisterBlock;

        fn deref(&self) -> &Self::Target {
            unsafe { &*Self::ptr() }
        }
    }

    /// System Control Block
    pub struct SCB {
        _marker: PhantomData<*const ()>,
    }

    unsafe impl Send for SCB {}

    impl SCB {
        /// Returns a pointer to the register block
        pub fn ptr() -> *const scb::RegisterBlock {
            0xE000_ED04 as *const _
        }
    }

    impl ops::Deref for SCB {
        type Target = self::scb::RegisterBlock;

        fn deref(&self) -> &Self::Target {
            unsafe { &*Self::ptr() }
        }
    }

    /// SysTick: System Timer
    pub struct SYST {
        _marker: PhantomData<*const ()>,
    }

    unsafe impl Send for SYST {}

    impl SYST {
        /// Returns a pointer to the register block
        pub fn ptr() -> *const syst::RegisterBlock {
            0xE000_E010 as *const _
        }
    }

    impl ops::Deref for SYST {
        type Target = self::syst::RegisterBlock;

        fn deref(&self) -> &Self::Target {
            unsafe { &*Self::ptr() }
        }
    }

    /// Trace Port Interface Unit
    pub struct TPIU {
        _marker: PhantomData<*const ()>,
    }

    unsafe impl Send for TPIU {}

    #[cfg(not(armv6m))]
    impl TPIU {
        /// Returns a pointer to the register block
        pub fn ptr() -> *const tpiu::RegisterBlock {
            0xE004_0000 as *const _
        }
    }

    #[cfg(not(armv6m))]
    impl ops::Deref for TPIU {
        type Target = self::tpiu::RegisterBlock;

        fn deref(&self) -> &Self::Target {
            unsafe { &*Self::ptr() }
        }
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)