Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions .github/workflows/vulcan-docs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Vulcan SysDoc

run-name: ${{ github.event.head_commit.message || github.event.pull_request.title || github.ref_name || 'Vulcan SysDoc' }} (${{ github.event_name == 'workflow_dispatch' && inputs.deploy_environment || github.ref_name == 'main' && 'prod' || github.ref_name == 'develop' && 'stg' || 'dev' }})
run-name: ${{ github.event.head_commit.message || github.event.pull_request.title || github.ref_name || 'Vulcan SysDoc' }} (${{ github.event_name == 'workflow_dispatch' && inputs.deploy_environment || (github.ref_name == 'main' || github.ref_name == 'develop') && 'stg' || 'dev' }})

on:
push:
Expand All @@ -11,7 +11,7 @@ on:
workflow_dispatch:
inputs:
deploy_environment:
description: Vulcan sysdoc environment
description: Vulcan sysdoc environment (prod requires the main branch)
required: true
default: dev
type: choice
Expand All @@ -26,7 +26,7 @@ permissions:
id-token: write

concurrency:
group: ${{ github.repository }}-${{ github.workflow }}-${{ github.event_name == 'workflow_dispatch' && inputs.deploy_environment || github.ref_name == 'main' && 'prod' || github.ref_name == 'develop' && 'stg' || 'dev' }}
group: ${{ github.repository }}-${{ github.workflow }}-${{ github.event_name == 'workflow_dispatch' && inputs.deploy_environment || (github.ref_name == 'main' || github.ref_name == 'develop') && 'stg' || 'dev' }}
cancel-in-progress: false

jobs:
Expand All @@ -47,9 +47,7 @@ jobs:
if [[ -z "${deploy_environment}" ]]; then
deploy_environment="${{ vars.VULCAN_ENV || 'dev' }}"
fi
elif [[ "${GITHUB_REF}" == "refs/heads/main" ]]; then
deploy_environment="prod"
elif [[ "${GITHUB_REF}" == "refs/heads/develop" ]]; then
elif [[ "${GITHUB_REF}" == "refs/heads/main" || "${GITHUB_REF}" == "refs/heads/develop" ]]; then
deploy_environment="stg"
elif [[ "${GITHUB_REF}" == "refs/heads/vulcan-dev-sysdoc" ]]; then
deploy_environment="dev"
Expand All @@ -65,8 +63,8 @@ jobs:
;;
prod|production)
deploy_environment="prod"
if [[ "${GITHUB_REF}" != "refs/heads/main" ]]; then
echo "Production sysdoc deploy is only allowed from refs/heads/main. Current ref: ${GITHUB_REF}" >&2
if [[ "${GITHUB_EVENT_NAME}" != "workflow_dispatch" || "${GITHUB_REF}" != "refs/heads/main" ]]; then
echo "Production sysdoc requires a manual workflow dispatch on main. Current event: ${GITHUB_EVENT_NAME}, ref: ${GITHUB_REF}" >&2
exit 1
fi
;;
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,6 @@ npm run clean

`.github/workflows/vulcan-docs.yml` builds the site on Vulcan and publishes the generated static output to the sysdoc S3 bucket for the selected environment.

- Pushes to `develop` and `main` deploy to staging.
- Manual workflow dispatch supports `dev`, `stg`, and `prod`.
- Production deployment is restricted to `main`.
- Successful builds from pushes to `develop` and `main` publish to staging automatically. Pushes to `vulcan-dev-sysdoc` publish to development.
- To release to production, open **Actions → Vulcan SysDoc → Run workflow**, select the `main` branch, and choose `prod`. This builds the selected revision with production configuration and publishes it after the build succeeds.
- Manual runs also support `dev` and `stg` for previewing a branch.
2 changes: 1 addition & 1 deletion docs/design/carrier-board.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ If you want to place the SoC directly on your own board instead, see
These parts are on the Modalix SoM and work on any carrier board that follows the
260-pin connector assignment:

- MLSoC Modalix
- Modalix MLSoC
- LPDDR5 memory
- eMMC and SPI flash storage
- USB controller, Gigabit Ethernet PHY, and HDMI video processor
Expand Down
2 changes: 1 addition & 1 deletion docs/design/som-carrier.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ to the callouts in these views.

## The Modalix SoM

The bring-up used Modalix SoM Rev 2. It carries the MLSoC Modalix die, two
The bring-up used Modalix SoM Rev 2. It carries the Modalix MLSoC die, two
LPDDR5 packages, 16 GB eMMC and SPI flash, and connects through the goldfinger
SO-DIMM edge connector.

