SPI Register Read

R2026b

Read from register of SPI device connected to NVIDIA Jetson board

Since R2026a

expand all in page
  • SPI Register Read block

Libraries:
NVIDIA Jetson and NVIDIA DRIVE / Communication

Description

Add-On Required: This feature requires the MATLAB Coder Support Package for NVIDIA Jetson and NVIDIA DRIVE Platforms add-on.

The SPI Register Read block reads data from the register of a Serial Peripheral Interface (SPI) device connected to an NVIDIA® Jetson™ board.

Ports

Output

expand all

Data read from the register of the SPI device, returned as a scalar or a column vector. The Output data type parameter determines the output data type. The output is an N-by-1 vector, where N is the integer specified by the Output data length parameter.

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

Parameters

expand all

To edit block parameters interactively, use the Property Inspector. From the Simulink® Toolstrip, on the Simulation tab, in the Prepare gallery, select Property Inspector.

Hardware board to deploy the model to.

Programmatic Use

To set the block parameter value programmatically, use the set_param (Simulink) function.

To get the block parameter value programmatically, use the get_param (Simulink) function.

Parameter: Board
Values: "NVIDIA Jetson TX2 Developer Kit" | "NVIDIA Jetson AGX Xavier Developer Kit" | "NVIDIA Jetson AGX Orin Developer Kit" | "NVIDIA Jetson Xavier NX Developer Kit" | "NVIDIA Jetson Orin Nano Developer Kit" | "NVIDIA Jetson Nano Developer Kit"

Example: set_param(gcb,"Board","NVIDIA Jetson Orin Nano Developer Kit")

Pin connected to the SPI peripheral device. The Board parameter setting determines the available settings, default value, and programmatic parameter name. This table shows the available settings for each board.

Board Parameter SettingAvailable Chip Select Pin SettingsDefault ValueProgrammatic Parameter Name

NVIDIA Jetson AGX Xavier Developer Kit

  • SPI0_CS0

  • SPI0_CS1

SPI0_CS0SSPin1SPI
NVIDIA Jetson TX2 Developer Kit

  • SPI3_CS0

  • SPI3_CS1

SPI3_CS0SSPin1SPIMiscSpidev3
NVIDIA Jetson Orin Nano Developer Kit

  • SPI0_CS0

  • SPI0_CS1

  • SPI1_CS0

  • SPI1_CS1

SPI1_CS0SSPin2SPI
NVIDIA Jetson Nano Developer Kit

  • SPI0_CS0

  • SPI0_CS1

  • SPI1_CS0

  • SPI1_CS1

SPI1_CS0SSPin2SPI
NVIDIA Jetson AGX Orin Developer Kit

  • SPI0_CS0

  • SPI0_CS1

  • SPI2_CS0

  • SPI2_CS1

SPI0_CS0SSPin2SPIMiscSpidev0And2
NVIDIA Jetson Xavier NX Developer Kit

  • SPI0_CS0

  • SPI0_CS1

  • SPI2_CS0

  • SPI2_CS1

SPI0_CS0SSPin2SPIMiscSpidev0And2

Programmatic Use

To set the block parameter value programmatically, use the set_param (Simulink) function.

To get the block parameter value programmatically, use the get_param (Simulink) function.

Parameter: SSPin1SPI
Values: "SPI0_CS0" (default) | "SPI0_CS1"

Example: get_param(gcb,"SSPin1SPI")

Parameter: SSPin1SPIMiscSpidev3
Values: "SPI3_CS0" (default) | "SPI3_CS1"
Parameter: SSPin2SPI
Values: "SPI1_CS0" (default) | "SPI0_CS0" | "SPI0_CS1" | "SPI1_CS1"
Parameter: SSPin2SPIMiscSpidev0And2
Values: "SPI0_CS0" (default) | "SPI0_CS1" | "SPI2_CS0" | "SPI2_CS1"

Mode to use for SPI communication. This table shows the clock polarity and clock phase for each setting.

ModeClock PolarityClock Phase
000
101
210
311

Programmatic Use

To set the block parameter value programmatically, use the set_param (Simulink) function.

To get the block parameter value programmatically, use the get_param (Simulink) function.

Parameter: ClockMode
Values: "0" (default) | "1" | "2" | "3"

Example: set_param(gcb,"ClockMode","2")

SPI peripheral address to read from. Each value of the register address must be a nonnegative integer less than or equal to 255.

Programmatic Use

To set the block parameter value programmatically, use the set_param (Simulink) function.

To get the block parameter value programmatically, use the get_param (Simulink) function.

Parameter: RegisterAddress
Values: "0" (default) | integer between 0 and 255 in quotes

Example: set_param(gcb,"RegisterAddress","[1 2]")

Data type to output.

Programmatic Use

To set the block parameter value programmatically, use the set_param (Simulink) function.

To get the block parameter value programmatically, use the get_param (Simulink) function.

Parameter: OutputDataType
Values: "int8" (default) | "uint8" | "int16" | "uint16" | "int32" | "uint32" | "single" | "double"

Example: set_param(gcb,"OutputDataType","int16")

Length of data to read.

Programmatic Use

To set the block parameter value programmatically, use the set_param (Simulink) function.

To get the block parameter value programmatically, use the get_param (Simulink) function.

Parameter: OutputDataLength
Values: "1" (default) | positive integer in quotes

Example: set_param(gcb,"OutputDataLength","2")

Sample time. The SPI Register Read block reads from the register at the rate specified by the Sample Time parameter. If Sample Time is -1, Simulink automatically chooses a sample time for the block.

Programmatic Use

To set the block parameter value programmatically, use the set_param (Simulink) function.

To get the block parameter value programmatically, use the get_param (Simulink) function.

Parameter: SampleTime
Values: "-1" (default) | scalar value in quotes

Example: set_param(gcb,"SampleTime","0.2")

Extended Capabilities

expand all

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

GPU Code Generation
Generate CUDA® code for NVIDIA® GPUs using GPU Coder™.

Version History

Introduced in R2026a

See Also

Blocks

Model Settings