VFIO Script

Pre-Development

Install and uninstall a VFIO setup on a Linux machine. Choose between a dynamic, GRUB, or static setup.

View this repository on Codeberg or GitHub.

Table of Contents

• 1. Related Projects
• 2. Documentation
• 3. Download
• 4. Contact
• 5. References
• 6. Planned Features

Contents

1. Related Projects

To view other relevant projects, visit Codeberg or GitHub.

2. Documentation

• What is VFIO?^[2]
• VFIO Discussion and Support^[3]
• Hardware-Passthrough Guide^[1]
• Virtual Machine XML Format Guide^[4]

3. Download

• Download the Latest Release: Codeberg or GitHub.

• Download the .zip file:

  1. Viewing from the top of the repository's (current) webpage, click the drop-down icon:
     • ··· on Codeberg.
     • <> Code on GitHub.
  2. Click Download ZIP and save.
  3. Open the .zip file, then extract its contents.

• Clone the repository:

  1. Open a Command Line Interface (CLI) or Terminal.
     • Open a console emulator (for Debian systems: Konsole).
     • Linux only: Open an existing console: press CTRL + ALT + F2, F3, F4, F5, or F6.
       • To return to the desktop, press CTRL + ALT + F7.
       • F1 is reserved for debug output of the Linux kernel.
       • F7 is reserved for video output of the desktop environment.
       • F8 and above are unused.
  2. Change your directory to your home folder or anywhere safe:
     • cd ~
  3. Clone the repository:
     • git clone https://www.codeberg.org/portellam/vfio-script
     • git clone https://www.github.com/portellam/vfio-script

4. Contact

Did you encounter a bug? Do you need help? Please visit the Issues page (Codeberg, GitHub).

5. References

1.

  PCI passthrough via OVMF. ArchWiki. Accessed June 14, 2024.

    ^{https://wiki.archlinux.org/title/PCI_passthrough_via_OVMF.}

2.

  VFIO - ‘Virtual Function I/O’ - The Linux Kernel Documentation. The linux kernel. Accessed June 14, 2024.

    ^{https://www.kernel.org/doc/html/latest/driver-api/vfio.html.}

3.

  VFIO Discussion and Support. Reddit. Accessed June 14, 2024.

    ^{https://www.reddit.com/r/VFIO/.}

4.

  XML Design Format GitHub - libvirt/libvirt. Accessed June 18, 2024.

    ^{https://github.com/libvirt/libvirt/blob/master/docs/formatdomain.rst.}

5. Planned Features

• Isolate and migrate VFIO setup from Deploy VFIO and place here.
• Implement a dynamic/hooks based VFIO setup.

Click here to return to the top of this document.