PetaLinux

https://github.com/xilinx/petalinux
Admin
PetaLinux is an AMD embedded Linux development tool that provides command-line utilities and...
Tokens:7,713
Snippets:53
Trust Score:9.3
Update:6 months ago
Show doc for...
Tokens:
Raw
### Setup PetaLinux Live Tool

Source: https://github.com/xilinx/petalinux/blob/xlnx_rel_v2024.1/README.md

Maps dependencies as symbolic links from the PetaLinux installation area to the local repository.

```bash
./scripts/bash/livetool_setup.sh <PetaLinux Local/Shared Tool Path>
```

--------------------------------

### Install SDK Sysroot

Source: https://context7.com/xilinx/petalinux/llms.txt

Installs the SDK sysroot for cross-compilation and application development.

```bash
# Install SDK to default location
petalinux-package sysroot
# Installs: <PROJECT>/images/linux/sdk.sh to <PROJECT>/images/linux/sdk

# Install custom SDK to specific directory
petalinux-package sysroot --sdk /path/to/sdk.sh --dir /path/to/install-dir
```

--------------------------------

### Generate PetaLinux Git Patches

Source: https://github.com/xilinx/petalinux/blob/xlnx_rel_v2024.1/README.md

Standard syntax and example for creating formatted patches for the PetaLinux repository.

```bash
git format-patch -s --subject-prefix="PETALINUX][<BRANCH_NAME>][PATCH" -1
```

```bash
git format-patch -s --subject-prefix="PETALINUX][xlnx_rel_v2024.1][PATCH" -1
```

--------------------------------

### petalinux-package sysroot

Source: https://context7.com/xilinx/petalinux/llms.txt

Installs the SDK sysroot for cross-compilation and application development.

```APIDOC
## petalinux-package sysroot

### Description
Installs the SDK sysroot for cross-compilation and application development.

### Parameters
#### Options
- **--sdk** (path) - Optional - Path to the SDK script.
- **--dir** (path) - Optional - Path to the installation directory.
```

--------------------------------

### Boot via QEMU

Source: https://context7.com/xilinx/petalinux/llms.txt

Boots the system in QEMU emulator for development and testing without hardware.

```bash
# Boot prebuilt u-boot in QEMU
petalinux-boot qemu --prebuilt 2

# Boot prebuilt kernel in QEMU
petalinux-boot qemu --prebuilt 3

# Boot newly built u-boot in QEMU
petalinux-boot qemu --u-boot

# Boot newly built kernel in QEMU
petalinux-boot qemu --kernel

# Boot custom u-boot image
petalinux-boot qemu --u-boot /path/to/custom-u-boot.elf

# Boot custom kernel (platform-specific image format)
# ZynqMP/Versal: Image, Zynq: zImage, MicroBlaze: image.elf
petalinux-boot qemu --kernel /path/to/Image

# Boot kernel with custom device tree
petalinux-boot qemu --kernel /path/to/Image --dtb /path/to/system.dtb

# Boot with custom rootfs
petalinux-boot qemu --kernel --rootfs /path/to/rootfs.cpio.gz

# Disable GDB server in QEMU
petalinux-boot qemu --kernel --qemu-no-gdb
```

--------------------------------

### Package Boot Images

Source: https://context7.com/xilinx/petalinux/llms.txt

Creates bootable binaries like BOOT.BIN or MCS files for various AMD/Xilinx architectures.

```bash
# Package BOOT.BIN with u-boot (includes all required dependencies)
petalinux-package boot --u-boot

# Package BOOT.BIN with custom components for Zynq
petalinux-package boot --fsbl /path/to/fsbl.elf --fpga /path/to/bitstream.bit --u-boot

# Package BOOT.BIN for ZynqMP with PMUFW
petalinux-package boot --fsbl /path/to/fsbl.elf --fpga /path/to/bitstream.bit \
    --u-boot --pmufw /path/to/pmufw.elf

# Package BOOT.BIN for Versal with PLM and PSM firmware
petalinux-package boot --plm /path/to/plm.elf --psmfw /path/to/psmfw.elf \
    --u-boot --dtb

# Skip specific firmware (use 'no' to exclude)
petalinux-package boot --plm no --psmfw no --u-boot

# Package with custom DTB load address
petalinux-package boot --plm /path/to/plm.elf --psmfw /path/to/psmfw.elf \
    --u-boot --dtb --load 0x1000

# Package MCS file for flash programming
petalinux-package boot --u-boot --kernel --offset 0xF40000 --format MCS

# Package using custom BIF file (overrides other settings)
petalinux-package boot --bif /path/to/custom.bif

# Generate download.bit (bitstream merged with FSBL)
petalinux-package boot --fsbl /path/to/fsbl.elf --fpga /path/to/bitstream.bit \
    --format DOWNLOAD.BIT

# Specify output directory
petalinux-package boot --u-boot -o /path/to/output/
```

