abawo/pico-sdk
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Reword some confusing terms in pio.h doxygen

Browse Source
This commit is contained in:
Luke Wren 2021-02-12 13:16:23 +00:00
parent 07aadbb658
commit 81c3d3fae6
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/rp2_common/hardware_pio/include/hardware/pio.h
View File

@ -192,10 +192,11 @@ static inline void sm_config_set_sideset(pio_sm_config *c, uint bit_count, bool
/*! \brief Set the state machine clock divider (from a floating point value) in a state machine configuration /*! \brief Set the state machine clock divider (from a floating point value) in a state machine configuration
* \ingroup sm_config * \ingroup sm_config
* *
* The clock divider can slow the state machine's execution to some rate below * The clock divider slows the state machine's execution by masking the
* the system clock frequency, by enabling the state machine on some cycles * system clock on some cycles, in a repeating pattern, so that the state
* but not on others, in a regular pattern. This can be used to generate e.g. * machine does not advance. Effectively this produces a slower clock for the
* a given UART baud rate. See the datasheet for further detail. * state machine to run from, which can be used to generate e.g. a particular
* UART baud rate. See the datasheet for further detail.
* *
* \param c Pointer to the configuration structure to modify * \param c Pointer to the configuration structure to modify
* \param div The fractional divisor to be set. 1 for full speed. An integer clock divisor of n * \param div The fractional divisor to be set. 1 for full speed. An integer clock divisor of n
@ -566,7 +567,7 @@ static inline void pio_restart_sm_mask(PIO pio, uint32_t mask) {
* Each state machine's clock divider is a free-running piece of hardware, * Each state machine's clock divider is a free-running piece of hardware,
* that generates a pattern of clock enable pulses for the state machine, * that generates a pattern of clock enable pulses for the state machine,
* based *only* on the configured integer/fractional divisor. The pattern of * based *only* on the configured integer/fractional divisor. The pattern of
* enabled/disabled cycles slows the state machine's execution to some * running/halted cycles slows the state machine's execution to some
* controlled rate. * controlled rate.
* *
* This function clears the divider's integer and fractional phase * This function clears the divider's integer and fractional phase
@ -591,7 +592,7 @@ static inline void pio_sm_clkdiv_restart(PIO pio, uint sm) {
* Each state machine's clock divider is a free-running piece of hardware, * Each state machine's clock divider is a free-running piece of hardware,
* that generates a pattern of clock enable pulses for the state machine, * that generates a pattern of clock enable pulses for the state machine,
* based *only* on the configured integer/fractional divisor. The pattern of * based *only* on the configured integer/fractional divisor. The pattern of
* enabled/disabled cycles slows the state machine's execution to some * running/halted cycles slows the state machine's execution to some
* controlled rate. * controlled rate.
* *
* This function simultaneously clears the integer and fractional phase * This function simultaneously clears the integer and fractional phase