Skip to content

Commit c296171

Browse files
kilograhamlurch
andauthored
Apply suggestions from code review
Co-authored-by: Andrew Scheller <[email protected]>
1 parent eed982f commit c296171

File tree

1 file changed

+3
-3
lines changed
  • src/rp2_common/hardware_dma/include/hardware

1 file changed

+3
-3
lines changed

src/rp2_common/hardware_dma/include/hardware/dma.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ static inline void channel_config_set_read_increment(dma_channel_config_t *c, bo
256256
* \endcode
257257
*
258258
* \param c Pointer to channel configuration object
259-
* \param incr True to enable write address increments, whereby the write address increments by the transfer size with each transfer, false to perform each write to the same address.
259+
* \param incr True to enable write address increments, whereby the write address increments by the transfer size with each transfer. False to perform each write to the same address.
260260
* Usually disabled for memory to peripheral transfers
261261
* \sa channel_config_set_write_address_update_type
262262
*/
@@ -542,7 +542,7 @@ static inline uint32_t dma_encode_transfer_count(uint transfer_count) {
542542
* \param transfer_count the number of transfers (NOT bytes, see \ref channel_config_set_transfer_data_size)
543543
*
544544
* \if rp2040_specific
545-
* On RP2040 self-triggering DMA is not supported, so this method may not be used
545+
* On RP2040 self-triggering DMA is not supported, so this method should not be used
546546
* \endif
547547
*
548548
* \if rp2350_specific
@@ -566,7 +566,7 @@ static inline uint32_t dma_encode_transfer_count_with_self_trigger(uint transfer
566566
* \ingroup hardware_dma
567567
*
568568
* \if rp2040_specific
569-
* On RP2040 endless DMA transfers are not supported, so this method may not be used
569+
* On RP2040 endless DMA transfers are not supported, so this method should not be used
570570
* \endif
571571
* \return the encoded_transfer_count
572572
* \sa dma_channel_set_transfer_count

0 commit comments

Comments
 (0)