--------------------------------

### petalinux-boot qemu

Source: https://context7.com/xilinx/petalinux/llms.txt

Boots the system in QEMU emulator for development and testing without hardware.

```APIDOC
## petalinux-boot qemu

### Description
Boots the system in QEMU emulator for development and testing without hardware.

### Parameters
#### Options
- **--prebuilt** (int) - Optional - Boot prebuilt level.
- **--u-boot** (path) - Optional - Path to u-boot image.
- **--kernel** (path) - Optional - Path to kernel image.
- **--dtb** (path) - Optional - Path to device tree blob.
- **--rootfs** (path) - Optional - Path to rootfs.
- **--qemu-no-gdb** (flag) - Optional - Disable GDB server in QEMU.
```

--------------------------------

### Initialize PetaLinux Projects

Source: https://context7.com/xilinx/petalinux/llms.txt

Commands to create new projects from BSP files or platform templates. Use the --tmpdir flag when working on NFS to avoid performance or locking issues.

```bash
# Create project from a BSP file
petalinux-create project -s /path/to/my-board.bsp

# Create project from BSP with custom TMPDIR (required when project is on NFS)
petalinux-create project -s /path/to/my-board.bsp --tmpdir /local/tmp

# Create project from template for different platforms
petalinux-create project -n my-zynq-project --template zynq
petalinux-create project -n my-zynqmp-project --template zynqMP
petalinux-create project -n my-versal-project --template versal
petalinux-create project -n my-versal-net-project --template versal-net
petalinux-create project -n my-microblaze-project --template microblaze

# Force overwrite existing project directory
petalinux-create project -n my-project --template zynqMP --force
```

--------------------------------

### Configure System and Hardware

Source: https://context7.com/xilinx/petalinux/llms.txt

Commands to launch menuconfig interfaces or synchronize hardware definitions from Vivado exports.

```bash
# Configure project system settings (DTG, boot args, flash partitions, etc.)
petalinux-config

# Import/sync hardware description from Vivado export directory
petalinux-config --get-hw-description /path/to/vivado_export/

# Import specific XSA file when multiple exist in directory
petalinux-config --get-hw-description /path/to/vivado_export/system.xsa

# Configure Linux kernel with menuconfig
petalinux-config -c kernel
```

--------------------------------

### Boot via JTAG

Source: https://context7.com/xilinx/petalinux/llms.txt

Loads and boots images on target hardware via JTAG connection using XSDB.

```bash
# Boot prebuilt level 1 (download bitstream, FSBL, PMUFW)
petalinux-boot jtag --prebuilt 1

# Boot prebuilt level 2 (boot to u-boot)
petalinux-boot jtag --prebuilt 2

# Boot prebuilt level 3 (boot to kernel)
petalinux-boot jtag --prebuilt 3

# Boot u-boot from images/linux with bitstream
petalinux-boot jtag --u-boot --fpga

# Boot kernel from images/linux with bitstream
petalinux-boot jtag --kernel --fpga

# Boot with custom bitstream
petalinux-boot jtag --u-boot --fpga --bitstream /path/to/custom.bit

# Skip bitstream loading
petalinux-boot jtag --prebuilt 2 --fpga --bitstream no

# Boot custom u-boot image
petalinux-boot jtag --u-boot /path/to/custom-u-boot.elf

# Boot custom kernel with custom device tree
petalinux-boot jtag --kernel /path/to/Image --dtb /path/to/system.dtb

# Boot with custom rootfs
petalinux-boot jtag --kernel --rootfs /path/to/rootfs.cpio.gz

# Generate XSDB TCL script instead of booting
petalinux-boot jtag --kernel --fpga --tcl myboot.tcl

# Boot with verbose debug output
petalinux-boot jtag --kernel --fpga -v
```

--------------------------------

### PetaLinux Package Boot

Source: https://context7.com/xilinx/petalinux/llms.txt

