Hardware detection scanner

mbssrc commented 1 month ago

Description of changes

Adding a (temporary) hardware detection script to generate hardware definition files for different laptop hardware. The script can generate a Ghaf laptop target compatible hardware definition file (details below).

Main changes:

Add hardware-scan shell script to generate a hardware definition file
Add a laptop hardware scan target, minimal image without having to generate an image to flash
Change the udev rule generation for input devices. This is necessary to allow more input devices and rule auto-generation
Add a hardware definition for the Dell Latitude 7230 laptop

Checklist for things done

[x] Summary of the proposed changes in the PR description
[x] More detailed description in the commit message(s)
[x] Commits are squashed into relevant entities - avoid a lot of minimal dev time commits in the PR
[ ] Contribution guidelines followed
[ ] Ghaf documentation updated with the commit - https://tiiuae.github.io/ghaf/
[ ] PR linked to architecture documentation and requirement(s) (ticket id)
[x] Test procedure described (or includes tests). Select one or more:
- [x] Tested on Lenovo X1 x86_64
- [ ] Tested on Jetson Orin NX or AGX aarch64
- [ ] Tested on Polarfire riscv64
[ ] Author has run nix flake check --accept-flake-config and it passes
[x] All automatic Github Action checks pass - see actions
[x] Author has added reviewers and removed PR draft status

Instructions

Generate the hardware-scan package

nix build .#packages.x86_64-linux.hardware-scan
./result/bin/hardware-scan

or run directly with nix run github:tiiuae/ghaf/<commit>#hardware-scan

Generate and run hardware-scan on a laptop

Add your ssh key
Build target nix build .#laptop-hw-scan
Flash dd if=/result/iso/ghaf-... of=/dev/sdX bs=32M status=progress; sync
Boot, then type hardware-scan
The script should ask you if you want to select various devices for passthrough. If selected, the respective entries are generated. Note that there may be errors caused by IOMMU group dependencies.
Move the generated files to your development machine (e.g., scp -r nixos@<your-ip>:~/* local-dir/)
The script should generate a hardware definition profile, as well as a hwinfo/ folder with dumps from udevadm, lspci, etc.
Use the generated .nix as basis for your hardware definition

Few words of caution:

Don't fully rely on the generated output file, walk through all options that are being set
Currently, the host kernel module blacklist is commented out by default. Select the suggested modules carefully, and/or try without blacklisting
Uncomment required misc input devices, e.g., for acpi

Testing

Test builds of all lenovo-x1-carbon targets
Verify that input devices are working as before (although errors should result in not being able see GUI)
Perhaps run udevadm verify

(Optional) Feel free to run the hardware-scan on various targets and report any findings (Optional) Report any SKU identifiers to be added to the x1 definitions

brianmcgillion commented 1 month ago

the nix fmtproblem is from modules/hardware/laptop.nix. also because there is no file extension on hardware-scan there is a new WARN emitted:

❯ nix fmt
WARN format: no formatter for path: packages/hardware-scan/hardware-scan

nesteroff commented 1 month ago

That's a great script. It should be a lot easier to add new targets now.

I just wanted to mention that in #686, I added a service for hot-plugging that can also dynamically enumerate input devices, find those that are not defined statically and attach them to the GUIVM. Initially, I needed it so that hot-plugged devices survive a system reboot but it turns out that it can also work for non-USB devices. I'm currently testing it but it looks like everything continues to work on my X1 even when guivmVirtioInputHostEvdevModule is commented out.

mbssrc commented 1 month ago

That's a great script. It should be a lot easier to add new targets now.

I just wanted to mention that in #686, I added a service for hot-plugging that can also dynamically enumerate input devices, find those that are not defined statically and attach them to the GUIVM. Initially, I needed it so that hot-plugged devices survive a system reboot but it turns out that it can also work for non-USB devices. I'm currently testing it but it looks like everything continues to work on my X1 even when guivmVirtioInputHostEvdevModule is commented out.

Yes #686 is a good solution - I was actually just testing it now, may comment on it later. Getting rid of the static input device enumeration completely would simplify things a lot. My guess is that we have to keep the evdev module for some of the extra hardware dependencies though...

milva-unikie commented 1 month ago

Tested on Lenovo-X1 nix build github:mbssrc/ghaf/hw-tooling#lenovo-x1-carbon-gen11-debug and nix build github:mbssrc/ghaf/hw-tooling#lenovo-x1-carbon-gen11-debug-installer

Issues found:

I think there is something wrong with camera. With this PR it seems like the camera is not working in any of the vm:s (chromium, element and trusted browser). Restarting chromium did not claim it either.

Some background for camera: There is a known problem on Lenovo-X1 that only one vm can have access to the camera at a time. The vm seems to be chosen randomly at startup between chromium, element and trusted browser. If you restart a vm from host, restarted vm should claim the camera for itself (working at least for the browsers).

Working:

udevadm verify showed no fails
installer works
test-automation passes
integrated microphone and speaker work
3,5 mm headset works
all of the keyboard buttons that were working previously are still working (including F1, F2, F3, F5, F6 and PrtSc)
touchpad, trackpoint and mouse buttons work

Also tried running hardware scan on X1, no problems found.

mbssrc commented 1 month ago

Tested on Lenovo-X1 nix build github:mbssrc/ghaf/hw-tooling#lenovo-x1-carbon-gen11-debug and nix build github:mbssrc/ghaf/hw-tooling#lenovo-x1-carbon-gen11-debug-installer

Issues found:

I think there is something wrong with camera. With this PR it seems like the camera is not working in any of the vm:s (chromium, element and trusted browser). Restarting chromium did not claim it either.

Some background for camera: There is a known problem on Lenovo-X1 that only one vm can have access to the camera at a time. The vm seems to be chosen randomly at startup between chromium, element and trusted browser. If you restart a vm from host, restarted vm should claim the camera for itself (working at least for the browsers).

Working:
* `udevadm verify` showed no fails

* installer works

* test-automation passes

* integrated microphone and speaker work

* 3,5 mm headset works

* all of the keyboard buttons that were working previously are still working (including F1, F2, F3, F5, F6 and PrtSc)

* touchpad, trackpoint and mouse buttons work
Also tried running hardware scan on X1, no problems found.

Thanks - some part of the USB naming update got lost. Fixed now

milva-unikie commented 1 month ago

Camera is working now on Lenovo-X1!

tiiuae / ghaf