Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Nightly doc build errors #737

Merged
merged 2 commits into from
Jun 6, 2024
Merged

Fix Nightly doc build errors #737

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f02673f
Fix Nightly doc build errors
kaidokert May 26, 2024
99868a7
Merge branch 'master' into docbuild
sajattack Jun 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions hal/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
- fix samd51j not having i2s support
- remove i2s functionality for samd51g since it does not have it
- Fix EIC issue leading to lost interrupts
- Fix docbuild indentation errors with nightly toolchain

# v0.17.0

Expand Down
25 changes: 12 additions & 13 deletions hal/src/dmac/transfer.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@
//!
//! Four basic transfer types are supported:
//!
//! * Incrementing-source to incrementing-destination
//! (normally used for memory-to-memory transfers)
//! * Incrementing-source to incrementing-destination (normally used for
//! memory-to-memory transfers)
//!
//! * Incrementing-source to fixed-destination (normally used
//! for memory-to-peripheral transfers)
//! * Incrementing-source to fixed-destination (normally used for
//! memory-to-peripheral transfers)
//!
//! * Fixed-source to incrementing-destination (normally used for
//! peripheral-to-memory transfers)
//! peripheral-to-memory transfers)
//!
//! * Fixed-source to fixed-destination (normally used for
//! peripheral-to-peripheral transfers)
//! peripheral-to-peripheral transfers)
//!
//! # Beat sizes
//!
Expand Down Expand Up @@ -71,17 +71,16 @@
//! Three trigger actions are available:
//!
//! * BLOCK: One trigger required for each block transfer. In the context of
//! this driver,
//! one Transfer is equivalent to one Block transfer.
//! this driver, one Transfer is equivalent to one Block transfer.
//!
//! * BEAT: One trigger required for each beat transfer. In the context of this
//! driver, the beat
//! size will depend on the type of buffer used (8, 16 or 32 bits).
//! driver, the beat size will depend on the type of buffer used (8, 16 or 32
//! bits).
//!
//! * TRANSACTION: One trigger required for a full DMA transaction. this is
//! useful for circular
//! transfers in the context of this driver. One trigger will set off the
//! transaction, that will now run uninterrupted until it is stopped.
//! useful for circular transfers in the context of this driver. One trigger
//! will set off the transaction, that will now run uninterrupted until it is
//! stopped.

use super::{
channel::{AnyChannel, Busy, CallbackStatus, Channel, ChannelId, InterruptFlags, Ready},
Expand Down
15 changes: 7 additions & 8 deletions hal/src/sercom/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,19 @@
//! those features work as intended.
//!
//! * [`UndocIoSet1`](pad::UndocIoSet1): Implement an undocumented `IoSet` for
//! PA16, PA17,
//! PB22 & PB23 configured for [`Sercom1`]. The pygamer & feather_m4 use this
//! combination, but it is not listed as valid in the datasheet.
//! PA16, PA17, PB22 & PB23 configured for [`Sercom1`]. The pygamer &
//! feather_m4 use this combination, but it is not listed as valid in the
//! datasheet.
//!
//! * [`UndocIoSet2`](pad::UndocIoSet2): Implement an undocumented `IoSet` for
//! PA00, PA01,
//! PB22 & PB23 configured for [`Sercom1`]. The itsybitsy_m4 uses this
//! combination, but it is not listed as valid in the datasheet.
//! PA00, PA01, PB22 & PB23 configured for [`Sercom1`]. The itsybitsy_m4 uses
//! this combination, but it is not listed as valid in the datasheet.
//!
//! * [`PB02`] is I2C-capable according to metro_m4. As such, [`PB02`]
//! implements [`IsI2cPad`].
//! implements [`IsI2cPad`].
//!
//! * [`PB03`] is I2C-capable according to metro_m4. As such, [`PB03`]
//! implements [`IsI2cPad`](pad::IsI2cPad).
//! implements [`IsI2cPad`](pad::IsI2cPad).
//!
//! [`PB02`]: crate::gpio::pin::PB02
//! [`PB03`]: crate::gpio::pin::PB03
Expand Down
6 changes: 2 additions & 4 deletions hal/src/sercom/pad.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,8 +302,7 @@ mod ioset {
/// As of writing this documentation, only two undocumented IOSETs have been
/// discovered:
/// - [`UndocIoSet1`]: PA16, PA17, PB22 & PB23 configured for `Sercom1`.
/// Both the
/// pygamer & feather_m4 uses this combination.
/// Both the pygamer & feather_m4 uses this combination.
/// - [`UndocIoSet2`]: PA00, PA01, PB22 & PB23 configured for `Sercom1`. The
/// itsybitsy_m4 uses this combination.
///
Expand All @@ -327,8 +326,7 @@ mod ioset {
/// As of writing this documentation, only two undocumented IOSETs have been
/// discovered:
/// - [`UndocIoSet1`]: PA16, PA17, PB22 & PB23 configured for `Sercom1`.
/// Both the
/// pygamer & feather_m4 uses this combination.
/// Both the pygamer & feather_m4 uses this combination.
/// - [`UndocIoSet2`]: PA00, PA01, PB22 & PB23 configured for `Sercom1`. The
/// itsybitsy_m4 uses this combination.
///
Expand Down
Loading