Commands for packaging bootable image files, including BOOT.BIN and MCS files for flash programming.

```APIDOC
## petalinux-package boot

### Description
Creates bootable image files including BOOT.BIN for AMD devices and MCS files for flash programming.

### Method
CLI Command

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```bash
# Package BOOT.BIN with u-boot (includes all required dependencies)
petalinux-package boot --u-boot

# Package BOOT.BIN with custom components for Zynq
petalinux-package boot --fsbl /path/to/fsbl.elf --fpga /path/to/bitstream.bit --u-boot

# Package BOOT.BIN for ZynqMP with PMUFW
petalinux-package boot --fsbl /path/to/fsbl.elf --fpga /path/to/bitstream.bit \
    --u-boot --pmufw /path/to/pmufw.elf

# Package BOOT.BIN for Versal with PLM and PSM firmware
petalinux-package boot --plm /path/to/plm.elf --psmfw /path/to/psmfw.elf \
    --u-boot --dtb

# Skip specific firmware (use 'no' to exclude)
petalinux-package boot --plm no --psmfw no --u-boot

# Package with custom DTB load address
petalinux-package boot --plm /path/to/plm.elf --psmfw /path/to/psmfw.elf \
    --u-boot --dtb --load 0x1000

# Package MCS file for flash programming
petalinux-package boot --u-boot --kernel --offset 0xF40000 --format MCS

# Package using custom BIF file (overrides other settings)
petalinux-package boot --bif /path/to/custom.bif

# Generate download.bit (bitstream merged with FSBL)
petalinux-package boot --fsbl /path/to/fsbl.elf --fpga /path/to/bitstream.bit \
    --format DOWNLOAD.BIT

# Specify output directory
petalinux-package boot --u-boot -o /path/to/output/
```

### Response
N/A (Bootable image files generated)

#### Success Response (0)
N/A

#### Response Example
N/A
```

--------------------------------

### Connect XSDB to QEMU

Source: https://context7.com/xilinx/petalinux/llms.txt

Connects XSDB debugger to a running QEMU instance for hardware debugging.

```bash
# Connect XSDB to QEMU on localhost port 1234
petalinux-util xsdb-connect localhost:1234

# Connect with additional XSDB commands
petalinux-util xsdb-connect localhost:1234 "source myscript.tcl"
```

--------------------------------

### Build PetaLinux Projects

Source: https://context7.com/xilinx/petalinux/llms.txt

Commands for building the project, specific components, or managing build artifacts and caches.

```bash
# Build complete project (kernel, rootfs, device tree, bootloaders)
petalinux-build
# Output: <PROJECT>/images/linux/

# Build SDK installer for application development
petalinux-build --sdk
# Output: <PROJECT>/images/linux/sdk.sh

# Build extensible SDK (eSDK) with source modifications
petalinux-build --esdk
# Output: <PROJECT>/images/linux/esdk.sh

# Build with source archiver (for license compliance)
petalinux-build --archiver
# Output: <PROJECT>/images/linux/archiver.tar.gz

# Build kernel only
petalinux-build -c kernel

# Build rootfs only
petalinux-build -c rootfs

# Build specific application
petalinux-build -c myapp

# Force rebuild of kernel compile step
petalinux-build -c kernel -x compile -f

# Force deploy kernel
petalinux-build -c kernel -x deploy -f

# Clean u-boot and rebuild (removes sstate cache)
petalinux-build -c u-boot -x distclean

# Full project distclean
petalinux-build -x distclean

# Remove all build artifacts (images, build dir, workspace)
petalinux-build -x mrproper

# List available rootfs packages
petalinux-build -c rootfs -h

# Build with debug output
petalinux-build -D
```

--------------------------------

### Package Prebuilt Images

Source: https://context7.com/xilinx/petalinux/llms.txt

Commands to include bitstreams or custom files in the prebuilt images directory.

```bash
petalinux-package prebuilt --fpga /path/to/bitstream.bit

# Add custom file to prebuilt images
petalinux-package prebuilt --add myfile:images/myfile
```

--------------------------------

### Invoke DFU Utility for Firmware Updates

Source: https://context7.com/xilinx/petalinux/llms.txt

Use `petalinux-util dfu-util` to manage USB-based firmware updates on target devices. Options include downloading firmware, uploading from the device, and listing DFU-capable devices.

```bash
petalinux-util dfu-util -D firmware.bin
```

```bash
petalinux-util dfu-util -U backup.bin
```

