GetLitFam/esp-hal
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Fix DMA related doc-links (#1648)

Browse Source
This commit is contained in:
Björn Quentin 2024-05-31 16:22:18 +02:00 committed by GitHub
parent 40c327eeae
commit cb91828e5e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 21 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
esp-hal/src/aes/mod.rs
View File

@ -416,9 +416,8 @@ pub mod dma {
/// Perform a DMA transfer.
///
/// This will return a [AesDmaTransfer] owning the buffer(s) and the
/// AES instance. The maximum amount of data to be sent/received
/// is 32736 bytes.
/// This will return a [DmaTransferTxRx]. The maximum amount of data to
/// be sent/received is 32736 bytes.
pub fn process<'t, K, TXBUF, RXBUF>(
&'t mut self,
words: &'t TXBUF,

8
esp-hal/src/i2s.rs
View File

@ -228,13 +228,13 @@ where
Self: DmaSupportTx + Sized,
{
/// Write I2S.
/// Returns [I2sWriteDmaTransfer] which represents the in-progress DMA
/// Returns [DmaTransferTx] which represents the in-progress DMA
/// transfer
fn write_dma<'t>(&'t mut self, words: &'t TXBUF) -> Result<DmaTransferTx<Self>, Error>
where
TXBUF: ReadBuffer<Word = u8>;
/// Continuously write to I2S. Returns [I2sWriteDmaTransfer] which
/// Continuously write to I2S. Returns [DmaTransferTxCircular] which
/// represents the in-progress DMA transfer
fn write_dma_circular<'t>(
&'t mut self,
@ -258,14 +258,14 @@ where
Self: DmaSupportRx + Sized,
{
/// Read I2S.
/// Returns [I2sReadDmaTransfer] which represents the in-progress DMA
/// Returns [DmaTransferRx] which represents the in-progress DMA
/// transfer
fn read_dma<'t>(&'t mut self, words: &'t mut RXBUF) -> Result<DmaTransferRx<Self>, Error>
where
RXBUF: WriteBuffer<Word = u8>;
/// Continuously read from I2S.
/// Returns [I2sReadDmaTransfer] which represents the in-progress DMA
/// Returns [DmaTransferRxCircular] which represents the in-progress DMA
/// transfer
fn read_dma_circular<'t>(
&'t mut self,

4
esp-hal/src/parl_io.rs
View File

@ -1412,7 +1412,7 @@ where
{
/// Perform a DMA write.
///
/// This will return a [DmaTransfer]
/// This will return a [DmaTransferTx]
///
/// The maximum amount of data to be sent is 32736 bytes.
pub fn write_dma<'t, TXBUF>(
@ -1498,7 +1498,7 @@ where
{
/// Perform a DMA read.
///
/// This will return a [RxDmaTransfer]
/// This will return a [DmaTransferRx]
///
/// The maximum amount of data is 32736 bytes when using [EofMode::ByteLen].
///

16
esp-hal/src/spi/master.rs
View File

@ -1056,9 +1056,8 @@ pub mod dma {
{
/// Perform a DMA write.
///
/// This will return a [SpiDmaTransfer] owning the buffer(s) and the SPI
/// instance. The maximum amount of data to be sent is 32736
/// bytes.
/// This will return a [DmaTransferTx]. The maximum amount of data to be
/// sent is 32736 bytes.
#[cfg_attr(feature = "place-spi-driver-in-ram", ram)]
pub fn dma_write<'t, TXBUF>(
&'t mut self,
@ -1080,9 +1079,8 @@ pub mod dma {
/// Perform a DMA read.
///
/// This will return a [SpiDmaTransfer] owning the buffer(s) and the SPI
/// instance. The maximum amount of data to be received is 32736
/// bytes.
/// This will return a [DmaTransferRx]. The maximum amount of data to be
/// received is 32736 bytes.
#[cfg_attr(feature = "place-spi-driver-in-ram", ram)]
pub fn dma_read<'t, RXBUF>(
&'t mut self,
@ -1106,9 +1104,9 @@ pub mod dma {
/// Perform a DMA transfer.
///
/// This will return a [SpiDmaTransfer] owning the buffer(s) and the SPI
/// instance. The maximum amount of data to be sent/received is
/// 32736 bytes.
/// This will return a [DmaTransferTxRx] owning the buffer(s) and the
/// SPI instance. The maximum amount of data to be sent/received
/// is 32736 bytes.
pub fn dma_transfer<'t, TXBUF, RXBUF>(
&'t mut self,
words: &'t TXBUF,

15
esp-hal/src/spi/slave.rs
View File

@ -294,9 +294,8 @@ pub mod dma {
{
/// Register a buffer for a DMA write.
///
/// This will return a [SpiDmaTransferTx] owning the buffer(s) and the
/// SPI instance. The maximum amount of data to be sent is 32736
/// bytes.
/// This will return a [DmaTransferTx]. The maximum amount of data to be
/// sent is 32736 bytes.
///
/// The write is driven by the SPI master's sclk signal and cs line.
pub fn dma_write<'t, TXBUF>(
@ -319,9 +318,8 @@ pub mod dma {
/// Register a buffer for a DMA read.
///
/// This will return a [SpiDmaTransferRx] owning the buffer(s) and the
/// SPI instance. The maximum amount of data to be received is
/// 32736 bytes.
/// This will return a [DmaTransferRx]. The maximum amount of data to be
/// received is 32736 bytes.
///
/// The read is driven by the SPI master's sclk signal and cs line.
pub fn dma_read<'t, RXBUF>(
@ -346,9 +344,8 @@ pub mod dma {
/// Register buffers for a DMA transfer.
///
/// This will return a [SpiDmaTransferRxTx] owning the buffer(s) and the
/// SPI instance. The maximum amount of data to be sent/received
/// is 32736 bytes.
/// This will return a [DmaTransferTxRx]. The maximum amount of data to
/// be sent/received is 32736 bytes.
///
/// The data transfer is driven by the SPI master's sclk signal and cs
/// line.