Update dma.h (raspberrypi#1678)

myklemykle · web-flow · commit 79977dbc4acb · 2024-06-04T20:00:55.000-05:00
Fix inline doc for dma_timer_set_fraction()
diff --git a/src/rp2_common/hardware_dma/include/hardware/dma.h b/src/rp2_common/hardware_dma/include/hardware/dma.h
@@ -863,7 +863,7 @@ int dma_claim_unused_timer(bool required);
  */
 bool dma_timer_is_claimed(uint timer);
 
-/*! \brief Set the divider for the given DMA timer
+/*! \brief Set the multiplier for the given DMA timer
  *  \ingroup hardware_dma
  *
  * The timer will run at the system_clock_freq * numerator / denominator, so this is the speed

Original file line number	Diff line number	Diff line change
`@@ -863,7 +863,7 @@ int dma_claim_unused_timer(bool required);`
`863`	`863`	`*/`
`864`	`864`	`bool dma_timer_is_claimed(uint timer);`
`865`	`865`
`866`		`-/*! \brief Set the divider for the given DMA timer`
	`866`	`+/*! \brief Set the multiplier for the given DMA timer`
`867`	`867`	`* \ingroup hardware_dma`
`868`	`868`	`*`
`869`	`869`	`* The timer will run at the system_clock_freq * numerator / denominator, so this is the speed`