Wrapping your Custom IP with AXI Packaging and Linux Driver Tutorial

Introduction

This tutorial covers the essentials steps in packaging your own intellectual property (IP) core with an AXI wrapper that can then be used with AMD Vivado™ for different projects. It also covers the steps to develop and integrate a Linux driver for that IP.
This tutorial will be using the AXI 1-Wire Host design as an example of how to package an IP and develop a Linux driver. The reference files are publicly available here:

• Packaged 1-Wire Host IP Design: AMD AXI 1-Wire Host Design
• 1-Wire subsystem compatible Linux driver AMD AXI 1-Wire Driver
• 1-Wire HDL, constraint, and driver files: AXI Packaging and Linux Driver Tutorial reference file

The AMD Kria™ KD240 Drives Starter Kit is targeted to support this tutorial as it is equipped with a 1-Wire interface, but any other AMD platform with a processing system (PS) (such as an Arm processor or a soft processor like an AMD MicroBlaze™ or an AMD MicroBlaze™ V) can be used.

IMPORTANT
If you are using a platform not equipped with a dedicated 1-Wire interface, use an external pull-up resistor as stated by the 1-Wire device manufacturer.

Before You Begin

Required tools:

• Host machine with Linux installed (refer to the PetaLinux Tools Documentation: Reference Guide (UG1144) (for the supported OS)
• AMD Vivado™ Design Suite 2024.2
• AMD Vitis™ Unified Software Platform 2024.2
• AMD PetaLinux Tools 2024.2
• TFTP server configured on your Linux machine (refer to Setting-Up-TFTP-Server-for-PetaLinux)

Accessing the Tutorial Reference files

In the terminal, enter the git clone https://github.com/Xilinx/axi-packaging-and-linux-driver.git command.

Tutorial Overview

1. AXI IP Packaging: Goes over the steps to properly package an AXI IP using the Vivado Design Suite.
2. Baremetal Driver Development: Walks through the process of developing a baremetal driver for the packaged AXI IP using the Vitis Unified Software Platform.
3. Linux Driver Design and Deployment: Shows how to develop a general Linux driver for the packaged AXI IP using the AMD PetaLinux Tools and how to deploy it.

Start the next step: AXI IP Packaging

_{Copyright © 2025 Advanced Micro Devices, Inc.}

^{Terms and Conditions}