SPI Controller Transfer

R2026b

Write data to and read data from SPI peripheral devices

• 

SPI Controller Transfer Block block

To add a block to a model, double-click the canvas and start typing the block name. Then, select the block from the list.

Libraries:
STM32 Microcontroller Blockset / STM32F1xx Based Boards
STM32 Microcontroller Blockset / STM32F2xx Based Boards
STM32 Microcontroller Blockset / STM32F3xx Based Boards
STM32 Microcontroller Blockset / STM32F4xx Based Boards
STM32 Microcontroller Blockset / STM32F7xx Based Boards
STM32 Microcontroller Blockset / STM32G0xx Based Boards
STM32 Microcontroller Blockset / STM32G4xx Based Boards
STM32 Microcontroller Blockset / STM32H5xx Based Boards
STM32 Microcontroller Blockset / STM32H7xx Based Boards
STM32 Microcontroller Blockset / STM32H7RSxx Based Boards
STM32 Microcontroller Blockset / STM32L4xx Based Boards
STM32 Microcontroller Blockset / STM32L5xx Based Boards
STM32 Microcontroller Blockset / STM32U5xx Based Boards
STM32 Microcontroller Blockset / STM32WBxx Based Boards
STM32 Microcontroller Blockset / (Legacy) STM32 MBED Based Boards / STM32L475VG-Discovery (B-L475E-IOT01A)
STM32 Microcontroller Blockset / (Legacy) STM32 MBED Based Boards / STM32F746G-Discovery
STM32 Microcontroller Blockset / (Legacy) STM32 MBED Based Boards / STM32F769I-Discovery
STM32 Microcontroller Blockset / (Legacy) STM32 MBED Based Boards / Common

Description

The SPI controller Transfer block writes data to and reads data from a peripheral devices over the Serial Peripheral Interface (SPI) interface. The block outputs an array of the same size and data type as the input values. You can use this block with Byte Pack and Byte Unpack blocks to support heterogeneous data type transfers.

Using this block, you can access an SPI device to measure quantities such as temperature, pressure.

For more information on SPI communication, see Support SPI Communication.

Ports

Input

SDO — Data to write to registers of an SPI peripheral devices

vector

The port accepts the serial data out (SDO) to write to the registers of a peripheral devices over the SPI interface.

Data Types: single | double | int8 | int16 | int32 | uint8 | uint16 | uint32

Output

SDI — Data read from registers of an SPI peripheral devices

vector

The port outputs the data read from the registers of a peripheral devices over the SPI interface.

Data Types: single | double | int8 | int16 | int32 | uint8 | uint16 | uint32

Parameters

Main

SPI module — SPI module to write and read data

0 (default)

Specify the SPI module to which the SPI peripheral devices is connected.

Chip select pin — Pin connected to the SPI peripheral devices

Specify the pin name on the board to which the SPI peripheral devices is connected. The SPI controller pulls the SS pin of the selected peripheral devices to a low (0) value to start the communication. The peripheral devices is selected depending on the pin polarity that you specify in the Chip select pin polarity parameter. The controller can select only one peripheral devices at a time.

First bit to transfer — First bit to transfer for SPI communication

Most significant bit (MSB) (default) | Least significant bit (LSB)

Select the order in which the data is transmitted.

• Most significant bit (MSB) — Select MSB to send the most significant bit (MSB) first.

• Least significant bit (LSB) — Select LSB to send the least significant bit (LSB) first.

Mode (Clock polarity and phase) — Mode of SPI communication

0 (default) | 1 | 2 | 3

An SPI controller sets the clock polarity (CPOL) and the clock phase (CPHA).

The combination of polarity and phase are referred to as SPI modes. The SPI modes 0–3 are shown in the table.

Mode	Clock Polarity (CPOL)	Clock Phase (CPHA)
0	0	0
1	0	1
2	1	0
3	1	1

For more information on register read/write, see SPI Transfer Modes.

Advanced

Chip select pin polarity — Logic level to establish SPI communication

Active low (default) | Active high

The logic levels supported by Chip select pin to select the SPI peripheral devices.

• Active low — The device is enabled on logic low. The SPI peripheral devices gets enabled when its SS pin is set to low.

• Active high — The device is enabled on logic high. The SPI peripheral devices gets enabled when its SS pin is set to high.

Programmatic Use: Add Block

To add the block programmatically, use the add_block function with one of these library block paths as the source.

"stm32f1xxblockslib/SPI Controller Transfer"

"stm32f2xxblockslib/SPI Controller Transfer"

"stm32f3xxblockslib/SPI Controller Transfer"

"stm32f4xxblockslib/SPI Controller Transfer"

"stm32f7xxblockslib/SPI Controller Transfer"

"stm32g0xxblockslib/SPI Controller Transfer"

"stm32g4xxblockslib/SPI Controller Transfer"

"stm32h5xxblockslib/SPI Controller Transfer"

"stm32h7xxblockslib/SPI Controller Transfer"

"stm32h7rsxxblockslib/SPI Controller Transfer"

"stm32l4xxblockslib/SPI Controller Transfer"

"stm32l5xxblockslib/SPI Controller Transfer"

"stm32u5xxblockslib/SPI Controller Transfer"

"stm32wbxxblockslib/SPI Controller Transfer"

"stm32l475vglib/SPI Controller Transfer"

"stm32f7lib/SPI Controller Transfer"

"stm32f769ilib/SPI Controller Transfer"

"stm32nucleodiscoboardslib/Common/SPI Controller Transfer"

Example: add_block("stm32f1xxblockslib/SPI Controller Transfer","myModel/myBlock",MakeNameUnique="on")

Extended Capabilities

C/C++ Code Generation
Generate C and C++ code using Simulink® Coder™.

Version History

Introduced in R2018a