soc.sdk.BoardSupport Class

Namespace: soc.sdk

Define and register tools and features of a supported hardware board

Since R2019b

Description

Use the soc.sdk.BoardSupport class to define the collection of configuration files, source and header files, tools, and libraries that SoC Blockset™, Embedded Coder^®, and HDL Coder™ use to configure, build, deploy, and interact with your model as an application on an SoC hardware board. A group of tools, libraries, and configurations that serve a specific purpose define a feature of this object. A feature object, such as a soc.sdk.Deployer object, when added to a BoardSupport object, enables a model to use the feature.

You can map each feature of an BoardSupport object to an soc.sdk.Hardware object by using the map method. Mapping features of a BoardSupport object to a Hardware object adds the needed files and configuration information to the board support files. These files enable those features in the Simulink^® configuration parameters for the associated SoC hardware board.

You can create a new BoardSupport object that already includes many features by referencing an existing BoardSupport object. When using an existing object as a reference, you only need to add or modify the features unique to the BoardSupport object you are creating.

Tip

Creating a BoardSupport object from a reference object can greatly accelerate your development time by providing ready-to-use features. Use this option for creating new BoardSupport objects in SoC Blockset.

Creation

Description

boardSupportObj = soc.sdk.BoardSupport(name,referenceBoardSupport,folder) creates a BoardSupport object with the Name property set to name, ReferenceTargets property set to referenceBoardSupport, and Folder property set to folder.

boardSupportObj = soc.sdk.BoardSupport(name,folder) creates an empty BoardSupport object with the Name property set to name and Folder property set to folder.

Note

Without a reference BoardSupport, all features of the BoardSupport object must be manually assigned.

boardSupportObj = soc.sdk.BoardSupport(name,referenceBoardSupport,folder,'initialize') initializes the BoardSupport object based on the input referenceBoardSupport.

Properties

Name — Name of board support

string | character vector

Name of the board support added to SoC Blockset, specified as a character vector.

Note

The soc.sdk.loadBoardSupport function uses the value in the Name property to load an existing soc.sdk.BoardSupport object between MATLAB^® sessions.

Example: 'Board support for Xilinx Zynq UltraScale+ MPSoC ZCU106 Evaluation Kit'

Attributes

GetAccess	public
SetAccess	public

Data Types: char

Folder — Root folder of the board support

string | character vector

Root folder of the board support, specified as a character vector. Root folder is the location on your host system where the BoardSupport object stores all configuration, source, and library files.

Note

Features referenced from other BoardSupport objects are not explicitly stored in the Folder.

Example: 'c:/BoardSupportForMPSoCZCU106'

Attributes

GetAccess	public
SetAccess	public

Data Types: char

ReferenceBoardSupport — Names of reference board support

"Board Support for Xilinx Zynq-7000 SoC" | "Board Support for Xilinx Zynq UltraScale+ MPSoC"

Names of reference board support, specified as "Board Support for Xilinx Zynq-7000 SoC" or "Board Support for Xilinx Zynq UltraScale+ MPSoC". These options define the set of existing supported SoC Blockset hardware board families from which the new BoardSupport object can reference feature objects, such a soc.sdk.Deployer.

Example: "Board Support for Xilinx Zynq-7000 SoC"

Attributes

GetAccess	public
SetAccess	immutable

Deployers — Deployer objects

{} (default) | cell array of Deployer objects

Deployer objects, specified as a cell array of soc.sdk.Deployer objects define the tools and configuration used by BoardSupport object to build and load a model as an application on an SoC hardware board. To modify the Deployers property, use the addNewDeployer and removeDeployer methods.

Attributes

GetAccess	public
SetAccess	public

Data Types: cell

OperatingSystems — OperatingSystem objects

{} (default) | cell array of OperatingSystem objects

OperatingSystem objects, specified as a cell array of soc.sdk.OperatingSystem objects, specify the available operating systems that can be chosen in the current BoardSupport object. To modify the OperatingSystems property, use the addNewOperatingSystem and removeOperatingSystem methods.

Attributes

GetAccess	public
SetAccess	public

Data Types: cell

PIL — Processor-in-the-Loop objects

{} (default) | cell array of PIL objects

PIL objects, specified as a cell array of soc.sdk.PIL objects, provides the BoardSupport object with the configuration information needed to generate code and to cross-compile and execute either the top model or part of the model onto the processor. To add or remove PIL configurations from BoardSupport object, use the addNewPIL and removePIL methods, respectively. For information on PIL simulation, see Processor-in-the-Loop Simulation (Embedded Coder).

Attributes

GetAccess	public
SetAccess	public

Data Types: cell

ExternalMode — ExternalMode objects

{} (default) | cell array of ExternalMode objects

External mode objects, specified as a cell array of soc.sdk.ExternalMode objects. provide a BoardSupport object with the source files, callback functions, and configuration information needed to generate code that includes an ExternalMode connection for your model. To add or remove ExternalMode configurations from BoardSupport object, use the addNewExternalMode and removeExternalMode methods, respectively. For more information on external mode, see External Mode Simulations for Parameter Tuning, Signal Monitoring, and Code Execution Profiling (Simulink Coder).

Attributes

GetAccess	public
SetAccess	public

Data Types: cell

Profilers — Profiler objects

{} (default) | cell array of Profiler objects

Profiler objects, specified as a cell array of soc.sdk.Profiler objects, provides a BoardSupport object with the source files and configuration information needed to profile the execution of the generated code from your model. To modify the Profilers property, use the addNewProfiler and removeProfiler methods. For more information on code execution profiling, see Code Execution Profiling (Embedded Coder).

Attributes

GetAccess	public
SetAccess	public

Data Types: cell

Methods

Feature Specification

addNewDeployer	Add new deployer to board support object
getDeployer	Get deployers configured for a target
removeDeployer	Remove deployer from the board support
addNewOperatingSystem	Add new operating system to BoardSupport object
getOperatingSystem	Get the operating systems for a target
removeOperatingSystem	Remove an operating system from the board support
addNewPIL	Add processor-in-the-loop simulation configuration to a board support
getPIL	Get the Processor-In-the-Loop (PIL) configuration for a target
removePIL	Delete PIL configuration from the BoardSupport object
addNewExternalMode	Add new external mode configuration to BoardSupport object
getExternalMode	Get the external mode configuration for the board support
removeExternalMode	Remove an external mode configuration from the board support
addNewProfiler	Add new profiler to BoardSupport object
getProfiler	Get profiler objects in the board support object
removeProfiler	Remove a profiler from the board support

Hardware Mapping

map	Map a board support feature to the hardware board
isMapped	Identifies features mapped to the hardware
unmap	Unmap features from a hardware board or the board support
setDisplayName	Set the display name of the hardware
show	Show the mapping between the features of the target and the hardware

Test

validate	Determine whether target is valid
test	Test hardware and features of the BoardSupport object

Utilities

save	Save the BoardSupport object and data to its folder
remove	Removes board support for a given BoardSupport object

Version History

Introduced in R2019b