Expand Down
4 changes: 2 additions & 2 deletions docs/devkit/modalix-devkit.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Modalix DevKit
description: Modalix development kit for evaluating MLSoC Modalix and building edge AI applications.
description: Modalix development kit for evaluating Modalix MLSoC and building edge AI applications.
sidebar_position: 1
---

Expand All @@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem';

# Modalix DevKit

The **Modalix DevKit** is the primary development kit for evaluating MLSoC Modalix and building edge AI applications. It combines Modalix hardware acceleration with the software stack needed to develop, test, and run workloads such as computer vision, large language models (LLMs), and multimodal pipelines.
The **Modalix DevKit** is the primary development kit for evaluating Modalix MLSoC and building edge AI applications. It combines Modalix hardware acceleration with the software stack needed to develop, test, and run workloads such as computer vision, large language models (LLMs), and multimodal pipelines.

<Tabs>
<TabItem value="interfaces" label="Interfaces" default>
Expand Down
4 changes: 2 additions & 2 deletions docs/devkit/modalix-pcie-card.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Modalix PCIe Card
description: HHHL PCIe card built around MLSoC Modalix for host-attached inference systems.
description: HHHL PCIe card built around Modalix MLSoC for host-attached inference systems.
sidebar_position: 3
---

Expand All @@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem';

# Modalix PCIe Card

The **Modalix PCIe Card** is a Half-Height/Half-Length (HHHL) PCIe card built around **MLSoC Modalix**. It installs into a host machine and provides dedicated Modalix inference acceleration over PCIe.
The **Modalix PCIe Card** is a Half-Height/Half-Length (HHHL) PCIe card built around **Modalix MLSoC**. It installs into a host machine and provides dedicated Modalix inference acceleration over PCIe.

<Tabs>
<TabItem value="interfaces" label="Interfaces" default>
Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/firmware-update/net-boot.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ To flash automatically once the device has netbooted, also append `--autoflash`:
sima-user@sima-user-machine:~$ sima-cli bootimg --boardtype <boardtype> --fwtype <fwtype> -v <version> --netboot --devkit <ip> --autoflash
```

On Ubuntu or WSL, use the same `sudo` invocation shown above. After the network boot completes and SSH is ready, `--autoflash` writes the image and schedules the reboot into eMMC. If remote setup is skipped or the CLI reports that manual serial setup is required, keep the TFTP server running and follow Steps 3 and 4.
On Ubuntu or WSL, use the same `sudo` invocation shown above. After the network boot completes and SSH is ready, `--autoflash` writes the image and schedules the reboot into eMMC. If you skip remote setup, the device is unreachable over SSH, or the CLI reports that it could not configure U-Boot safely, keep the TFTP server running and follow Steps 3 and 4.

This command:

Expand Down Expand Up @@ -165,7 +165,7 @@ Image size and flash time vary by firmware release. Example progress:
↦ 5368709120 bytes (5.4 GB, 5.0 GiB) copied, 163.331 s, 32.9 MB/s
```

After flashing completes, accept the CLI's prompt to reboot into eMMC, or reboot the DevKit later. Confirm the target firmware version on the DevKit with `cat /etc/buildinfo`.
After flashing completes, `sima-cli` prompts you to reboot into eMMC. Answer `y` to schedule the reboot now or `n` to boot from eMMC the next time you reboot the DevKit. After rebooting, confirm the target firmware version with `cat /etc/buildinfo`.


</details>
Expand Down
22 changes: 11 additions & 11 deletions docs/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: SiMa.ai Hardware Documentation
sidebar_label: "Platform Overview"
description: Hardware setup, firmware, and low-level interfaces for SiMa.ai MLSoC Modalix products.
description: Hardware setup, firmware, and low-level interfaces for SiMa.ai Modalix MLSoC products.
sidebar_position: 1
slug: /
---
Expand All @@ -12,15 +12,15 @@ import useBaseUrl from '@docusaurus/useBaseUrl';

# SiMa.ai Hardware Documentation

Use this site for hardware setup, firmware workflows, and low-level interfaces for SiMa.ai MLSoC Modalix products. Software, ML, and pipeline tooling are documented separately.
Use this site for hardware setup, firmware workflows, and low-level interfaces for SiMa.ai Modalix MLSoC products. Software, ML, and pipeline tooling are documented separately.

## SiMa.ai Hardware at a Glance {#hardware-at-a-glance}

SiMa.ai offers MLSoC Modalix as a chip, on a module, and in complete products. Start from the form factor that you have or plan to use.
SiMa.ai offers Modalix MLSoC as a chip, on a module, and in complete products. Start from the form factor that you have or plan to use.

