Adding Logical Ports to the Interface - 2024.1 English

Vivado Design Suite User Guide: Creating and Packaging Custom IP (UG1118)

Document ID
UG1118
Release Date
2024-05-30
Version
2024.1 English

To add logical port to the interface, do the following:

  1. On the ports list, right-click and select Add Port.
    Alternatively, you can click the Add button on the toolbar. The following figure shows the Add Port dialog box.

  2. Enter the required information, as follows:
    Display Name
    The name of the logic port. In the AMD convention, these names are uppercase and are not prefixed with the name of the interface.
    Description
    Enter a human-readable description for the logical port. Any transaction signaling must be described.
    Default Value
    When the port is optional, IP integrator uses this default value to drive the in mode port when unconnected.
    Note: If this port is part of the control logic, and is optional, it is important that the value is set to allow transactions to continue and not stall.
  3. In the Master and Slave sections, set the following:
    Width
    Required bit width of the mapped port for master/slave mode bus interfaces exposed on an IP. Values are: –1 (undefined width), 1(single bit signal), or a fixed value.
    Presence
    Set to either required or optional, indicating if the logical port is required to be mapped in master/slave mode bus interfaces exposed on an IP. Allowed values are: optional, required, and illegal.
    Direction
    Required port mode when mapped for master/slave mode bus interfaces exposed on an IP. Values are in, out, and inout.
    Note: Often the slave and master widths are the same.
    Important: Typically the slave and master directions are opposite. If the directions are the same, IP integrator might not be able to properly directly connect the master and slave.
  4. In the Type section, set the following:
    Address
    Check this option when the logical port serves as an address line.
    Data
    Check this option when the logical port carries data and is not a control, addressing, or clock/reset.
    Clock
    Check this option when the logical port is a clock line.
    Reset
    Check this option when the logical port is a reset line.
  5. Click OK.