Step 5: Add a Product Guide to the IP - 2024.1 English

Vivado Design Suite Tutorial: Creating and Packaging Custom IP (UG1119)

Document ID
UG1119
Release Date
2024-06-19
Version
2024.1 English
  1. On the left side of the Package IP window, select the File Groups item to display the File Groups page on the right side.

    The File Groups page provides a listing of the files to package as part of the IP, as shown in the following figure:



  2. Open the Messages window, and review the IP packager messages as seen in the following figure:

    The IP packager messages inform you of the state of the IP. The File Groups Wizard message indicates that the IP definition does not include any documentation.

    The Customization Parameters Wizard informs you that specific parameters of the IP do not have range values.

    As INFO messages, these are quick checks of the IP definition that do not prevent you from moving forward if you choose. However, in the next step you add the product guide to the IP definition.

    The Ports and Interfaces Wizard has warnings related to the inferred single-bit clock interfaces inferred by the IP packager for missing ASSOCIATED_BUSIF parameters. These parameters are required for AXI interfaces in the Vivado IP integrator. The reason for the warning is that the IP integrator tool works best with interfaces, and it expects that you would typically be using AXI interfaces. You do not have any bus interfaces in your design, and therefore, you can safely ignore this warning.

  3. In the Package IP window, right-click in the File Groups pane, and select Add File Group.
  4. In the Add IP File Group dialog box, select Product Guide from the Standard File Groups section, as shown in the following figure:

  5. Click OK.

    The IP File Groups page now updates with the Product Guide group in the list. There is a “0” next to the Product Guide name because there are no files added to the newly created group.

  6. Right-click the Product Guide file group, and select Add Files.
  7. In the opened Add IP Files (Product Guide) dialog box, click Add Files.
  8. Browse to <Extract_Dir>/lab_1/docs, and select All Files in the Files of type entry line.
  9. Select my_simple_uart_product_guide.pdf, and click OK.
  10. In the Add IP Files (Product Guide) dialog box, shown in the following figure, ensure that Copy sources into project is selected.

    The option ensures that the file imports into the project sources directory, and not remotely referenced by the IP packager.



  11. Click OK.

    The IP packager adds the PDF file of the Product Guide to the files defined as part of the IP, and resolves the Documentation Info check.