```bash
petalinux-util dfu-util -l
```

--------------------------------

### Generate User Applications

Source: https://context7.com/xilinx/petalinux/llms.txt

Commands to create application recipes within a project. The --enable flag automatically adds the application to the build configuration.

```bash
# Create and enable a simple C application
petalinux-create apps -n myapp --enable
# Creates: <PROJECT>/project-spec/meta-user/recipes-apps/myapp

# Create C++ application
petalinux-create apps -n myapp --template c++ --enable

# Create autoconf-based application
petalinux-create apps -n myapp --template autoconf --enable

# Create application with remote git source
petalinux-create apps -n myapp --enable --srcuri "git://github.com/example/repo.git;protocol=https"

# Create application with tarball source
petalinux-create apps -n myapp --enable --srcuri "https://example.com/myapp.tar.gz"

# Create DFX application with user-provided device tree and bitstream
petalinux-create apps --template dfx_user_dts -n gpio --enable \
    --srcuri "/path/to/pl.dtsi /path/to/system.bit /path/to/shell.json"

# Create DFX full application for ZynqMP (generates dtsi from XSA)
petalinux-create apps --template dfx_dtg_zynqmp_full -n gpio --enable \
    --srcuri "/path/to/gpio.xsa /path/to/shell.json"

# Create DFX static application for Versal
petalinux-create apps --template dfx_dtg_versal_static -n static-app --enable \
    --srcuri "/path/to/static.xsa /path/to/shell.json"

# Create DFX partial application (requires static package reference)
petalinux-create apps --template dfx_dtg_versal_partial -n rprm-app --enable \
    --srcuri "/path/to/rprm.xsa /path/to/accel.json" --static-pn "static-app"
```

--------------------------------

### petalinux-boot jtag

Source: https://context7.com/xilinx/petalinux/llms.txt

Loads and boots images on target hardware via JTAG connection using XSDB.

```APIDOC
## petalinux-boot jtag

### Description
Loads and boots images on target hardware via JTAG connection using XSDB.

### Parameters
#### Options
- **--prebuilt** (int) - Optional - Boot prebuilt level (1, 2, or 3).
- **--u-boot** (path) - Optional - Path to u-boot image.
- **--kernel** (path) - Optional - Path to kernel image.
- **--fpga** (flag) - Optional - Include bitstream.
- **--bitstream** (path) - Optional - Path to custom bitstream.
- **--dtb** (path) - Optional - Path to device tree blob.
- **--rootfs** (path) - Optional - Path to rootfs.
- **--tcl** (path) - Optional - Path to XSDB TCL script.
- **-v** (flag) - Optional - Enable verbose debug output.
```

--------------------------------

### Package Prebuilt Images

Source: https://context7.com/xilinx/petalinux/llms.txt

Packages built images into the pre-built directory for distribution.

```bash
# Package prebuilt images from images/linux to pre-built/
petalinux-package prebuilt
```

--------------------------------

### PetaLinux Package Prebuilt

Source: https://context7.com/xilinx/petalinux/llms.txt

Commands for packaging built images into the pre-built directory for distribution with BSPs.

```APIDOC
## petalinux-package prebuilt

### Description
Packages built images into the pre-built directory for distribution with BSPs.

### Method
CLI Command

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```bash
# Package prebuilt images from images/linux to pre-built/
petalinux-package prebuilt
```

### Response
N/A (Images packaged into the pre-built directory)

#### Success Response (0)
N/A

#### Response Example
N/A
```

--------------------------------

### Package WIC Images

Source: https://context7.com/xilinx/petalinux/llms.txt

Generates SD card bootable WIC images, supporting custom partitions, boot files, and compression.

```bash
# Create WIC image with default images
petalinux-package wic
# Output: <PROJECT>/images/linux/petalinux-sdimage.wic

# Create WIC image in custom output directory
petalinux-package wic --outdir /path/to/output/

# Create WIC image with images from custom directory
petalinux-package wic --images-dir /path/to/custom-images/

# Specify partition sizes (boot,root)
petalinux-package wic --size 2G,4G

# Specify only root partition size (boot uses default 2G)
petalinux-package wic --size ,6G

# Add custom boot files to /boot partition
petalinux-package wic --bootfiles "boot.bin userfile1 userfile2"

# Copy and rename files to boot partition
petalinux-package wic --extra-bootfiles "uImage:kernel"

# Copy directory contents to boot partition
petalinux-package wic --extra-bootfiles "userfiles/*:user_boot"

# Use custom root filesystem
petalinux-package wic --rootfs-file /path/to/custom-rootfs.tar.gz

# Compress WIC image (xz, gzip, or bzip2)
petalinux-package wic --wic-extra-args="-c xz"

# Write WIC image to SD card
# sudo dd if=petalinux-sdimage.wic of=/dev/sdX conv=fsync
```

