ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

QSPI: improve mode documentation 

SPI mode means Clock polarity and phase mode (0 - 3)
pull/7783/head
Martin Kojtal 2017-11-08 13:58:57 +00:00 committed by Maciej Bocianski
parent 4564383ba8
commit 10e7b5f6d0
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
hal/qspi_api.h
View File

@ -101,7 +101,7 @@ typedef enum qspi_status {
/** Initialize QSPI peripheral. /** Initialize QSPI peripheral.
* *
* It should initialize QSPI pins (io0-io3, sclk and ssel), set frequency and SPI mode. The clock for the peripheral should be enabled * It should initialize QSPI pins (io0-io3, sclk and ssel), set frequency, clock polarity and phase mode. The clock for the peripheral should be enabled
* *
* @param obj QSPI object * @param obj QSPI object
* @param io0 Data pin 0 * @param io0 Data pin 0
@ -111,7 +111,7 @@ typedef enum qspi_status {
* @param sclk The clock pin * @param sclk The clock pin
* @param ssel The chip select pin * @param ssel The chip select pin
* @param hz The bus frequency * @param hz The bus frequency
* @param mode SPI mode * @param mode Clock polarity and phase mode (0 - 3)
* @return QSPI_STATUS_OK if initialisation successfully executed * @return QSPI_STATUS_OK if initialisation successfully executed
QSPI_STATUS_INVALID_PARAMETER if invalid parameter found QSPI_STATUS_INVALID_PARAMETER if invalid parameter found
QSPI_STATUS_ERROR otherwise QSPI_STATUS_ERROR otherwise