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

Minor additions to PIO documentation (#831)

Browse Source
This commit is contained in:
Graham Sanderson 2022-05-17 13:04:38 -05:00 committed by GitHub
parent 658a21b946
commit b2ad632c24
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -95,6 +95,9 @@ typedef pio_hw_t *PIO;
/** \brief PIO Configuration structure /** \brief PIO Configuration structure
* \ingroup sm_config * \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().
*/ */
typedef struct { typedef struct {
uint32_t clkdiv; uint32_t clkdiv;
@ -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 /*! \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 * Can overlap with the 'in', 'set' and 'sideset' pins
* *
@ -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 /*! \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 * Can overlap with the 'in', 'out' and 'sideset' pins
* *
@ -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 /*! \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 * Can overlap with the 'out', 'set' and 'sideset' pins
* *
@ -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 /*! \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 * Can overlap with the 'in', 'out' and 'set' pins
* *