rp-hal-boards/rp2040-hal/src/lib.rs

//! HAL for the RP2040 microcontroller
//!
//! This is an implementation of the [`embedded-hal`] traits for the RP2040 microcontroller
//! NOTE This HAL is still under active development. This API will remain volatile until 1.0.0

#![warn(missing_docs)]
#![no_std]
#![cfg_attr(feature = "embassy-traits", feature(generic_associated_types))]
#![cfg_attr(feature = "embassy-traits", feature(type_alias_impl_trait))]

extern crate cortex_m;
extern crate embedded_hal as hal;
extern crate nb;
pub use paste;

pub extern crate rp2040_pac as pac;

pub mod adc;
pub(crate) mod atomic_register_access;
pub mod clocks;
mod critical_section_impl;
pub mod dma;
pub mod gpio;
pub mod i2c;
pub mod multicore;
pub mod pio;
pub mod pll;
pub mod prelude;
pub mod pwm;
pub mod resets;
pub mod rom_data;
pub mod rosc;
pub mod rtc;
pub mod sio;
pub mod spi;
pub mod ssi;
pub mod timer;
pub mod typelevel;
pub mod uart;
pub mod usb;
pub mod watchdog;
pub mod xosc;

// Provide access to common datastructures to avoid repeating ourselves
pub use adc::Adc;
pub use clocks::Clock;
pub use i2c::I2C;
pub use sio::Sio;
pub use spi::Spi;
pub use timer::Timer;
pub use watchdog::Watchdog;
Added skeleton for HAL and updated readme 2021-01-25 15:42:43 -05:00			`//! HAL for the RP2040 microcontroller`
			`//!`
			//! This is an implementation of the [`embedded-hal`] traits for the RP2040 microcontroller
			`//! NOTE This HAL is still under active development. This API will remain volatile until 1.0.0`

