OpenCPI v2.4.8 Documentation (latest release)

All OpenCPI Releases

Main Documentation

It is highly recommended to read all of the Getting Started Guides in the order listed before reading the Developer or Additional Guides. If OpenCPI has already been installed, then you may skip the installation guide.

Release Notes
Changelog
Man Pages

Getting Started Guides

OpenCPI Installation Guide
OpenCPI User Guide

Developer Guides

OpenCPI Application Development Guide
OpenCPI Component Development Guide
OpenCPI RCC Development Guide
OpenCPI HDL Development Guide
OpenCPI Platform Development Guide

OpenCPI Component Best Practices

Additional Guides

Debugging Tools
FAQ
FPGA Vendor Tools Installation
Generic RF Interface
OpenCPI AXI Transport Performance Tuning
OpenCPI Documentation Writer
OpenCPI Ethernet Transport Performance Tuning
OpenCPI FSK Application
OpenCPI Glossary
OpenCPI Kernel Driver Functionality
OpenCPI OCCP Memory
OpenCPI SDP Buffer Workaround Notes
Vivado Usage

Briefings

Briefing 1 OpenCPI Introduction
Briefing 2 OpenCPI Development
Briefing 4 Component and Worker Overview
Briefing 5 OpenCPI Unit Test Framework Introduction
Briefing 6 OpenCPI RCC Development
Briefing 7 OpenCPI Unit Test Framework Details
Briefing 8 HDL Application Workers
Briefing 9 HDL Assemblies
Briefing 10 HDL Primitives
Briefing 11 Platform Development
Briefing 12 Device Support for FPGA Platforms
Briefing 13 Advanced Platform Development
Briefing 14 Digital Radio Controller
Briefing 15 ACI Overview
Briefing 16 Debugging Tools

Tutorials

Tutorial 1 Component Based Development Intro
Tutorial 2 Design HDL Assemblies
Tutorial 3 Develop RCC Worker
Tutorial 4 Third Party Libs in RCC Workers
Tutorial 5 Multiple Opcodes in RCC Workers
Tutorial 6 Create Simple HDL Worker
Tutorial 6hw Create Simple HDL Worker
Tutorial 7 Create HDL Primitives Worker
Tutorial 7hw Create HDL Primitives Worker
Tutorial 8 Create ThirdPartyCore HDL Worker
Tutorial 8hw Create ThirdPartyCore HDL Worker
Tutorial 9 Debug HDL Worker

Video Tutorials

OpenCPI - v2.1.0 Zedboard SD Card Artifacts
Framework Installation - Zedboard
Dynamically Change Frequency using DRC
DRC Transmit Release
Throughput Measurement Tests
Bug Fix DRC set gain to manual
Timegate Worker Test Application
Zedboard FMCOMMS2/3 Bug Fix
Upgrade Ettus E310 Software Platform
OSP Development Workshop

Core Project Documentation

Platform Project Documentation

Assets Project Documentation

AD9361 ADC
AD9361 ADC Sub
AD9361 Config
AD9361 Config Proxy
AD9361 DAC
AD9361 DAC Sub
AD9361 Data Sub
AD9361 SPI
Advanced Pattern
AGC Real
Capture v2
CDC Bits Tester
CDC Count Up Tester
CDC FIFO Tester
CDC Pulse Tester
CDC Single Bit Tester
CSTS To IQStream
CSWM To IQStream
Data Src
DC Offset Filter
FIFO
File Write Demux
GPI
GPO
IQ Imbalance Fixer
IQStream Max Calculator
IQStream To CSTS
IQStream To CSWM
IQstream to TimeIQ
Pattern v2
PCA9534
PCA9535
Si5338
Si5351
Socket Write
TimeIQ to IQstream
Timestamper SCDCD
Timestamper SCDCD csts
TMP100
Tx Event Ctrlr
TX Event Test
Zero Pad

Examples Project Documentation

Tutorial Project Documentation

AGC Complex
Complex Mixer Tutorial
Peak Detector
Time Demux

Analog OSP Documentation

E3xx OSP Documentation

E31x MIMO Filter
E31x MIMO XCVR AD5662
E31x MIMO XCVR AD5662 Test
E31x MIMO XCVR Filter Proxy Test
Ettus E31x Platform Worker

PlutoSDR OSP Documentation

Ettus OSP Documentation

Avnet Engineering OSP Documentation

Xilinx OSP Documentation

N3xx OSP Documentation

Epiq Solutions OSP Documentation

Hitech Global OSP Documentation

SDR Components Documentation