| Product | What it is | Start here |
| --- | --- | --- |
| MLSoC Modalix | The system-on-chip. You place it on a board that you design. | [Build with the SoC](/hardware/design/chip-down) |
| Modalix MLSoC | The system-on-chip. You place it on a board that you design. | [Build with the SoC](/hardware/design/chip-down) |
| Modalix SoM | A module with the SoC, LPDDR5 memory, and power. It plugs into a carrier board. | [Build with the SoM](/hardware/design/carrier-board) |
| Modalix DevKit | A Modalix SoM on a carrier board, in an enclosure, for evaluation and development. | [Evaluate a DevKit](/hardware/getting-started) |
| Modalix PCIe Card | A half-height, half-length card that adds Modalix inference to a host machine. | [PCIe Mode](/hardware/getting-started/pcie-mode) |
Expand All @@ -40,11 +40,11 @@ To build your own hardware, choose between a carrier board for the Modalix SoM a

After the board boots, both paths use the same system software. See [Build System Software](/hardware/software).

## About the MLSoC Modalix
## About the Modalix MLSoC

The **MLSoC Modalix** is SiMa.ai's second-generation machine-learning system-on-chip. It combines an Arm Cortex-A65 application complex, a high-throughput **Machine Learning Accelerator (MLA)**, an **Image Signal Processor (ISP)** for camera ingest, and a **Computer Vision Unit (CVU)** for classical vision workloads — all on a single die.
The **Modalix MLSoC** is SiMa.ai's second-generation machine-learning system-on-chip. It combines an Arm Cortex-A65 application complex, a high-throughput **Machine Learning Accelerator (MLA)**, an **Image Signal Processor (ISP)** for camera ingest, and a **Computer Vision Unit (CVU)** for classical vision workloads — all on a single die.

This integration lets you run multimodal, generative, and vision AI pipelines at the edge without combining separate accelerators, host CPUs, and camera bridges. The Modalix SoM packages MLSoC Modalix for carrier-board and product integration, and every DevKit documented here uses the same silicon.
This integration lets you run multimodal, generative, and vision AI pipelines at the edge without combining separate accelerators, host CPUs, and camera bridges. The Modalix SoM packages Modalix MLSoC for carrier-board and product integration, and every DevKit documented here uses the same silicon.

<img
src={useBaseUrl('/img/media/modalix-arch.png')}
Expand All @@ -54,13 +54,13 @@ This integration lets you run multimodal, generative, and vision AI pipelines at

## DevKit Portfolio

SiMa.ai offers MLSoC Modalix-based development kits and PCIe products for edge AI applications. Select a product below, or compare features in the table.
SiMa.ai offers Modalix MLSoC-based development kits and PCIe products for edge AI applications. Select a product below, or compare features in the table.

<div className="card-grid">
<a className="card devkit-card" href="/hardware/devkit/modalix-devkit">
<img src={useBaseUrl('/img/media/modalix-devkit-no-label.png')} alt="Modalix DevKit" />
<h4>Modalix DevKit</h4>
<p>The current development kit for evaluating MLSoC Modalix and building applications on the Modalix SoM.</p>
<p>The current development kit for evaluating Modalix MLSoC and building applications on the Modalix SoM.</p>
</a>
<a className="card devkit-card" href="/hardware/devkit/modalix-pcie-card">
<img src={useBaseUrl('/img/media/modalix-ea-pcie.jpg')} alt="Modalix PCIe Card" />
Expand Down Expand Up @@ -111,7 +111,7 @@ SiMa.ai offers MLSoC Modalix-based development kits and PCIe products for edge A

## Deployment Architectures

MLSoC Modalix supports two common development architectures: standalone mode and PCIe mode. Choose the architecture that matches how your hardware is connected and where your application runs.
Modalix MLSoC supports two common development architectures: standalone mode and PCIe mode. Choose the architecture that matches how your hardware is connected and where your application runs.

<Tabs>
<TabItem value="standalone" label="Standalone Mode" default>
Expand All @@ -134,7 +134,7 @@ In standalone mode, a Modalix DevKit or a custom Modalix SoM-based system runs a