--------------------------------

### PetaLinux Package WIC

Source: https://context7.com/xilinx/petalinux/llms.txt

Commands for creating SD card bootable WIC images.

```APIDOC
## petalinux-package wic

### Description
Creates SD card bootable WIC images containing boot partition and root filesystem.

### Method
CLI Command

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```bash
# Create WIC image with default images
petalinux-package wic
# Output: <PROJECT>/images/linux/petalinux-sdimage.wic

# Create WIC image in custom output directory
petalinux-package wic --outdir /path/to/output/

# Create WIC image with images from custom directory
petalinux-package wic --images-dir /path/to/custom-images/

# Specify partition sizes (boot,root)
petalinux-package wic --size 2G,4G

# Specify only root partition size (boot uses default 2G)
petalinux-package wic --size ,6G

# Add custom boot files to /boot partition
petalinux-package wic --bootfiles "boot.bin userfile1 userfile2"

# Copy and rename files to boot partition
petalinux-package wic --extra-bootfiles "uImage:kernel"

# Copy directory contents to boot partition
petalinux-package wic --extra-bootfiles "userfiles/*:user_boot"

# Use custom root filesystem
petalinux-package wic --rootfs-file /path/to/custom-rootfs.tar.gz

# Compress WIC image (xz, gzip, or bzip2)
petalinux-package wic --wic-extra-args="-c xz"

# Write WIC image to SD card
# sudo dd if=petalinux-sdimage.wic of=/dev/sdX conv=fsync
```

### Response
N/A (WIC image file generated)

#### Success Response (0)
N/A

#### Response Example
N/A
```

--------------------------------

### petalinux-package prebuilt

Source: https://context7.com/xilinx/petalinux/llms.txt

Packages bitstreams and custom files into the project prebuilt images.

```APIDOC
## petalinux-package prebuilt

### Description
Packages bitstreams and custom files into the project prebuilt images.

### Parameters
#### Options
- **--fpga** (path) - Optional - Path to the bitstream file.
- **--add** (string) - Optional - Adds a custom file to prebuilt images in the format 'source:destination'.
```

--------------------------------

### Configure PetaLinux Projects

Source: https://context7.com/xilinx/petalinux/llms.txt

Use these commands to access configuration menus for the root filesystem, kernel, or BusyBox. The --silentconfig flag is useful for automated builds.

```bash
# Configure rootfs packages with menuconfig
petalinux-config -c rootfs

# Configure busybox
petalinux-config -c busybox

# Silent configuration (use defaults, skip GUI)
petalinux-config --silentconfig

# Configure with debug output
petalinux-config -c kernel -D
```

--------------------------------

### Submit Patches via Email

Source: https://github.com/xilinx/petalinux/blob/xlnx_rel_v2024.1/README.md

Command to send generated patch files to the AMD review address.

```bash
git send-email --to git@amd.com *.patch
```

--------------------------------

### Create Kernel Modules

Source: https://context7.com/xilinx/petalinux/llms.txt

Commands to generate kernel module recipes. Source files are managed within the meta-user layer.

```bash
# Create and enable a kernel module
petalinux-create modules -n mymodule --enable
# Creates: <PROJECT>/project-spec/meta-user/recipes-modules/mymodule

# Create module with external source files
petalinux-create modules -n mymodule --enable \
    --srcuri "/path/to/mymodule.c /path/to/Makefile"

# Create module in specific project directory
petalinux-create modules -n mydriver --enable -p /path/to/petalinux-project
```

--------------------------------

### Package BSPs

Source: https://context7.com/xilinx/petalinux/llms.txt

Creates redistributable Board Support Package (BSP) archives from existing projects.

```bash
# Create BSP from project
petalinux-package bsp -p /path/to/project --output MY-BOARD.BSP

# Include hardware project source in BSP
petalinux-package bsp -p /path/to/project \
    --hwsource /path/to/vivado-project --output MY-BOARD.BSP

# Exclude files listed in exclude file
petalinux-package bsp -p /path/to/project \
    --exclude-from-file /path/to/excludes.txt --output MY-BOARD.BSP

# Exclude workspace modifications from BSP
petalinux-package bsp -p /path/to/project --exclude-workspace --output MY-BOARD.BSP
```

