OpenAMP - OpenAMP - 2026.1 English - UG1186

Libmetal and OpenAMP User Guide (UG1186)

Document ID: UG1186
Release Date: 2026-06-24
Version: 2026.1 English

Overview
Introduction
Software Tools Requirements
Prerequisites
Introduction to the New Upstream remoteproc Driver
Attach-detach Feature in the remoteproc Subsystem
Libmetal
Overview
Access Devices with Libmetal
Start Libmetal Environment, Add, and Open the Devices
Register the Interrupt, Write, and Read Device Registers
Close Device and Close Libmetal Environment
Access IP Integrator and Shared Memory with Libmetal
Zynq UltraScale+ MPSoC IP Integrator Hardware
Shared Memory
AMD Libmetal AMP Demo
Build Libmetal Baremetal Firmware with AMD Vitis Unified IDE
Build Libmetal Firmware and Linux Application with Yocto Tools
Testing on Hardware
Straight Line Speculation Vulnerability
OpenAMP
Overview
Components in OpenAMP
Connection between OpenAMP and Libmetal
Writing a Simple OpenAMP Application
OpenAMP Demos
OpenAMP Quick Try
Building and Booting OpenAMP Images
Linux Boot from U‑Boot and OpenAMP Application Run
Running the Demos
Demo to Run Zephyr on R52-0 for Versal-2ve-2vm
Build and Run the OpenAMP Zephyr Demo (Quick Try)
Yocto Project Build
Running the Demo
Building OpenAMP Application for RPU Firmware
Introduction
Building Remote Applications in AMD Vitis
Create and Build OpenAMP Applications in Vitis (Unified IDE)
OpenAMP AMD Vitis Key Source Files
Running the Example Applications
Running the Echo Test
Running the Matrix Multiplication Test
Running the Proxy Application
Debugging an OpenAMP Application
Debugging RPU Firmware
Creating a Boot.bin File
Testing on Hardware
Deprecated Platforms for OpenAMP
System Design Consideration
Supported Configuration
Other Considerations
Known Limitations
Linux RPMsg Buffer Size
Libmetal APIs
Libmetal API Functions
APU and RPU (Zephyr) Communication
Overview
Prerequisites
Linux Kernel Configuration
RPU (Zephyr) Device Tree Requirements
RootFS Requirements
Boot Mode: DDR ELF Loading
Resource Table
Establishing IPC Communication Through RPMsg
Establishing Interrupt Communication Using AMD IPIs
Summary and Quick Reference
Boot Flow Diagram
RPMsg Message Flow Sequence
XSA to Zephyr Device Tree with OpenAMP
Overview
One Shot Build from XSA to Zephyr RPU DT with OpenAMP Nodes
Connecting Gen Machine Conf Generated Device Trees to the Build
Workflow Overview
Phase 1: XSA to SDT Generation
Phase 2: SDT to Zephyr Device Tree Transformation
Lopper Step 1: Apply OpenAMP YAML Overlay
Lopper Step 2: Generate OpenAMP Nodes
Lopper Step 3: R52 Address Map Formatting (IMUX)
Lopper Step 4: Zephyr Domain Formatting
Installing Custom Firmware into EDF Yocto Linux Images
Overview
Primary Workflow (Recommended for Production)
Example: OpenAMP RPU Zephyr Firmware on VEK385 RevB
Prebuilt Common MACHINE Workflow (Special Case)
Using Custom Firmware with Prebuilt Common Images
Summary
OpenAMP and Libmetal Domain YAML Reference Guide
OpenAMP Domain YAML
Overview
YAML Structure and Field Reference
What Lopper Generates from OpenAMP YAML
Default Resource Allocations by SoC
Writing Your Own OpenAMP Domain YAML
Step One: Choose a Starting Template
Step Two: Define Reserved Memory Regions
Step Three: Configure the Host Domain
Step Four: Define the Remoteproc Relation
Step Five: Define the RPMsg Relation (Host Side)
Step Six: Configure the Remote Domain
Step Seven: Validate Your YAML
Step Eight: Integrate with Your Yocto Build
Complete OpenAMP Example (Versal AI Edge Series Gen 2)
Libmetal Domain YAML
Overview
YAML Structure and Field Reference
What Lopper Generates from Libmetal YAML
Complete Libmetal Example (Versal AI Edge Series Gen 2)
Domain Access YAML Files
Lopper Processing Pipeline and Direct Invocations
Quick Reference: Field Comparison
OpenAMP APIs
OpenAMP Library APIs
Additional Resources and Legal Notices
Finding Additional Documentation
Support Resources
References
Revision History
Please Read: Important Legal Notices

Back to home page