1. The DevKit receives data directly from network interfaces or sensors.
2. The DevKit loads a [NEAT application](https://developer.sima.ai/software) that defines the on-device inference pipeline.
3. MLSoC Modalix performs inferencing and processes the data locally.
3. Modalix MLSoC performs inferencing and processes the data locally.
4. Results are sent to other devices or systems via network connections for further action or visualization.

<a className="docs-button" href="/hardware/getting-started/standalone-mode">Set up standalone mode</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/isp-tuning.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 4

# ISP Tuning

The image signal processor (ISP) of MLSoC Modalix turns the raw data of a camera
The image signal processor (ISP) of Modalix MLSoC turns the raw data of a camera
sensor into the image that an application receives. Getting frames from a
camera and getting good images from it are two separate steps. This page says
what tuning is, which cameras are already tuned, and how to get the tuning
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/extra-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Understand the platform and confirm a product fits your application before divin

| Document | Description | Access | Download |
| --- | --- | --- | --- |
| **Modalix SoC Product Brief** | A high-level overview of the MLSoC Modalix silicon — the Machine Learning Accelerator (MLA), Image Signal Processor (ISP), Computer Vision Unit (CVU), video codecs, and I/O — with headline performance and power figures. A first read to assess whether Modalix suits your workload. | Public | [Download PDF](https://sima.ai/wp-content/uploads/2026/07/Modalix-MLSoC-Product-Brief_v1.5.pdf) |
| **Modalix SoC Product Brief** | A high-level overview of the Modalix MLSoC silicon — the Machine Learning Accelerator (MLA), Image Signal Processor (ISP), Computer Vision Unit (CVU), video codecs, and I/O — with headline performance and power figures. A first read to assess whether Modalix suits your workload. | Public | [Download PDF](https://sima.ai/wp-content/uploads/2026/07/Modalix-MLSoC-Product-Brief_v1.5.pdf) |
| **Modalix SoM Product Brief** | An overview of the Modalix System-on-Module — the SoC packaged with LPDDR5, power, and board-to-board connectors for product integration. Start here when scoping a custom design built around the SoM rather than a full DevKit. | Public | [Download PDF](https://sima.ai/wp-content/uploads/2026/07/Modalix-SoM-Product-Brief_v2.4-1.pdf) |
| **Modalix SoM DevKit 3.0 Product Brief** | A summary of the DevKit's features, interfaces, and form factor. Use it to confirm the kit matches your evaluation and prototyping needs before ordering. | Public | [Download PDF](https://sima.ai/wp-content/uploads/2026/07/Modalix-DevKit-Product-Brief_v1.2.pdf) |
| **Modalix HHHL PCIe Card Product Brief** | A summary of the PCIe card's features, memory options, interfaces, and form factor. Use it to confirm that the card fits your host system before ordering. | Public | [Download PDF](https://sima.ai/wp-content/uploads/2026/07/Modalix-PCIe-HHHL-Product-Brief_v1.6-1.pdf) |
Expand All @@ -38,7 +38,7 @@ The core references for integrating the Modalix SoM into your own board — pino
| --- | --- | --- | --- |
| **Modalix SoM Carrier Board Hardware Reference** | The primary guide for designing a carrier board around the Modalix SoM: connector pinouts, interface mapping, power delivery, and reference connections. Read this first when starting a custom board design. | SiMa.ai account | [Download PDF](https://docs.sima.ai/pkg_downloads/datasheets_product_briefs/SiMa_SOM_Carrier_Board_Data_Sheet_Rev1.2_1-24-2026.pdf) |
| **Modalix SoM Datasheet** | Detailed electrical, mechanical, and thermal specifications for the SoM — connector pinouts, power sequencing, current draw, and operating limits. The authoritative source for board-level design decisions. | SiMa.ai account | [Download PDF](https://docs.sima.ai/pkg_downloads/datasheets_product_briefs/Modalix_SOM_Board_v2_Data_Sheet_Rev2.3_10-12-2026.pdf) |
| **Modalix SoC Datasheet** | Detailed electrical, mechanical, and thermal specifications for the MLSoC Modalix die — pin functions, power rails, signal timing, and operating limits. Needed when designing at the silicon level rather than around the pre-integrated SoM. | On request | *Contact your SiMa.ai representative* |
| **Modalix SoC Datasheet** | Detailed electrical, mechanical, and thermal specifications for the Modalix MLSoC die — pin functions, power rails, signal timing, and operating limits. Needed when designing at the silicon level rather than around the pre-integrated SoM. | On request | *Contact your SiMa.ai representative* |
| **Carrier Board SoM Bring-Up Guide** | A step-by-step procedure for powering and validating a freshly built carrier board, from first power rails through a booting SoM, with checkpoints and common bring-up issues to watch for. | SiMa.ai account | [Download PDF](https://docs.sima.ai/pkg_downloads/datasheets_product_briefs/Modalix_SOM_Carrier_Board_Bring-Up_Guide_Rev1.3.2_6-15-2026.pdf) |

## Chip-down design
Expand Down
Loading
Loading