OS, Driver, Library, and Processor Block Parameters - 2021.2 English

Vitis Unified Software Platform Documentation: Embedded Software Development (UG1400)

Document ID
UG1400
ft:locale
English (United States)
Release Date
2021-12-15
Version
2021.2 English

The following list shows the parameters that can be used in OS, driver, library, and processor blocks.

PROC_INSTANCE

This option is required for the OS associated with a processor instances specified in the hardware database, and is formatted as:

parameter PROC_INSTANCE = <instance_name>

All operating systems require processor instances to be associated with them. The instance name that is given must match the name specified in the hardware database.

HW_INSTANCE

This option is required for drivers associated with peripheral instances specified in the hardware database and is formatted as:

parameter HW_INSTANCE = <instance_name>

All drivers in software require instances to be associated with the drivers. Even a processor definition block should refer to the processor instance. The instance name that is given must match the name specified in the BD file.

OS_NAME

This option is needed for processor instances that have OSs associated with them and is formatted as:

parameter OS_NAME = standalone

OS_VER

The OS version is set using the OSVER option and is formatted as:

parameter OS_VER = 1.0

This version is specified as x.y, where x and y are digits. This is translated to the OS directory searched as follows:

OS_NAME_vx_y

The MLD (Microprocessor Library Definition) files needed for each OS should be named OS_NAME.mld and should be present in a subdirectory data/ within the driver directory. Refer to Microprocessor Library Definition (MLD) for more information.

DRIVER_NAME

This option is needed for peripherals that have drivers associated with them and is formatted as:

parameter DRIVER_NAME = uartlite

Library Generator copies the driver directory specified to the OUTPUT_DIR/ processor_instance_name/libsrc directory and compiles the drivers using makefiles provided.

DRIVER_VER

The driver version is set using the DRIVER_VER option, and is formatted as:

parameter DRIVER_VER = 1.0

This version is specified as x.y, where x and y are digits. This is translated to the driver directory searched as follows:

DRIVER_NAME_vx_y

The MDD (Microprocessor Driver Definition) files needed for each driver should be named DRIVER_NAME_v2_1_0.mdd and should be present in a subdirectory data/ within the driver directory. Refer to Microprocessor Driver Definition (MDD) for more information.

LIBRARY_NAME

This option is needed for libraries, and is formatted as:

parameter LIBRARY_NAME = xilmfs

The tool copies the library directory specified in the OUTPUT_DIR/processor_instance_name/libsrc directory and compiles the libraries using makefiles provided.

LIBRARY_VER

The library version is set using the LIBRARY_VER option and is formatted as:

parameter LIBRARY_VER = 1.0

This version is specified as x.y, where x and y are digits. This is translated to the library directory searched by the tool as follows:

LIBRARY_NAME_vx_y

The MLD (Microprocessor Library Definition) files needed for each library should be named LIBRARY_NAME.mld and should be present in a subdirectory data/ within the library directory. Refer to Microprocessor Library Definition (MLD) for more information.