Xilinx Driver PPA
##################

The `Xilinx Driver PPA`_ is used to deliver DKMS packages for drivers that
interface with Xilinx FPGA logic. These drivers often are not appropriate
for mainline Linux. Packages delivered through this PPA do not fall
under Ubuntu Archive support and maintenance.

Packages in this PPA are intended to run on `linux-xilinx-zynqmp`_

.. _linux-xilinx-zynqmp: https://launchpad.net/ubuntu/+source/linux-xilinx-zynqmp


.. warning:: This PPA is not checked for security or reliability by Ubuntu members.

Installing DKMS from Xilinx Driver PPA
****************************************

Follow the instructions on `Xilinx Driver PPA`_ , in the section `Adding this PPA to your system`.

The steps should look similar to:

   .. code-block:: bash

        sudo add-apt-repository ppa:xilinx-apps/xilinx-drivers
        sudo apt update


Once the PPA has been added and updated, you can install any of the packages provided
by the PPA. Simply run:

   .. code-block:: bash

        sudo apt install <DKMS package>

After installing the package, the kernel module may still need to be loaded using insmod.

Creating a new DKMS
********************

Follow the tutorial `Creating a new DKMS from an out-of-tree driver`_ to create
and build a new DKMS package.

The resulting changes to the out-of-tree driver repository should be committed back
to the repository. It is recommended that each release of the DKMS is tagged
in the git repository.

Uploading the package
**********************
Upload access to the Xilinx Driver PPA is restricted to Xilinx and Canonical. The following
steps assume that you are a member of the `Xilinx Apps team`_ in launchpad.

First, ensure you have GPG keys uploaded to Launchpad and available on your local
GPG key-ring. See `Getting Set Up`_ for more details.

Next sign the changes file generated in the previous step and upload it to the PPA.
Follow the instructions on `Xilinx Driver PPA`_ , in the section `Uploading packages to this PPA`
for the exact PPA path:

   .. code-block:: bash

        debsign <source.changes>
        dput ppa:xilinx-apps/xilinx-drivers <source.changes>

.. _Xilinx Driver PPA: https://launchpad.net/~xilinx-apps/+archive/ubuntu/xilinx-drivers
.. _Xilinx Apps team: https://launchpad.net/~xilinx-apps
.. _Getting Set Up: https://packaging.ubuntu.com/html/getting-set-up.html
.. _Creating a new DKMS from an out-of-tree driver: https://canonical-kteam-docs.readthedocs-hosted.com/en/public/tutorial/creating_dkms.html