Warn missing docs, deny in ci 2021-07-19 18:58:26 +02:00			`#![warn(missing_docs)]`
Added skeleton for HAL and updated readme 2021-01-25 15:42:43 -05:00			`#![no_std]`
Implement peripheral support for i2c and an advanced example (#162) * Implement peripheral support for i2c and an advanced example for the pico board. * Simplify i2c peripheral bootstrap and add a "free" function to allow switching modes. * Set dependency to futures & nostd_async to specific version/revision. * move enum & struct to the start of the file * Add a bit of documentation to the pico_i2c_controller_peripheral demo. * Migrate to pico_i2c_controller_peripheral to embassy & simplify the peripheral support nostd_async is broken since last stable roll out. The pico_i2c_controller_peripheral is being migrated to use embassy's executor. The Controller Async API is now aligned with embassy's traits to facilitate integration. The peripheral no longer require async to run and now appears as an event iterator. Embassy's support relies on unstable features (generic_associated_types and type_alias_impl_traits) and is therefore gated behind the `embassy-traits` feature flag. * make futures & embassy optional for the pico board too * Pin embassy to a specific rev. * Impl embassy_traits::i2c::WriteIter & enable unlimited transfer size on i2c * Applies comment suggestion from @9names for the advanced i2c example. Co-authored-by: 9names <60134748+9names@users.noreply.github.com> * use `I2C block` instead of `IP`. * Fix formatting (unnecessary space at end of line) * Enhance explanation for why `rd_req()` is not cleared in `Iterator::next`'s implementation. Co-authored-by: 9names <60134748+9names@users.noreply.github.com> 2021-11-08 12:23:28 +00:00			`#![cfg_attr(feature = "embassy-traits", feature(generic_associated_types))]`
			`#![cfg_attr(feature = "embassy-traits", feature(type_alias_impl_trait))]`
Added skeleton for HAL and updated readme 2021-01-25 15:42:43 -05:00
			`extern crate cortex_m;`
			`extern crate embedded_hal as hal;`
			`extern crate nb;`
Massive GPIO refactor Bring in line with atsamd-hal GPIO v2 Copied as much as possible. Docs lifted mostly as-is. Also add sample BSP for the Feather RP2040 in boards/feather_rp2040 May include a few random fixes from currently futile attempt to get doctests working. 2021-05-23 21:08:42 -05:00			`pub use paste;`
Working HAL for the XOSC 2021-04-24 13:38:17 +02:00
Added skeleton for HAL and updated readme 2021-01-25 15:42:43 -05:00			`pub extern crate rp2040_pac as pac;`

			`pub mod adc;`
Use volatile register access for gpio interrupts (#170) * Use volatile register access for gpio interrupts * Provide functions for atomic register updates * Use atomic register access functions in pio.rs * Improve doc comments * Limit visibility of atomic register access functions Also remove write_xor for now, as it's not yet used anywhere 2021-10-22 14:30:30 +02:00			`pub(crate) mod atomic_register_access;`
Initial commit on clocks 2021-05-01 23:18:37 +02:00			`pub mod clocks;`
Add simple interrupt_disable+spinlock critical-section impl (#151) * Add basic interrupt_disable+spinlock critical-section * Update impl based on feedback from jannic * Get rid of count variable, switch to AtomicU8 for lock state * Remove interrupt::disable that isn't necessary for safety * Rename variables, re-write most of the comments * Add fences to ensure ordering 2021-12-02 00:03:41 +11:00			`mod critical_section_impl;`
Resolve review comments. Adds same functions to RX FIFO. 2021-11-16 21:45:52 +00:00			`pub mod dma;`
Add basic output support for GPIOs 2021-04-17 18:18:10 -05:00			`pub mod gpio;`
Added skeleton for HAL and updated readme 2021-01-25 15:42:43 -05:00			`pub mod i2c;`
multicore (#89) mvp multicore implementation Co-authored-by: Jan Niehusmann <jan@gondor.com> 2021-12-01 06:52:53 -06:00			`pub mod multicore;`
PIO support (#74) Initial implementation of PIO Add all of the infrastructure required to include PIO programs and interact with PIO peripheral registers. This was a massive effort between @devsnek and @henkkuli. It's great that it's now ready to go. Co-authored-by: Gus Caplan <me@gus.host> 2021-09-15 17:32:00 +03:00			`pub mod pio;`
Working implementation of a PLL HAL. 2021-04-25 10:12:38 +02:00			`pub mod pll;`
Added skeleton for HAL and updated readme 2021-01-25 15:42:43 -05:00			`pub mod prelude;`
			`pub mod pwm;`
Add `SubsystemReset` trait to handle subsystem resets dd a `SubsystemReset` trait which adds a `reset_bring_up` function to the relevant PAC types to handle bringing subsystems out of reset. Also, correct that the PLL and UART modules did not bring the relevant subsystems out of reset and refactor the GPIO module to use the SubsystemReset trait. 2021-05-16 12:42:41 -05:00			`pub mod resets;`
rom: Add rom content 2021-02-01 22:57:32 -06:00			`pub mod rom_data;`
Refactor clocks (#54) * Remove unneeded lines * Reduce macro boilerplate * Refactor clocks 2021-07-08 12:58:48 +02:00			`pub mod rosc;`
Added skeleton for HAL and updated readme 2021-01-25 15:42:43 -05:00			`pub mod rtc;`
typo fix, rustfmt 2021-05-10 08:29:59 -05:00			`pub mod sio;`
Added skeleton for HAL and updated readme 2021-01-25 15:42:43 -05:00			`pub mod spi;`
			`pub mod ssi;`
			`pub mod timer;`
Massive GPIO refactor Bring in line with atsamd-hal GPIO v2 Copied as much as possible. Docs lifted mostly as-is. Also add sample BSP for the Feather RP2040 in boards/feather_rp2040 May include a few random fixes from currently futile attempt to get doctests working. 2021-05-23 21:08:42 -05:00			`pub mod typelevel;`
Added skeleton for HAL and updated readme 2021-01-25 15:42:43 -05:00			`pub mod uart;`
			`pub mod usb;`
			`pub mod watchdog;`
Working HAL for the XOSC 2021-04-24 13:38:17 +02:00			`pub mod xosc;`
Re-export mod structs 2021-12-04 00:04:45 +11:00
			`// Provide access to common datastructures to avoid repeating ourselves`
			`pub use adc::Adc;`
			`pub use clocks::Clock;`
			`pub use i2c::I2C;`
			`pub use sio::Sio;`
			`pub use spi::Spi;`
			`pub use timer::Timer;`
Cargo fmt 2021-12-04 15:38:25 +11:00			`pub use watchdog::Watchdog;`