Utilize LDREX/STREX in GPIO configure functions

Author: Piroro-hs

CHANGELOG.md

@@ -20,6 +20,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - `RccBus`, `Enable`, `Reset` traits and implementations for peripherals ([#299])
 - Support cortex-m-rt `v0.7.0` but still allow `v0.6.13` ([#283])
 - Make timer `InterruptTypes` fields public to be useful. ([#304])
+- Implement `into_xxx` methods for erased pins ([#213])
 
 ### Fixed
 
@@ -36,6 +37,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Update `stm32f3` pac to v0.14.0 ([#282])
 - Remove the `bxcan` re-export. ([#304])
 - The MSRV was bumped to 1.59 ([#213])
+- GPIO configuration functions no longer require registers as arguments ([#213])
 
 ## [v0.8.2] - 2021-12-14
 

README.md

@@ -120,11 +120,9 @@ fn main() -> ! {
       let dp = pac::Peripherals::take().unwrap();
 
       let mut rcc = dp.RCC.constrain();
-      let mut gpioe = dp.GPIOE.split(&mut rcc.ahb);
+      let gpioe = dp.GPIOE.split(&mut rcc.ahb);
 
-      let mut led = gpioe
-            .pe13
-            .into_push_pull_output(&mut gpioe.moder, &mut gpioe.otyper);
+      let mut led = gpioe.pe13.into_push_pull_output();
 
       loop {
             led.toggle().unwrap();

codegen/src/codegen/gpio.rs

@@ -131,12 +131,11 @@ fn get_port_pac_module(port: &Port, feature: &str) -> &'static str {
 fn gen_pin(pin: &gpio::Pin) -> Result<()> {
     let nr = pin.number()?;
     let reset_mode = get_pin_reset_mode(pin)?;
-    let afr = if nr < 8 { 'L' } else { 'H' };
     let af_numbers = get_pin_af_numbers(pin)?;
 
     println!(
-        "                {} => {{ reset: {}, afr: {}, af: {:?} }},",
-        nr, reset_mode, afr, af_numbers,
+        "                {} => {{ reset: {}, af: {:?} }},",
+        nr, reset_mode, af_numbers,
     );
 
     Ok(())

examples/adc.rs

@@ -32,8 +32,8 @@ fn main() -> ! {
 
     // Set up pin PA0 as analog pin.
     // This pin is connected to the user button on the stm32f3discovery board.
-    let mut gpioa = dp.GPIOA.split(&mut rcc.ahb);
-    let mut adc1_in1_pin = gpioa.pa0.into_analog(&mut gpioa.moder, &mut gpioa.pupdr);
+    let gpio_a = dp.GPIOA.split(&mut rcc.ahb);
+    let mut adc1_in1_pin = gpio_a.pa0.into_analog();
 
     // Be aware that the values in the table below depend on the input of VREF.
     // To have a stable VREF input, put a condensator and a volt limiting diode in front of it.

examples/can.rs

@@ -28,8 +28,8 @@ fn main() -> ! {
 
     let mut flash = dp.FLASH.constrain();
     let mut rcc = dp.RCC.constrain();
-    let mut gpiob = dp.GPIOB.split(&mut rcc.ahb);
-    let mut gpioa = dp.GPIOA.split(&mut rcc.ahb);
+    let gpiob = dp.GPIOB.split(&mut rcc.ahb);
+    let gpioa = dp.GPIOA.split(&mut rcc.ahb);
 
     let _clocks = rcc
         .cfgr
@@ -41,12 +41,8 @@ fn main() -> ! {
         .freeze(&mut flash.acr);
 
     // Configure CAN RX and TX pins (AF9)
-    let rx = gpioa
-        .pa11
-        .into_af9_push_pull(&mut gpioa.moder, &mut gpioa.otyper, &mut gpioa.afrh);
-    let tx = gpioa
-        .pa12
-        .into_af9_push_pull(&mut gpioa.moder, &mut gpioa.otyper, &mut gpioa.afrh);
+    let rx = gpioa.pa11.into_af9_push_pull();
+    let tx = gpioa.pa12.into_af9_push_pull();
 
     // Initialize the CAN peripheral
     let mut can = Can::new(dp.CAN, tx, rx, &mut rcc.apb1);
@@ -69,9 +65,7 @@ fn main() -> ! {
     // Sync to the bus and start normal operation.
     block!(can.enable()).ok();
 
-    let mut led0 = gpiob
-        .pb15
-        .into_push_pull_output(&mut gpiob.moder, &mut gpiob.otyper);
+    let mut led0 = gpiob.pb15.into_push_pull_output();
     led0.set_high().unwrap();
 
     // Watchdog makes sure this gets restarted periodically if nothing happens

examples/gpio_erased.rs

@@ -19,31 +19,15 @@ fn main() -> ! {
     let dp = pac::Peripherals::take().unwrap();
 
     let mut rcc = dp.RCC.constrain();
-    let mut gpiob = dp.GPIOB.split(&mut rcc.ahb);
-    let mut gpioc = dp.GPIOC.split(&mut rcc.ahb);
-    let mut gpiod = dp.GPIOD.split(&mut rcc.ahb);
+    let gpiob = dp.GPIOB.split(&mut rcc.ahb);
+    let gpioc = dp.GPIOC.split(&mut rcc.ahb);
+    let gpiod = dp.GPIOD.split(&mut rcc.ahb);
 
     let mut pin_array: [gpio::PXx<Input>; 4] = [
-        gpiob
-            .pb11
-            .into_floating_input(&mut gpiob.moder, &mut gpiob.pupdr)
-            .downgrade()
-            .downgrade(),
-        gpioc
-            .pc4
-            .into_floating_input(&mut gpioc.moder, &mut gpioc.pupdr)
-            .downgrade()
-            .downgrade(),
-        gpiod
-            .pd3
-            .into_floating_input(&mut gpiod.moder, &mut gpiod.pupdr)
-            .downgrade()
-            .downgrade(),
-        gpiod
-            .pd2
-            .into_floating_input(&mut gpiod.moder, &mut gpiod.pupdr)
-            .downgrade()
-            .downgrade(),
+        gpiob.pb11.into_floating_input().downgrade().downgrade(),
+        gpioc.pc4.into_floating_input().downgrade().downgrade(),
+        gpiod.pd3.into_floating_input().downgrade().downgrade(),
+        gpiod.pd2.into_floating_input().downgrade().downgrade(),
     ];
 
     hprintln!("Start scanning pin array").unwrap();

examples/gpio_interrupts.rs

@@ -28,22 +28,18 @@ fn main() -> ! {
     let mut rcc = device_peripherals.RCC.constrain();
     let mut syscfg = device_peripherals.SYSCFG.constrain(&mut rcc.apb2);
     let mut exti = device_peripherals.EXTI;
-    let mut gpioe = device_peripherals.GPIOE.split(&mut rcc.ahb);
-    let mut gpioa = device_peripherals.GPIOA.split(&mut rcc.ahb);
+    let gpioe = device_peripherals.GPIOE.split(&mut rcc.ahb);
+    let gpioa = device_peripherals.GPIOA.split(&mut rcc.ahb);
 
-    let mut led = gpioe
-        .pe9
-        .into_push_pull_output(&mut gpioe.moder, &mut gpioe.otyper);
+    let mut led = gpioe.pe9.into_push_pull_output();
     // Turn the led on so we know the configuration step occurred.
     led.toggle().expect("unable to toggle led in configuration");
 
     // Move the ownership of the led to the global LED
     cortex_m::interrupt::free(|cs| *LED.borrow(cs).borrow_mut() = Some(led));
 
     // Configuring the user button to trigger an interrupt when the button is pressed.
-    let mut user_button = gpioa
-        .pa0
-        .into_pull_down_input(&mut gpioa.moder, &mut gpioa.pupdr);
+    let mut user_button = gpioa.pa0.into_pull_down_input();
     syscfg.select_exti_interrupt_source(&user_button);
     user_button.trigger_on_edge(&mut exti, Edge::Rising);
     user_button.enable_interrupt(&mut exti);

examples/i2c_scanner.rs

@@ -25,19 +25,13 @@ fn main() -> ! {
     let mut rcc = dp.RCC.constrain();
     let clocks = rcc.cfgr.freeze(&mut flash.acr);
 
-    let mut gpiob = dp.GPIOB.split(&mut rcc.ahb);
+    let gpiob = dp.GPIOB.split(&mut rcc.ahb);
 
     // Configure I2C1
-    let mut scl =
-        gpiob
-            .pb6
-            .into_af4_open_drain(&mut gpiob.moder, &mut gpiob.otyper, &mut gpiob.afrl);
-    let mut sda =
-        gpiob
-            .pb7
-            .into_af4_open_drain(&mut gpiob.moder, &mut gpiob.otyper, &mut gpiob.afrl);
-    scl.internal_pull_up(&mut gpiob.pupdr, true);
-    sda.internal_pull_up(&mut gpiob.pupdr, true);
+    let mut scl = gpiob.pb6.into_af4_open_drain();
+    let mut sda = gpiob.pb7.into_af4_open_drain();
+    scl.internal_pull_up(true);
+    sda.internal_pull_up(true);
     let mut i2c = hal::i2c::I2c::new(
         dp.I2C1,
         (scl, sda),

examples/pwm.rs

@@ -31,41 +31,21 @@ fn main() -> ! {
     let clocks = rcc.cfgr.sysclk(16.MHz()).freeze(&mut flash.acr);
 
     // Prep the pins we need in their correct alternate function
-    let mut gpioa = dp.GPIOA.split(&mut rcc.ahb);
-    let pa4 = gpioa
-        .pa4
-        .into_af2_push_pull(&mut gpioa.moder, &mut gpioa.otyper, &mut gpioa.afrl);
-    let pa6 = gpioa
-        .pa6
-        .into_af2_push_pull(&mut gpioa.moder, &mut gpioa.otyper, &mut gpioa.afrl);
-    let pa7 = gpioa
-        .pa7
-        .into_af2_push_pull(&mut gpioa.moder, &mut gpioa.otyper, &mut gpioa.afrl);
-
-    let mut gpiob = dp.GPIOB.split(&mut rcc.ahb);
-    let pb0 = gpiob
-        .pb0
-        .into_af2_push_pull(&mut gpiob.moder, &mut gpiob.otyper, &mut gpiob.afrl);
-    let pb1 = gpiob
-        .pb1
-        .into_af2_push_pull(&mut gpiob.moder, &mut gpiob.otyper, &mut gpiob.afrl);
-    let pb4 = gpiob
-        .pb4
-        .into_af2_push_pull(&mut gpiob.moder, &mut gpiob.otyper, &mut gpiob.afrl);
-    let pb5 = gpiob
-        .pb5
-        .into_af2_push_pull(&mut gpiob.moder, &mut gpiob.otyper, &mut gpiob.afrl);
-    let pb8 = gpiob
-        .pb8
-        .into_af1_push_pull(&mut gpiob.moder, &mut gpiob.otyper, &mut gpiob.afrh);
-    let pb10 = gpiob
-        .pb10
-        .into_af1_push_pull(&mut gpiob.moder, &mut gpiob.otyper, &mut gpiob.afrh);
-
-    let mut gpioc = dp.GPIOC.split(&mut rcc.ahb);
-    let pc10 = gpioc
-        .pc10
-        .into_af4_push_pull(&mut gpioc.moder, &mut gpioc.otyper, &mut gpioc.afrh);
+    let gpioa = dp.GPIOA.split(&mut rcc.ahb);
+    let pa4 = gpioa.pa4.into_af2_push_pull();
+    let pa6 = gpioa.pa6.into_af2_push_pull();
+    let pa7 = gpioa.pa7.into_af2_push_pull();
+
+    let gpiob = dp.GPIOB.split(&mut rcc.ahb);
+    let pb0 = gpiob.pb0.into_af2_push_pull();
+    let pb1 = gpiob.pb1.into_af2_push_pull();
+    let pb4 = gpiob.pb4.into_af2_push_pull();
+    let pb5 = gpiob.pb5.into_af2_push_pull();
+    let pb8 = gpiob.pb8.into_af1_push_pull();
+    let pb10 = gpiob.pb10.into_af1_push_pull();
+
+    let gpioc = dp.GPIOC.split(&mut rcc.ahb);
+    let pc10 = gpioc.pc10.into_af4_push_pull();
 
     // TIM3
     //
@@ -114,7 +94,7 @@ fn main() -> ! {
     // from the channel.
     //
     // DOES NOT COMPILE
-    // pb0.into_af15(&mut gpiob.moder, &mut gpiob.afrl);
+    // pb0.into_af15();
 
     // TIM2
     //
@@ -167,7 +147,7 @@ fn main() -> ! {
     // use).
     //
     // DOES NOT COMPILE
-    // tim8_ch1.output_to_pc6(gpioc.pc6.into_af4(&mut gpioc.moder, &mut gpioc.afrl));
+    // tim8_ch1.output_to_pc6(gpioc.pc6.into_af4());
 
     loop {
         asm::wfi();

examples/serial_dma.rs

@@ -30,15 +30,11 @@ fn main() -> ! {
     let mut rcc = dp.RCC.constrain();
     let clocks = rcc.cfgr.freeze(&mut flash.acr);
 
-    let mut gpioa = dp.GPIOA.split(&mut rcc.ahb);
+    let gpioa = dp.GPIOA.split(&mut rcc.ahb);
 
     let pins = (
-        gpioa
-            .pa9
-            .into_af7_push_pull(&mut gpioa.moder, &mut gpioa.otyper, &mut gpioa.afrh),
-        gpioa
-            .pa10
-            .into_af7_push_pull(&mut gpioa.moder, &mut gpioa.otyper, &mut gpioa.afrh),
+        gpioa.pa9.into_af7_push_pull(),
+        gpioa.pa10.into_af7_push_pull(),
     );
     let serial = Serial::new(dp.USART1, pins, 9600.Bd(), clocks, &mut rcc.apb2);
     let (tx, rx) = serial.split();