Skip to content

Commit b2ad632

Browse files
authored
Minor additions to PIO documentation (raspberrypi#831)
1 parent 658a21b commit b2ad632

File tree

1 file changed

+7
-4
lines changed
  • src/rp2_common/hardware_pio/include/hardware

1 file changed

+7
-4
lines changed

src/rp2_common/hardware_pio/include/hardware/pio.h

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,9 @@ typedef pio_hw_t *PIO;
9595

9696
/** \brief PIO Configuration structure
9797
* \ingroup sm_config
98+
*
99+
* This structure is an in-memory representation of the configuration that can be applied to a PIO
100+
* state machine later using pio_sm_set_config() or pio_sm_init().
98101
*/
99102
typedef struct {
100103
uint32_t clkdiv;
@@ -902,7 +905,7 @@ static inline void pio_sm_set_wrap(PIO pio, uint sm, uint wrap_target, uint wrap
902905
}
903906

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

924927

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

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

962965
/*! \brief Set the current 'sideset' pins for a state machine
963-
* \ingroup sm_config
966+
* \ingroup hardware_pio
964967
*
965968
* Can overlap with the 'in', 'out' and 'set' pins
966969
*

0 commit comments

Comments
 (0)