rust/va108xx-rs
6
0
Fork 0
Code Issues Pull Requests Projects Releases 7 Wiki Activity

Merge pull request 'doc fixes and improvements' (#8) from update-docs into main
All checks were successful
Rust/va108xx-rs/pipeline/head This commit looks good
Details

Browse Source 
Reviewed-on: #8
This commit is contained in:
Robin Müller 2024-06-25 11:02:54 +02:00
commit 5d6c7ebf5e
1 changed files with 8 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
va108xx-hal/src/gpio/pins.rs
View File

@ -29,11 +29,11 @@
//! } //! }
//! ``` //! ```
//! //!
//! A `PinId` identifies a pin by it's group (A, B, C or D) and pin number. Each //! A [PinId] identifies a pin by it's group (A or B) and pin number. Each
//! `PinId` instance is named according to its datasheet identifier, e.g. //! [PinId] instance is named according to its datasheet identifier, e.g.
//! [PA2]. //! [PA2].
//! //!
//! A `PinMode` represents the various pin modes. The available `PinMode` //! A [PinMode] represents the various pin modes. The available [PinMode]
//! variants are [`Input`], [`Output`] and [`Alternate`], each with its own //! variants are [`Input`], [`Output`] and [`Alternate`], each with its own
//! corresponding configurations. //! corresponding configurations.
//! //!
@ -51,18 +51,18 @@
//! //!
//! ``` //! ```
//! let mut peripherals = Peripherals::take().unwrap(); //! let mut peripherals = Peripherals::take().unwrap();
//! let pins = Pins::new(peripherals.PORT); //! let pinsa = PinsA::new(peripherals.PORT);
//! ``` //! ```
//! //!
//! Pins can be converted between modes using several different methods. //! Pins can be converted between modes using several different methods.
//! //!
//! ``` //! ```no_run
//! // Use one of the literal function names //! // Use one of the literal function names
//! let pa27 = pins.pa27.into_floating_input(); //! let pa0 = pinsa.pa0.into_floating_input();
//! // Use a generic method and one of the `PinMode` variant types //! // Use a generic method and one of the `PinMode` variant types
//! let pa27 = pins.pa27.into_mode::<FloatingInput>(); //! let pa0 = pinsa.pa0.into_mode::<FloatingInput>();
//! // Specify the target type and use `From`/`Into` //! // Specify the target type and use `From`/`Into`
//! let pa27: Pin<PA27, FloatingInput> = pins.pa27.into(); //! let pa0: Pin<PA0, FloatingInput> = pinsa.pa27.into();
//! ``` //! ```
//! //!
//! # Embedded HAL traits //! # Embedded HAL traits
@ -70,18 +70,6 @@
//! This module implements all of the embedded HAL GPIO traits for each [`Pin`] //! This module implements all of the embedded HAL GPIO traits for each [`Pin`]
//! in the corresponding [`PinMode`]s, namely: [`InputPin`], [`OutputPin`], //! in the corresponding [`PinMode`]s, namely: [`InputPin`], [`OutputPin`],
//! and [`StatefulOutputPin`]. //! and [`StatefulOutputPin`].
//!
//! For example, you can control the logic level of an `OutputPin` like so
//!
//! ```
//! use atsamd_hal::pac::Peripherals;
//! use atsamd_hal::gpio::Pins;
//! use crate::ehal_02::digital::v2::OutputPin;
//!
//! let mut peripherals = Peripherals::take().unwrap();
//! let mut pins = Pins::new(peripherals.PORT);
//! pins.pa27.set_high();
//! ```
use super::dynpins::{DynAlternate, DynGroup, DynInput, DynOutput, DynPinId, DynPinMode}; use super::dynpins::{DynAlternate, DynGroup, DynInput, DynOutput, DynPinId, DynPinMode};
use super::reg::RegisterInterface; use super::reg::RegisterInterface;
use crate::{ use crate::{