--------------------------------

### PetaLinux Build

Source: https://context7.com/xilinx/petalinux/llms.txt

Commands for building the PetaLinux project, including full project builds, component-specific builds, SDK generation, and cleaning operations.

```APIDOC
## petalinux-build

### Description
Builds the entire project or specific components using BitBake. Generates bootable images, SDK installers, and source archives.

### Method
CLI Command

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```bash
# Build complete project (kernel, rootfs, device tree, bootloaders)
petalinux-build
# Output: <PROJECT>/images/linux/

# Build SDK installer for application development
petalinux-build --sdk
# Output: <PROJECT>/images/linux/sdk.sh

# Build extensible SDK (eSDK) with source modifications
petalinux-build --esdk
# Output: <PROJECT>/images/linux/esdk.sh

# Build with source archiver (for license compliance)
petalinux-build --archiver
# Output: <PROJECT>/images/linux/archiver.tar.gz

# Build kernel only
petalinux-build -c kernel

# Build rootfs only
petalinux-build -c rootfs

# Build specific application
petalinux-build -c myapp

# Force rebuild of kernel compile step
petalinux-build -c kernel -x compile -f

# Force deploy kernel
petalinux-build -c kernel -x deploy -f

# Clean u-boot and rebuild (removes sstate cache)
petalinux-build -c u-boot -x distclean

# Full project distclean
petalinux-build -x distclean

# Remove all build artifacts (images, build dir, workspace)
petalinux-build -x mrproper

# List available rootfs packages
petalinux-build -c rootfs -h

# Build with debug output
petalinux-build -D
```

### Response
N/A (Build artifacts generated in the project directory)

#### Success Response (0)
N/A

#### Response Example
N/A
```

--------------------------------

### Source PetaLinux Environment Settings

Source: https://context7.com/xilinx/petalinux/llms.txt

Source the PetaLinux environment settings before using PetaLinux commands. Supports both Bash and C Shell environments. A separate script is available for setting up a live tool development environment.

```bash
source /path/to/petalinux/settings.sh
```

```bash
source /path/to/petalinux/settings.csh
```

```bash
./scripts/bash/livetool_setup.sh /path/to/installed/petalinux
```

--------------------------------

### PetaLinux Package BSP

Source: https://context7.com/xilinx/petalinux/llms.txt

Commands for creating a redistributable BSP archive from a PetaLinux project.

```APIDOC
## petalinux-package bsp

### Description
Creates a redistributable BSP archive from a PetaLinux project.

### Method
CLI Command

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```bash
# Create BSP from project
petalinux-package bsp -p /path/to/project --output MY-BOARD.BSP

# Include hardware project source in BSP
petalinux-package bsp -p /path/to/project \
    --hwsource /path/to/vivado-project --output MY-BOARD.BSP

# Exclude files listed in exclude file
petalinux-package bsp -p /path/to/project \
    --exclude-from-file /path/to/excludes.txt --output MY-BOARD.BSP

# Exclude workspace modifications from BSP
petalinux-package bsp -p /path/to/project --exclude-workspace --output MY-BOARD.BSP
```

### Response
N/A (BSP archive file generated)

#### Success Response (0)
N/A

#### Response Example
N/A
```

--------------------------------

### Manage Recipes with Devtool

Source: https://context7.com/xilinx/petalinux/llms.txt

Wrapper for Yocto devtool commands to modify and develop recipes within a PetaLinux project.

```bash
# Modify a recipe for local development
petalinux-devtool modify linux-xlnx

# Add a new recipe
petalinux-devtool add myrecipe /path/to/source

# Finish modifications and update meta-user
petalinux-devtool finish linux-xlnx project-spec/meta-user

# Reset recipe to original state
petalinux-devtool reset linux-xlnx

# Build modified recipe
petalinux-devtool build linux-xlnx

# Deploy to target
petalinux-devtool deploy-target linux-xlnx root@192.168.1.100

# Search for recipes
petalinux-devtool search "*gstreamer*"

# Show recipe status
petalinux-devtool status

# Enable debug output
petalinux-devtool -D modify linux-xlnx
```

--------------------------------

