Type object
File match contents.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/img-catapult-psp/latest.json
Source https://www.schemastore.org/img-catapult-psp-1.0.0.json

Versions

Validate with Lintel

npx @lintel/lintel check
Type: object

Used to validate Catapult Platform Support Pack (PSP) contents.yaml file, which provides an index of the files within the PSP

Properties

platform object required

Catapult platform support file contents

21 nested properties
vendor string required

Platform/device vendor name

name string required

Name of platform - used to identify platform in IDE

maxLength=30
description string required

Full description of support pack

buildConfig string required

Value of the PLATFORM macro definition used during build

pattern=^([A-Z]|[0-9]|_)+$
version string required

Support pack version

license string required

License text

documentationFile object required

File within support pack

2 nested properties
builtin boolean required

builtin="true" means that a file path is relative to the platform directory within the SDK installation.builtin="false" means the file path is relative to the top level of the unzipped package

path string required

file path within zip file

coreDescriptionFile object required

File within support pack

2 nested properties
builtin boolean required

builtin="true" means that a file path is relative to the platform directory within the SDK installation.builtin="false" means the file path is relative to the top level of the unzipped package

path string required

file path within zip file

launchConfig string required

Launch configuration for platform

pattern=^(Alpine Model|Catapult Model|OpenOCD|Whisper|RemoteLinux)$
peripheralRegisterDescriptionFile object

File within support pack

2 nested properties
builtin boolean required

builtin="true" means that a file path is relative to the platform directory within the SDK installation.builtin="false" means the file path is relative to the top level of the unzipped package

path string required

file path within zip file

openOCDConfigurationFile object

File within support pack

2 nested properties
builtin boolean required

builtin="true" means that a file path is relative to the platform directory within the SDK installation.builtin="false" means the file path is relative to the top level of the unzipped package

path string required

file path within zip file

gdbAutoRunCommandString string

String with additional gdb commands to run to initiate connection to target

networkPortNumberForOCDConnections string

TCP/IP port number for OpenOCD connections. Set to "auto" to automatically use any free port

isPlatformFPGA boolean

True only for FPGA platforms

fpgaBitFile object

File within support pack

2 nested properties
builtin boolean required

builtin="true" means that a file path is relative to the platform directory within the SDK installation.builtin="false" means the file path is relative to the top level of the unzipped package

path string required

file path within zip file

fpgaProgConfigFile object

File within support pack

2 nested properties
builtin boolean required

builtin="true" means that a file path is relative to the platform directory within the SDK installation.builtin="false" means the file path is relative to the top level of the unzipped package

path string required

file path within zip file

traceSettingsString string

String with processor trace encoder settings required by the decoder

libsDirectory object

Directory within support pack

1 nested properties
path string required

directory path within zip file

headersDirectory object

Directory within support pack

1 nested properties
path string required

directory path within zip file

remoteHost string

Hostname or IP address for debug connection to remote machines

remoteUsername string

Username for debug connection to remote machines

Definitions

supportPackFile object

File within support pack

builtin boolean required

builtin="true" means that a file path is relative to the platform directory within the SDK installation.builtin="false" means the file path is relative to the top level of the unzipped package

path string required

file path within zip file

supportPackDirectory object

Directory within support pack

path string required

directory path within zip file