Improve SPI library code understanding #161
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghost
requested review from
|
Thanks @fprwi6labs. |
fpistm
requested changes
Nov 30, 2017
libraries/SPI/README.md
Outdated
| _We do not describe here the [SPI Arduino API](https://www.arduino.cc/en/Reference/SPI) but the functionalities added._ | ||
|
|
||
| We give to the user 3 possiblities about the management of the CS pin: | ||
| * the CS pin is managed directly by the user code before to transfer the data (like the Arduino SPI library) |
There was a problem hiding this comment.
numbering:
1.
2.
3.
Remove the 'or'.
libraries/SPI/README.md
Outdated
|
|
||
| ### New API functions | ||
|
|
||
| * **SPIClass::SPIClass(uint8_t mosi, uint8_t miso, uint8_t sclk, uint8_t ssel)**: alternative class constructor |
There was a problem hiding this comment.
Please, use code formatter
SPIClass::SPIClass(uint8_t mosi, uint8_t miso, uint8_t sclk, uint8_t ssel): alternative class constructor
libraries/SPI/README.md
Outdated
| _Params_ SPI sclk pin | ||
| _Params_ (optional) SPI ssel pin. This pin must be an hardware CS pin. If you configure this pin, the chip select will be managed by the SPI peripheral. Do not use API functions with CS pin in parameter. | ||
|
|
||
| * **void SPIClass::begin(uint8_t _pin)**: initialize the SPI interface and add a CS pin |
libraries/SPI/README.md
Outdated
| * **void SPIClass::begin(uint8_t _pin)**: initialize the SPI interface and add a CS pin | ||
| _Params_ spi CS pin to be managed by the SPI library | ||
|
|
||
| * **void beginTransaction(uint8_t pin, SPISettings settings)**: allows to configure the SPI with other parameter. These new parameter are saved this an associated CS pin. |
libraries/SPI/README.md
Outdated
| _Params_ SPI CS pin to be managed by the SPI library | ||
| _Params_ SPI settings | ||
|
|
||
| * **void endTransaction(uint8_t pin)**: removes a CS pin and the SPI settings associated |
libraries/SPI/src/SPI.cpp
Outdated
| * @param _count: number of bytes to send/receive. | ||
| * @param _mode: (optional) can be SPI_CONTINUE in case of multiple successive | ||
| * send or SPI_LAST to indicate the end of send. | ||
| * If the _mode is set to SPI_CONTINUE, keep the spi instance alive. |
libraries/SPI/src/SPI.cpp
Outdated
| * @param _count: number of bytes to send/receive. | ||
| * @param _mode: (optional) can be SPI_CONTINUE in case of multiple successive | ||
| * send or SPI_LAST to indicate the end of send. | ||
| * If the _mode is set to SPI_CONTINUE, keep the spi instance alive. |
libraries/SPI/src/SPI.cpp
Outdated
| * another one will contains the data received. begin() or | ||
| * beginTransaction() must be called at least once before. | ||
| * @param _pin: CS pin to select a device (optional). If the previous transfer | ||
| * used another CS pin then the spi instance will be reconfigured. |
libraries/SPI/src/SPI.cpp
Outdated
| * @brief Transfer several bytes. Only one buffer used to send and receive data. | ||
| * begin() or beginTransaction() must be called at least once before. | ||
| * @param _pin: CS pin to select a device (optional). If the previous transfer | ||
| * used another CS pin then the spi instance will be reconfigured. |
libraries/SPI/src/SPI.h
Outdated
| void setClockDivider(uint8_t _div) { | ||
| setClockDivider(CS_PIN_CONTROLLED_BY_USER, _div); | ||
| } | ||
| // Not implemented functions. Keep for compatibility. |
|
Done |
fpistm
requested changes
Nov 30, 2017
libraries/SPI/src/SPI.h
Outdated
| void setClockDivider(uint8_t _div) { | ||
| setClockDivider(CS_PIN_CONTROLLED_BY_USER, _div); | ||
| } | ||
| // Not implemented functions. Keep for backward compatibility. |
Signed-off-by: fpr <[email protected]>
fpistm
approved these changes
Nov 30, 2017
benwaffle
pushed a commit
to benwaffle/Arduino_Core_STM32
that referenced
this pull request
Apr 10, 2019
Improve SPI library code understanding
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Try to improve the clarity of the SPI library code after the feedback #157