quickpassthrough/README.md

# VFIO-enabler (name pending)
A project to simplify setting up GPU passthrough for [QuickEMU](https://github.com/quickemu-project/quickemu) and libvirt

Currently this project does NO MODIFICATIONS to your system, all it does is generate the files needed for testing inside `./config/`

You can use it by simply running
```bash
git clone https://github.com/HikariKnight/VFIO-enabler.git
cd VFIO-enabler
chmod +x ./vfio-setup
./vfio-setup
```

## Features
* General warning and info about what you will be needing
* Enable and configure vfio modules
* Configure 2nd GPU for GPU Passthrough
* Dump the selected GPU rom (as some cards require a romfile for passthrough to work), however no rom patching support planned.
* Enable and configure the correct kernel modules
* Provides you with the correct kernel arguments to add to your bootloader entry

## TODO
* ~~Everything~~
* ~~Show general warning to user and inform about making a backup and general expectations~~
* ~~Detect if user has an amd or intel CPU and provide the correct IOMMU kernel args based on that~~
* ~~Tell user to enable IOMMU (VT-d/AMD-v) on their motherboard and bootloader~~
* ~~Integrate ls-iommu and locate graphic cards and see what IOMMU group they are in~~
~~* Enable and configure vfio modules~~
* ~~Fetch the ID for the GPUs and generate the correct kernel arguments for grub and systemd-boot~~
* ~~Dump the GPU rom, just in case it will be needed for passthrough~~ (no rom patching planned due to complexity)
* Get help to actually make the scripts better
* A non hacky menu system? (I will need help by some bash wizards for this)
* Blacklist drivers? (some cards require blacklisting as softdep is not enoug`)
* Install vendor_reset kernel module? (maybe far future)
* Setup looking-glass? (far future maybe)

<br>

### Why bash?
I wanted the dependencies to be minimal without the need for compilation and not have a potential breaking change in the future (like with the transition from python2 to python3).

I know enough bash to make things work, but I am in no way a professional in writing bash scripts as I usually write python and golang.
update readme for public release 2022-02-27 13:56:39 -05:00			`# VFIO-enabler (name pending)`
Update reamde for public release 2022-02-27 13:58:00 -05:00			`A project to simplify setting up GPU passthrough for [QuickEMU](https://github.com/quickemu-project/quickemu) and libvirt`
Make a todo 2022-02-25 07:29:08 -05:00
update readme for public release 2022-02-27 13:56:39 -05:00			Currently this project does NO MODIFICATIONS to your system, all it does is generate the files needed for testing inside `./config/`

			`You can use it by simply running`
			```bash
			`git clone https://github.com/HikariKnight/VFIO-enabler.git`
			`cd VFIO-enabler`
			`chmod +x ./vfio-setup`
			`./vfio-setup`
			```
update readme 2022-02-27 11:20:09 -05:00
update readme 2022-02-27 13:06:59 -05:00			`## Features`
			`* General warning and info about what you will be needing`
			`* Enable and configure vfio modules`
			`* Configure 2nd GPU for GPU Passthrough`
			`* Dump the selected GPU rom (as some cards require a romfile for passthrough to work), however no rom patching support planned.`
			`* Enable and configure the correct kernel modules`
update readme for public release 2022-02-27 13:56:39 -05:00			`* Provides you with the correct kernel arguments to add to your bootloader entry`
Make a todo 2022-02-25 07:29:08 -05:00
			`## TODO`
cross some things off the todo list 2022-02-25 08:35:32 -05:00			`* ~~Everything~~`
			`* ~~Show general warning to user and inform about making a backup and general expectations~~`
update readme 2022-02-27 13:06:59 -05:00			`* ~~Detect if user has an amd or intel CPU and provide the correct IOMMU kernel args based on that~~`
cross some things off the todo list 2022-02-25 08:35:32 -05:00			`* ~~Tell user to enable IOMMU (VT-d/AMD-v) on their motherboard and bootloader~~`
update readme 2022-02-27 13:06:59 -05:00			`* ~~Integrate ls-iommu and locate graphic cards and see what IOMMU group they are in~~`
			`~~* Enable and configure vfio modules~~`
update readme for public release 2022-02-27 13:56:39 -05:00			`* ~~Fetch the ID for the GPUs and generate the correct kernel arguments for grub and systemd-boot~~`
update readme 2022-02-27 13:06:59 -05:00			`* ~~Dump the GPU rom, just in case it will be needed for passthrough~~ (no rom patching planned due to complexity)`
update readme for public release 2022-02-27 13:56:39 -05:00			`* Get help to actually make the scripts better`
update readme 2022-02-27 13:06:59 -05:00			`* A non hacky menu system? (I will need help by some bash wizards for this)`
update readme for public release 2022-02-27 13:56:39 -05:00			* Blacklist drivers? (some cards require blacklisting as softdep is not enoug`)
update readme 2022-02-26 18:09:21 -05:00			`* Install vendor_reset kernel module? (maybe far future)`
update readme for public release 2022-02-27 13:56:39 -05:00			`* Setup looking-glass? (far future maybe)`

			`<br>`

			`### Why bash?`
			`I wanted the dependencies to be minimal without the need for compilation and not have a potential breaking change in the future (like with the transition from python2 to python3).`

			`I know enough bash to make things work, but I am in no way a professional in writing bash scripts as I usually write python and golang.`