Skip to content

Minor additions to PIO documentation #831

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 17, 2022
Merged

Minor additions to PIO documentation #831

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f9434a2
Minor additions to PIO documentation
kilograham May 17, 2022
3b4971e
fix typo
kilograham May 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions src/rp2_common/hardware_pio/include/hardware/pio.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,9 @@ typedef pio_hw_t *PIO;

/** \brief PIO Configuration structure
* \ingroup sm_config
*
* This structure is an in-memory representation of the configuration that can be applied to a PIO
* state machine later using pio_sm_set_config() or pio_sm_init().
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure we need the word "later" in there, but otherwise LGTM.

*/
typedef struct {
uint32_t clkdiv;
Expand Down Expand Up @@ -902,7 +905,7 @@ static inline void pio_sm_set_wrap(PIO pio, uint sm, uint wrap_target, uint wrap
}

/*! \brief Set the current 'out' pins for a state machine
* \ingroup sm_config
* \ingroup hardware_pio
*
* Can overlap with the 'in', 'set' and 'sideset' pins
*
Expand All @@ -923,7 +926,7 @@ static inline void pio_sm_set_out_pins(PIO pio, uint sm, uint out_base, uint out


/*! \brief Set the current 'set' pins for a state machine
* \ingroup sm_config
* \ingroup hardware_pio
*
* Can overlap with the 'in', 'out' and 'sideset' pins
*
Expand All @@ -943,7 +946,7 @@ static inline void pio_sm_set_set_pins(PIO pio, uint sm, uint set_base, uint set
}

/*! \brief Set the current 'in' pins for a state machine
* \ingroup sm_config
* \ingroup hardware_pio
*
* Can overlap with the 'out', 'set' and 'sideset' pins
*
Expand All @@ -960,7 +963,7 @@ static inline void pio_sm_set_in_pins(PIO pio, uint sm, uint in_base) {
}

/*! \brief Set the current 'sideset' pins for a state machine
* \ingroup sm_config
* \ingroup hardware_pio
*
* Can overlap with the 'in', 'out' and 'set' pins
*
Expand Down