Skip to content

Commit 7b7576f

Browse files
author
deepikabhavnani
committed
Correct the param descritions of QSPI
1 parent 13c194e commit 7b7576f

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

drivers/QSPI.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,8 @@ class QSPI : private NonCopyable<QSPI> {
8484
* @param io3 4th IO pin used for sending/receiving data during data phase of a transaction
8585
* @param sclk QSPI Clock pin
8686
* @param ssel QSPI chip select pin
87-
* @param mode Mode specifies the SPI mode(Mode=0 uses CPOL=0, CPHA=0, Mode=1 uses CPOL=1, CPHA=1)
88-
* default value = 0
87+
* @param mode Clock polarity and phase mode (0 - 3) of SPI
88+
* (Default: Mode=0 uses CPOL=0, CPHA=0, Mode=1 uses CPOL=1, CPHA=1)
8989
*
9090
*/
9191
QSPI(PinName io0, PinName io1, PinName io2, PinName io3, PinName sclk, PinName ssel = NC, int mode = 0);
@@ -99,7 +99,7 @@ class QSPI : private NonCopyable<QSPI> {
9999
* @param address_width Bus width used by address phase(Valid values are QSPI_CFG_BUS_SINGLE, QSPI_CFG_BUS_DUAL, QSPI_CFG_BUS_QUAD)
100100
* @param address_size Size in bits used by address phase(Valid values are QSPI_CFG_ADDR_SIZE_8, QSPI_CFG_ADDR_SIZE_16, QSPI_CFG_ADDR_SIZE_24, QSPI_CFG_ADDR_SIZE_32)
101101
* @param alt_width Bus width used by alt phase(Valid values are QSPI_CFG_BUS_SINGLE, QSPI_CFG_BUS_DUAL, QSPI_CFG_BUS_QUAD)
102-
* @param alt_size Size in bits used by alt phase(Valid values are QSPI_CFG_ADDR_SIZE_8, QSPI_CFG_ADDR_SIZE_16, QSPI_CFG_ADDR_SIZE_24, QSPI_CFG_ADDR_SIZE_32)
102+
* @param alt_size Size in bits used by alt phase(Valid values are QSPI_CFG_ALT_SIZE_8, QSPI_CFG_ALT_SIZE_16, QSPI_CFG_ALT_SIZE_24, QSPI_CFG_ALT_SIZE_32)
103103
* @param data_width Bus width used by data phase(Valid values are QSPI_CFG_BUS_SINGLE, QSPI_CFG_BUS_DUAL, QSPI_CFG_BUS_QUAD)
104104
* @param dummy_cycles Number of dummy clock cycles to be used after alt phase
105105
*

0 commit comments

Comments
 (0)