cfsutil socs: List and Inspect SoC Data Models

Every SoC supported by CodeFusion Studio is associated with a SoC Data Model — a JSON file describing the device’s memory map, package variants, core configurations, register details, and other information required by the graphical configuration tools and code generation engine. The cfsutil socs commands let you discover which SoCs are available in your installation, inspect their hardware capabilities in detail, and export the raw data model JSON for use in external tooling or automation.

cfsutil socs list

cfsutil socs list [-f text|json] [-v] [-l] [-s <value>...]

Lists all SoC data models installed through the package manager and any present in custom search paths.

Flag reference

Flag	Short	Description
`--format`	`-f`	Output format: `text` (default) or `json`
`--verbose`	`-v`	Include additional SoC details (version, timestamp, description, schema, AI-compatible cores)
`--legacy`	`-l`	Use legacy output format (deprecated — will be removed in a future release)
`--search-path`	`-s`	Additional directory containing a `.cfsdatamodels` index file. Can be repeated

# List all available SoCs (text)
cfsutil socs list

# List as JSON
cfsutil socs list -f json

# List with full metadata
cfsutil socs list -v

# List from a custom data model directory
cfsutil socs list -s /path/to/codefusion-studio/packages/cfs-data-models/socs/.cfsdatamodels -f json

By default, the output groups packages under each SoC name:

max32690 (wlp, tqfn)
max78002 (csbga, qfn)
adsp-sc835 (...)

The --legacy flag produces the older combined soc-package key format (for example, max32690-wlp). This format is deprecated and will be removed in a future major release. Migrate scripts to use the default output format.

cfsutil socs info

cfsutil socs info <SOC> [--format text|json] [-b] [-c] [-d] [-p]

Displays detailed information about a specific SoC from the catalog. The <SOC> name is case-insensitive.

cfsutil soc info is an alias for cfsutil socs info.

Flag reference

Flag	Short	Description
`--boards`	`-b`	Display supported boards and their associated packages
`--cores`	`-c`	Display supported cores (architecture, ISA, primary, TrustZone, AI-compatible)
`--docs`	`-d`	Display documentation links
`--packages`	`-p`	Display supported package variants
`--format`		Output format: `text` (default) or `json`

When no filter flags are provided, info displays all sections (cores, boards, packages, documentation) by default.

# Full info (all sections)
cfsutil socs info MAX32660

# Show boards only
cfsutil socs info MAX32660 --boards

# Show cores and packages
cfsutil socs info MAX32660 --cores --packages

# Show documentation links as JSON
cfsutil socs info MAX32660 --docs --format json

# Combine multiple sections
cfsutil socs info MAX32690 --boards --cores --packages

Sample text output (—cores):

SoC: MAX32660

===== Cores =====
 Identifier  Architecture  ISA    Primary  TrustZone  AI Compatible
 CM4         ARM           Thumb  Yes      No         Yes

cfsutil socs export

cfsutil socs export <SOCNAME> [-p <package>] [-f json] [--gzip] \
  [-i <value>] [-m] [-o <value>] [-s <value>...] [-v <version>]

Outputs the complete SoC data model in JSON format. Useful for tooling, validation scripts, or generating custom data model indexes.

The deprecated -n, --name flag (which used a name-package combined string) has been replaced by the SOCNAME positional argument plus -p, --package. Do not use both together.

Flag reference

Flag	Short	Description
`SOCNAME`		Required. SoC name (without package suffix), for example `max32690`
`--package`	`-p`	Package name. Required if the SoC has more than one package
`--format`	`-f`	Output format (`json` only)
`--gzip`		Compress output with gzip
`--indent`	`-i`	JSON indentation: number of spaces (default: `2`) or `$'\t'` for tabs
`--minify`	`-m`	Minify the JSON output (overrides `--indent`)
`--output`	`-o`	Output destination: `stdio` (default) or a file path
`--search-path`	`-s`	Additional custom search path for SoC data models. Can be repeated
`--version`	`-v`	Optional data model version (defaults to latest)

# Export to stdout
cfsutil socs export max32690 --package tqfn

# Export to a file
cfsutil socs export max32690 --package tqfn -o max32690-tqfn.json

# Export minified JSON
cfsutil socs export max32690 --package wlp --minify -o max32690-wlp.min.json

# Export compressed (recommended to pipe or use -o)
cfsutil socs export max32690 --package tqfn --gzip > max32690-tqfn.gz

# Export a specific data model version
cfsutil socs export max32690 --package tqfn -v 1.3.0

# Export with custom indentation (tabs)
cfsutil socs export max32690 --package tqfn -i $'\t'

When using --gzip, it is strongly recommended to redirect the output to a file (-o <file> or > file.gz) rather than piping compressed binary data to the terminal.

Machine-readable output for CI

All three commands support --format json (or -f json) for structured output suitable for parsing in scripts and CI pipelines.

# Get SoC list as JSON for scripting
cfsutil socs list -f json

# Get full SoC info as JSON
cfsutil socs info MAX32690 --format json

# Export data model for external tooling
cfsutil socs export max32690 --package tqfn -o soc-model.json

cfsutil

Documentation Index