### petalinux-util

Source: https://context7.com/xilinx/petalinux/llms.txt

Provides utility functions for debugging and connectivity.

```APIDOC
## petalinux-util

### Description
Provides utility functions for debugging and connectivity.

### Parameters
#### Commands
- **gdb** (path) - Debug application on target.
- **xsdb-connect** (string) - Connect XSDB to QEMU instance.
```

--------------------------------

### PetaLinux Configuration

Source: https://context7.com/xilinx/petalinux/llms.txt

Commands for configuring the PetaLinux project, including rootfs, busybox, kernel, and silent configuration options.

```APIDOC
## petalinux-config

### Description
Configures the PetaLinux project components using menuconfig or silent configuration.

### Method
CLI Command

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```bash
# Configure rootfs packages with menuconfig
petalinux-config -c rootfs

# Configure busybox
petalinux-config -c busybox

# Silent configuration (use defaults, skip GUI)
petalinux-config --silentconfig

# Configure with debug output
petalinux-config -c kernel -D
```

### Response
N/A (Interactive configuration or silent defaults)

#### Success Response (0)
N/A

#### Response Example
N/A
```

--------------------------------

### Upgrade PetaLinux Components

Source: https://context7.com/xilinx/petalinux/llms.txt

Upgrades PetaLinux tool components including eSDKs for different architectures.

```bash
# Upgrade all platform eSDKs from URL
petalinux-upgrade -u https://example.com/petalinux-updates/

# Upgrade all platform eSDKs from local directory
petalinux-upgrade -f /path/to/esdk-updates/

# Upgrade specific platform only (arm = Zynq)
petalinux-upgrade -u https://example.com/updates/ --platform arm

# Upgrade multiple platforms (arm, aarch64)
petalinux-upgrade -f /path/to/updates/ --platform arm aarch64

# Upgrade MicroBlaze eSDK only
petalinux-upgrade -f /path/to/updates/ --platform microblaze

# Upgrade System Device-Tree (SDT) eSDK for ZynqMP/Versal
petalinux-upgrade -f /path/to/updates/ --platform aarch64_dt

# Pass additional wget arguments for URL downloads
petalinux-upgrade -u https://secure.example.com/updates/ \
    --wget-args "--no-check-certificate"
```

--------------------------------

### petalinux-devtool

Source: https://context7.com/xilinx/petalinux/llms.txt

Wrapper for Yocto devtool commands to modify and develop recipes within a PetaLinux project.

```APIDOC
## petalinux-devtool

### Description
Wrapper for Yocto devtool commands to modify and develop recipes within a PetaLinux project.

### Parameters
#### Commands
- **modify** (string) - Modify a recipe.
- **add** (string) - Add a new recipe.
- **finish** (string) - Finish modifications.
- **reset** (string) - Reset recipe.
- **build** (string) - Build recipe.
- **deploy-target** (string) - Deploy to target.
```

--------------------------------

### Extract Bitstream from XSA File

Source: https://context7.com/xilinx/petalinux/llms.txt

Utilize `petalinux-util find-xsa-bitstream` to extract bitstream or PDI filename information from XSA hardware description files. You can use the project's default XSA or specify a particular XSA file.

```bash
petalinux-util find-xsa-bitstream
```

```bash
petalinux-util find-xsa-bitstream --xsa-file /path/to/system.xsa
```

--------------------------------

### petalinux-upgrade

Source: https://context7.com/xilinx/petalinux/llms.txt

Upgrades PetaLinux tool components including eSDKs for different architectures.

```APIDOC
## petalinux-upgrade

### Description
Upgrades PetaLinux tool components including eSDKs for different architectures.

### Parameters
#### Options
- **-u** (url) - Optional - URL for updates.
- **-f** (path) - Optional - Local directory for updates.
- **--platform** (string) - Optional - Target platform architecture.
- **--wget-args** (string) - Optional - Additional arguments for wget.
```

--------------------------------

### Debug with GDB

Source: https://context7.com/xilinx/petalinux/llms.txt

Provides a cross-compilation GDB wrapper for debugging applications on target.

```bash
# Launch GDB for ARM/Zynq target
petalinux-util gdb myapp.elf

# Launch GDB with specific project
petalinux-util gdb -p /path/to/project myapp.elf

# Connect to remote GDB server on target
petalinux-util gdb -iex "target remote 192.168.1.100:1234" myapp.elf
```
Tokens:
Raw