The vxprj Utility

The vxprj Utility

Learning Objectives

After this section you will be able to:

  • Apply vxprj commands to your projects
  • Import a project made with vxprj into workbench

Overview of the vxprj Utility

VxWorks provides the vxprj utility to create, manage, and build VxWorks projects. It is accessible through the command-line interface (CLI) and can be launched inside and outside Workbench. In the case of using it externally, you must import the project into Workbench.

This section will contain multiple code blocks showing the results of using vxprj commands.

Getting Help for vxprj

Vxprj has multiple help commands that cover all of its utilities. This short guide will show you how to use the most common ones.

  • To view the vxprj command groups and general help commands, type vxprj help (or just vxprj).
  • vxprj help
  • To get help with project commands, type vxprj project help
  • vxprj vip help
  • To get help for a specific subcommand, type vxprj project subcommand help
  • vxprj vip help

It's time to learn about how to manage your project with vxprj.

Managing Projects with the vxprj Utility

In this section, you'll examine some example commands that you can use with the vxprj utility. In the next few examples, the project will have a VSB called myVSB, a VIP called myVIP, and lastly it will use the board xlnx_zynqmp_3_0_0_1.

  • You can create a project with the vxprj project create commands.
  • vxprj utility
  • You can configure VSB options with the vxprj vxb config commands.
  • vxprj utility
  • You can configure VIP components with the vxprj vip component add command.
  • vxprj utility
  • You can build a project with the vxprj project build commands.
  • vxprj utility
  • To see a list of valid BSPs, execute the vxprj vsb listBsps command.
    To see a list of valid CPUs, execute the vxprj vsb listCpus command.

Lastly, if you use vxprj externally you will need to import the project into Workbench. This section will explain that process.

Adding vxprj Projects to Workbench

import vxprj made projects into Workbench

Follow these steps to import you vxprj made projects into Workbench:

  1. In Workbench, select File > Import.
  2. Expand VxWorks and select a VSB or VIP project.
  3. Browse for the VSB directory.

Once a project is in Workbench, if you edit it with vxprj, the configuration changes will appear in Workbench automatically.