Skip to content

Latest commit

 

History

History
70 lines (54 loc) · 4.06 KB

README.md

File metadata and controls

70 lines (54 loc) · 4.06 KB

SPI

STM32 SPI library has been modified with the possibility to manage several CS pins without to stop the SPI interface.
We do not describe here the SPI Arduino API but the functionalities added.

We give to the user 3 possiblities about the management of the CS pin:

  1. the CS pin is managed directly by the user code before to transfer the data (like the Arduino SPI library)
  2. the user gives the CS pin number to the library API and the library manages itself the CS pin (see example below)
  3. the user uses a hardware CS pin linked to the SPI peripheral

New API functions

  • SPIClass::SPIClass(uint8_t mosi, uint8_t miso, uint8_t sclk, uint8_t ssel): alternative class constructor
    Params SPI mosi pin
    Params SPI miso pin
    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
    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.
    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
    Params SPI CS pin managed by the SPI library

Note 1 The following functions must be called after initialization of the SPI instance with begin() or beginTransaction().
If you have several device to manage, you can call beginTransaction() several time with different CS pin in parameter.
Then you can call the following functions with different CS pin without call again beginTransaction() (until you call end() or endTransaction()).

Note 2 If the mode is set to SPI_CONTINUE, the CS pin is kept enabled. Be careful in case you use several CS pin.

  • byte transfer(uint8_t pin, uint8_t _data, SPITransferMode _mode = SPI_LAST): write/read one byte
    Params SPI CS pin managed by the SPI library
    Params data to write
    Params (optional) if SPI_LAST CS pin is reset, SPI_CONTINUE the CS pin is kept enabled.
    Return byte received

  • uint16_t transfer16(uint8_t pin, uint16_t _data, SPITransferMode _mode = SPI_LAST): write/read half-word
    Params SPI CS pin managed by the SPI library
    Params 16bits data to write
    Params (optional) if SPI_LAST CS pin is reset, SPI_CONTINUE the CS pin is kept enabled.
    Return 16bits data received

  • void transfer(uint8_t pin, void *_buf, size_t _count, SPITransferMode _mode = SPI_LAST): write/read several bytes. Only one buffer used to write and read the data
    Params SPI CS pin managed by the SPI library
    Params pointer to data to write. The data will be replaced by the data read.
    Params number of data to write/read. Params (optional) if SPI_LAST CS pin is reset, SPI_CONTINUE the CS pin is kept enabled.

  • void transfer(byte _pin, void *_bufout, void *_bufin, size_t _count, SPITransferMode _mode = SPI_LAST): write/read several bytes. One buffer for the output data and one for the input data
    Params SPI CS pin managed by the SPI library
    Params pointer to data to write.
    Params pointer where to store the data read.
    Params number of data to write/read.
    Params (optional) if SPI_LAST CS pin is reset, SPI_CONTINUE the CS pin is kept enabled.

Example

This is an example of the use of the CS pin management:

SPI.begin(2); //Enables the SPI instance with default settings and attachs the CS pin  
SPI.beginTransaction(1, settings); //Attachs another CS pin and configure the SPI instance with other settings  
SPI.transfer(1, 0x52); //Transfers data to the first device
SPI.transfer(2, 0xA4); //Transfers data to the second device. The SPI instance is configured with the right settings  
SPI.end() //SPI instance is disabled