Merge pull request #102 from stm32-rs/pac-instead-of-stm32

therealprof · web-flow · commit 0907de090dcd · 2020-04-04T21:55:19.000+02:00
Soft-deprecate `stm32` for PAC access and use `pac` instead
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+### Changed
+
+- Use `pac` instead of `stm32` for PAC access and soft-deprecate the former
+
 ### Added
 
 - Another example resembling a stop watch controlled via serial interface
diff --git a/examples/adc_values.rs b/examples/adc_values.rs
@@ -5,7 +5,7 @@ use panic_halt as _;
 
 use stm32f0xx_hal as hal;
 
-use crate::hal::{prelude::*, stm32};
+use crate::hal::{prelude::*, pac};
 
 use cortex_m::{interrupt::Mutex, peripheral::syst::SystClkSource::Core};
 use cortex_m_rt::{entry, exception};
@@ -14,15 +14,15 @@ use core::{cell::RefCell, fmt::Write};
 
 struct Shared {
     adc: hal::adc::Adc,
-    tx: hal::serial::Tx<stm32::USART1>,
+    tx: hal::serial::Tx<pac::USART1>,
 }
 
 static SHARED: Mutex<RefCell<Option<Shared>>> = Mutex::new(RefCell::new(None));
 
 #[entry]
 fn main() -> ! {
     if let (Some(p), Some(cp)) = (
-        hal::stm32::Peripherals::take(),
+        hal::pac::Peripherals::take(),
         cortex_m::peripheral::Peripherals::take(),
     ) {
         cortex_m::interrupt::free(move |cs| {
diff --git a/examples/blinky.rs b/examples/blinky.rs
@@ -5,13 +5,13 @@ use panic_halt as _;
 
 use stm32f0xx_hal as hal;
 
-use crate::hal::{prelude::*, stm32};
+use crate::hal::{prelude::*, pac};
 
 use cortex_m_rt::entry;
 
 #[entry]
 fn main() -> ! {
-    if let Some(mut p) = stm32::Peripherals::take() {
+    if let Some(mut p) = pac::Peripherals::take() {
         let mut led = cortex_m::interrupt::free(|cs| {
             let mut rcc = p.RCC.configure().sysclk(8.mhz()).freeze(&mut p.FLASH);
 
diff --git a/examples/blinky_adc.rs b/examples/blinky_adc.rs
@@ -5,14 +5,14 @@ use panic_halt as _;
 
 use stm32f0xx_hal as hal;
 
-use crate::hal::{adc::Adc, delay::Delay, prelude::*, stm32};
+use crate::hal::{adc::Adc, delay::Delay, prelude::*, pac};
 
 use cortex_m::peripheral::Peripherals;
 use cortex_m_rt::entry;
 
 #[entry]
 fn main() -> ! {
-    if let (Some(mut p), Some(cp)) = (stm32::Peripherals::take(), Peripherals::take()) {
+    if let (Some(mut p), Some(cp)) = (pac::Peripherals::take(), Peripherals::take()) {
         cortex_m::interrupt::free(move |cs| {
             let mut rcc = p.RCC.configure().sysclk(8.mhz()).freeze(&mut p.FLASH);
 
diff --git a/examples/blinky_delay.rs b/examples/blinky_delay.rs
@@ -5,14 +5,14 @@ use panic_halt as _;
 
 use stm32f0xx_hal as hal;
 
-use crate::hal::{delay::Delay, prelude::*, stm32};
+use crate::hal::{delay::Delay, prelude::*, pac};
 
 use cortex_m::peripheral::Peripherals;
 use cortex_m_rt::entry;
 
 #[entry]
 fn main() -> ! {
-    if let (Some(mut p), Some(cp)) = (stm32::Peripherals::take(), Peripherals::take()) {
+    if let (Some(mut p), Some(cp)) = (pac::Peripherals::take(), Peripherals::take()) {
         cortex_m::interrupt::free(move |cs| {
             let mut rcc = p.RCC.configure().sysclk(8.mhz()).freeze(&mut p.FLASH);
 
diff --git a/examples/blinky_multiple.rs b/examples/blinky_multiple.rs
@@ -5,14 +5,14 @@ use panic_halt as _;
 
 use stm32f0xx_hal as hal;
 
-use crate::hal::{delay::Delay, prelude::*, stm32};
+use crate::hal::{delay::Delay, prelude::*, pac};
 
 use cortex_m::peripheral::Peripherals;
 use cortex_m_rt::entry;
 
 #[entry]
 fn main() -> ! {
-    if let (Some(mut p), Some(cp)) = (stm32::Peripherals::take(), Peripherals::take()) {
+    if let (Some(mut p), Some(cp)) = (pac::Peripherals::take(), Peripherals::take()) {
         cortex_m::interrupt::free(move |cs| {
             let mut rcc = p.RCC.configure().sysclk(8.mhz()).freeze(&mut p.FLASH);
 
diff --git a/examples/blinky_timer.rs b/examples/blinky_timer.rs
@@ -5,13 +5,13 @@ use panic_halt as _;
 
 use stm32f0xx_hal as hal;
 
-use crate::hal::{prelude::*, stm32, time::Hertz, timers::*};
+use crate::hal::{prelude::*, pac, time::Hertz, timers::*};
 
 use cortex_m_rt::entry;
 
 #[entry]
 fn main() -> ! {
-    if let Some(mut p) = stm32::Peripherals::take() {
+    if let Some(mut p) = pac::Peripherals::take() {
         cortex_m::interrupt::free(move |cs| {
             let mut rcc = p.RCC.configure().sysclk(8.mhz()).freeze(&mut p.FLASH);
 
diff --git a/examples/blinky_timer_irq.rs b/examples/blinky_timer_irq.rs
@@ -7,8 +7,8 @@ use stm32f0xx_hal as hal;
 
 use crate::hal::{
     gpio::*,
+    pac::{interrupt, Interrupt, Peripherals, TIM7},
     prelude::*,
-    stm32::{interrupt, Interrupt, Peripherals, TIM7},
     time::Hertz,
     timers::*,
 };
diff --git a/examples/dac.rs b/examples/dac.rs
@@ -9,8 +9,8 @@ use panic_halt as _;
 use stm32f0xx_hal as hal;
 
 use crate::hal::dac::*;
+use crate::hal::pac;
 use crate::hal::prelude::*;
-use crate::hal::stm32;
 
 use rt::entry;
 
@@ -21,7 +21,7 @@ enum Direction {
 
 #[entry]
 fn main() -> ! {
-    if let (Some(mut dp), Some(_cp)) = (stm32::Peripherals::take(), cortex_m::Peripherals::take()) {
+    if let (Some(mut dp), Some(_cp)) = (pac::Peripherals::take(), cortex_m::Peripherals::take()) {
         cortex_m::interrupt::free(move |cs| {
             let mut rcc = dp.RCC.configure().sysclk(8.mhz()).freeze(&mut dp.FLASH);
 
diff --git a/examples/flash_systick.rs b/examples/flash_systick.rs
@@ -5,7 +5,7 @@ use panic_halt as _;
 
 use stm32f0xx_hal as hal;
 
-use crate::hal::{gpio::*, prelude::*, stm32};
+use crate::hal::{gpio::*, prelude::*, pac};
 
 use cortex_m::{interrupt::Mutex, peripheral::syst::SystClkSource::Core, Peripherals};
 use cortex_m_rt::{entry, exception};
@@ -18,7 +18,7 @@ static GPIO: Mutex<RefCell<Option<gpioa::PA1<Output<PushPull>>>>> = Mutex::new(R
 
 #[entry]
 fn main() -> ! {
-    if let (Some(mut p), Some(cp)) = (stm32::Peripherals::take(), Peripherals::take()) {
+    if let (Some(mut p), Some(cp)) = (pac::Peripherals::take(), Peripherals::take()) {
         cortex_m::interrupt::free(move |cs| {
             let mut rcc = p.RCC.configure().sysclk(48.mhz()).freeze(&mut p.FLASH);
 
diff --git a/examples/flash_systick_fancier.rs b/examples/flash_systick_fancier.rs
@@ -5,7 +5,7 @@ use panic_halt as _;
 
 use stm32f0xx_hal as hal;
 
-use crate::hal::{gpio::*, prelude::*, stm32};
+use crate::hal::{gpio::*, prelude::*, pac};
 
 use cortex_m::{interrupt::Mutex, peripheral::syst::SystClkSource::Core, Peripherals};
 use cortex_m_rt::{entry, exception};
@@ -21,7 +21,7 @@ static GPIO: Mutex<RefCell<Option<LEDPIN>>> = Mutex::new(RefCell::new(None));
 
 #[entry]
 fn main() -> ! {
-    if let (Some(mut p), Some(cp)) = (stm32::Peripherals::take(), Peripherals::take()) {
+    if let (Some(mut p), Some(cp)) = (pac::Peripherals::take(), Peripherals::take()) {
         cortex_m::interrupt::free(move |cs| {
             let mut rcc = p.RCC.configure().sysclk(48.mhz()).freeze(&mut p.FLASH);
 
diff --git a/examples/i2c_find_address.rs b/examples/i2c_find_address.rs
@@ -5,15 +5,15 @@ use panic_halt as _;
 
 use stm32f0xx_hal as hal;
 
-use crate::hal::{i2c::I2c, prelude::*, stm32};
+use crate::hal::{i2c::I2c, prelude::*, pac};
 
 use cortex_m_rt::entry;
 
 /* Example meant for stm32f030xc MCUs with i2c devices connected on PB7 and PB8 */
 
 #[entry]
 fn main() -> ! {
-    if let Some(p) = stm32::Peripherals::take() {
+    if let Some(p) = pac::Peripherals::take() {
         cortex_m::interrupt::free(move |cs| {
             let mut flash = p.FLASH;
             let mut rcc = p.RCC.configure().freeze(&mut flash);
diff --git a/examples/led_hal_button_irq.rs b/examples/led_hal_button_irq.rs
@@ -8,8 +8,8 @@ use stm32f0xx_hal as hal;
 use crate::hal::{
     delay::Delay,
     gpio::*,
+    pac::{interrupt, Interrupt, Peripherals, EXTI},
     prelude::*,
-    stm32::{interrupt, Interrupt, Peripherals, EXTI},
 };
 
 use cortex_m::{interrupt::Mutex, peripheral::Peripherals as c_m_Peripherals};
diff --git a/examples/serial_echo.rs b/examples/serial_echo.rs
@@ -5,13 +5,13 @@ use panic_halt as _;
 
 use stm32f0xx_hal as hal;
 
-use crate::hal::{prelude::*, serial::Serial, stm32};
+use crate::hal::{prelude::*, serial::Serial, pac};
 
 use cortex_m_rt::entry;
 
 #[entry]
 fn main() -> ! {
-    if let Some(p) = stm32::Peripherals::take() {
+    if let Some(p) = pac::Peripherals::take() {
         cortex_m::interrupt::free(move |cs| {
             let mut flash = p.FLASH;
             let mut rcc = p.RCC.configure().sysclk(48.mhz()).freeze(&mut flash);
diff --git a/examples/serial_spi_bridge.rs b/examples/serial_spi_bridge.rs
@@ -10,7 +10,7 @@ use crate::hal::{
     serial::Serial,
     spi::Spi,
     spi::{Mode, Phase, Polarity},
-    stm32,
+    pac,
 };
 
 use nb::block;
@@ -30,7 +30,7 @@ fn main() -> ! {
         phase: Phase::CaptureOnSecondTransition,
     };
 
-    if let Some(p) = stm32::Peripherals::take() {
+    if let Some(p) = pac::Peripherals::take() {
         cortex_m::interrupt::free(move |cs| {
             let mut flash = p.FLASH;
             let mut rcc = p.RCC.configure().freeze(&mut flash);
diff --git a/examples/serial_stopwatch.rs b/examples/serial_stopwatch.rs
@@ -6,9 +6,9 @@ use panic_halt as _;
 use stm32f0xx_hal as hal;
 
 use crate::hal::{
+    pac::{interrupt, Interrupt, Peripherals, TIM7},
     prelude::*,
     serial::Serial,
-    stm32::{interrupt, Interrupt, Peripherals, TIM7},
     timers::{Event, Timer},
 };
 use core::cell::RefCell;
diff --git a/examples/spi_hal_apa102c.rs b/examples/spi_hal_apa102c.rs
@@ -9,7 +9,7 @@ use crate::hal::{
     prelude::*,
     spi::Spi,
     spi::{Mode, Phase, Polarity},
-    stm32,
+    pac,
 };
 
 use cortex_m_rt::entry;
@@ -21,7 +21,7 @@ fn main() -> ! {
         phase: Phase::CaptureOnSecondTransition,
     };
 
-    if let Some(p) = stm32::Peripherals::take() {
+    if let Some(p) = pac::Peripherals::take() {
         cortex_m::interrupt::free(move |cs| {
             let mut flash = p.FLASH;
             let mut rcc = p.RCC.configure().freeze(&mut flash);
diff --git a/examples/usb_serial.rs b/examples/usb_serial.rs
@@ -7,13 +7,13 @@ extern crate panic_halt;
 
 use cortex_m_rt::entry;
 use stm32f0xx_hal::usb::{Peripheral, UsbBus};
-use stm32f0xx_hal::{prelude::*, stm32};
+use stm32f0xx_hal::{prelude::*, pac};
 use usb_device::prelude::*;
 use usbd_serial::{SerialPort, USB_CLASS_CDC};
 
 #[entry]
 fn main() -> ! {
-    let mut dp = stm32::Peripherals::take().unwrap();
+    let mut dp = pac::Peripherals::take().unwrap();
 
     /* Uncomment the following lines if you have a chip in TSSOP20 (STM32F042F)
        or UFQFPN28 (STM32F042G) package
diff --git a/examples/watchdog.rs b/examples/watchdog.rs
@@ -6,7 +6,7 @@ use panic_halt as _;
 use stm32f0xx_hal as hal;
 
 use crate::hal::{
-    delay::Delay, prelude::*, serial::Serial, stm32, time::Hertz, watchdog::Watchdog,
+    delay::Delay, prelude::*, serial::Serial, pac, time::Hertz, watchdog::Watchdog,
 };
 
 use cortex_m::peripheral::Peripherals;
@@ -16,7 +16,7 @@ use core::fmt::Write;
 
 #[entry]
 fn main() -> ! {
-    if let (Some(p), Some(cp)) = (stm32::Peripherals::take(), Peripherals::take()) {
+    if let (Some(p), Some(cp)) = (pac::Peripherals::take(), Peripherals::take()) {
         cortex_m::interrupt::free(move |cs| {
             let mut flash = p.FLASH;
             let mut rcc = p.RCC.configure().sysclk(8.mhz()).freeze(&mut flash);
diff --git a/src/adc.rs b/src/adc.rs
@@ -8,12 +8,12 @@
 //! ``` no_run
 //! use stm32f0xx_hal as hal;
 //!
-//! use crate::hal::stm32;
+//! use crate::hal::pac;
 //! use crate::hal::prelude::*;
 //! use crate::hal::adc::Adc;
 //!
 //! cortex_m::interrupt::free(|cs| {
-//!     let mut p = stm32::Peripherals::take().unwrap();
+//!     let mut p = pac::Peripherals::take().unwrap();
 //!     let mut rcc = p.RCC.configure().freeze(&mut p.FLASH);
 //!
 //!     let gpioa = p.GPIOA.split(&mut rcc);
@@ -52,14 +52,14 @@ use embedded_hal::{
 use crate::{
     delay::Delay,
     gpio::*,
-    rcc::Rcc,
-    stm32::{
+    pac::{
         adc::{
             cfgr1::{ALIGN_A, RES_A},
             smpr::SMP_A,
         },
         ADC,
     },
+    rcc::Rcc,
 };
 
 /// Analog to Digital converter interface
diff --git a/src/dac.rs b/src/dac.rs
@@ -15,7 +15,7 @@
 //!
 //!use stm32f0xx_hal as hal;
 //!
-//!use crate::hal::stm32;
+//!use crate::hal::pac;
 //!use crate::hal::prelude::*;
 //!use crate::hal::dac::*;
 //!
@@ -28,7 +28,7 @@
 //!
 //!#[entry]
 //!fn main() -> ! {
-//!    if let (Some(mut dp), Some(_cp)) = (stm32::Peripherals::take(), cortex_m::Peripherals::take()) {
+//!    if let (Some(mut dp), Some(_cp)) = (pac::Peripherals::take(), cortex_m::Peripherals::take()) {
 //!        cortex_m::interrupt::free(move |cs| {
 //!            let mut rcc = dp.RCC.configure().sysclk(8.mhz()).freeze(&mut dp.FLASH);
 //!
@@ -72,8 +72,8 @@ use core::mem;
 
 use crate::gpio::gpioa::{PA4, PA5};
 use crate::gpio::Analog;
+use crate::pac::DAC;
 use crate::rcc::Rcc;
-use crate::stm32::DAC;
 
 pub struct C1;
 pub struct C2;
diff --git a/src/delay.rs b/src/delay.rs
@@ -10,12 +10,12 @@
 //! ``` no_run
 //! use stm32f0xx_hal as hal;
 //!
-//! use crate::hal::stm32;
+//! use crate::hal::pac;
 //! use crate::hal::prelude::*;
 //! use crate::hal::delay::Delay;
 //! use cortex_m::peripheral::Peripherals;
 //!
-//! let mut p = stm32::Peripherals::take().unwrap();
+//! let mut p = pac::Peripherals::take().unwrap();
 //! let mut cp = cortex_m::Peripherals::take().unwrap();
 //!
 //! let mut rcc = p.RCC.configure().freeze(&mut p.FLASH);
diff --git a/src/gpio.rs b/src/gpio.rs
diff --git a/src/i2c.rs b/src/i2c.rs
diff --git a/src/lib.rs b/src/lib.rs
diff --git a/src/rcc.rs b/src/rcc.rs
diff --git a/src/serial.rs b/src/serial.rs
diff --git a/src/spi.rs b/src/spi.rs
diff --git a/src/timers.rs b/src/timers.rs
diff --git a/src/tsc.rs b/src/tsc.rs
diff --git a/src/usb.rs b/src/usb.rs
diff --git a/src/watchdog.rs b/src/watchdog.rs
