8000 Add SPI enums to Doxygen output, fixes #213 (#216) · schkovich/arduino-pico@2592c59 · GitHub
[go: up one dir, main page]
Skip to content

Commit 2592c59

Browse files
lurchlurch
authored
Add SPI enums to Doxygen output, fixes earlephilhower#213 (earlephilhower#216)
Also fix a few typos
1 parent 50acbb4 commit 2592c59

File tree

2 files changed

+15
-6
lines changed
  • src/rp2_common
    • hardware_i2c/include/hardware
    • hardware_spi/include/hardware

2 files changed

+15
-6
lines changed

‎src/rp2_common/hardware_i2c/include/hardware/i2c.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ struct i2c_inst {
134134
bool restart_on_next;
135135
};
136136

137-
/*! \brief Convert I2c instance to hardware instance number
137+
/*! \brief Convert I2C instance to hardware instance number
138138
* \ingroup hardware_i2c
139139
*
140140
* \param i2c I2C instance

‎src/rp2_common/hardware_spi/include/hardware/spi.h

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -70,16 +70,25 @@ typedef struct spi_inst spi_inst_t;
7070
#define spi_default PICO_DEFAULT_SPI_INSTANCE
7171
#endif
7272

73+
/** \brief Enumeration of SPI CPHA (clock phase) values.
74+
* \ingroup hardware_spi
75+
*/
7376
typedef enum {
7477
SPI_CPHA_0 = 0,
7578
SPI_CPHA_1 = 1
7679
} spi_cpha_t;
7780

81+
/** \brief Enumeration of SPI CPOL (clock polarity) values.
82+
* \ingroup hardware_spi
83+
*/
7884
typedef enum {
7985
SPI_CPOL_0 = 0,
8086
SPI_CPOL_1 = 1
8187
} spi_cpol_t;
8288

89+
/** \brief Enumeration of SPI bit-order values.
90+
* \ingroup hardware_spi
91+
*/
8392
typedef enum {
8493
SPI_LSB_FIRST = 0,
8594
SPI_MSB_FIRST = 1
@@ -123,7 +132,7 @@ void spi_deinit(spi_inst_t *spi);
123132
*/
124133
uint spi_set_baudrate(spi_inst_t *spi, uint baudrate);
125134

126-
/*! \brief Convert I2c instance to hardware instance number
135+
/*! \brief Convert SPI instance to hardware instance number
127136
* \ingroup hardware_spi
128137
*
129138
* \param spi SPI instance
@@ -272,7 +281,7 @@ int spi_read_blocking(spi_inst_t *spi, uint8_t repeated_tx_data, uint8_t *dst, s
272281
* \param src Buffer of data to write
273282
* \param dst Buffer for read data
274283
* \param len Length of BOTH buffers in halfwords
275-
* \return Number of bytes written/read
284+
* \return Number of halfwords written/read
276285
*/
277286
int spi_write16_read16_blocking(spi_inst_t *spi, const uint16_t *src, uint16_t *dst, size_t len);
278287

@@ -287,7 +296,7 @@ int spi_write16_read16_blocking(spi_inst_t *spi, const uint16_t *src, uint16_t *
287296
* \param spi SPI instance specifier, either \ref spi0 or \ref spi1
288297
* \param src Buffer of data to write
289298
* \param len Length of buffers
290-
* \return Number of bytes written/read
299+
* \return Number of halfwords written/read
291300
*/
292301
int spi_write16_blocking(spi_inst_t *spi, const uint16_t *src, size_t len);
293302

@@ -305,8 +314,8 @@ int spi_write16_blocking(spi_inst_t *spi, const uint16_t *src, size_t len);
305314
* \param spi SPI instance specifier, either \ref spi0 or \ref spi1
306315
* \param repeated_tx_data Buffer of data to write
307316
* \param dst Buffer for read data
308-
* \param len Length of buffer \p dst in halfwords
309-
* \return Number of bytes written/read
317+
* \param len Length of buffer \p dst in halfwords
318+
* \return Number of halfwords written/read
310319
*/
311320
int spi_read16_blocking(spi_inst_t *spi, uint16_t repeated_tx_data, uint16_t *dst, size_t len);
312321

0 commit comments

Comments
 (0)
0