Skip to content

feat(linux): add DKMS support and document usage in README #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
julled wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(linux): add DKMS support and document usage in README #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,33 @@ For detailed information, see [macos/README.md](macos/README.md)

### 🐧 Linux

**Recommended: DKMS**

DKMS rebuilds and reinstalls the module automatically whenever your kernel is updated, so the driver keeps working across kernel upgrades without manual intervention.

1. Install DKMS and your kernel headers (e.g. on Debian/Ubuntu: `sudo apt install dkms linux-headers-$(uname -r)`).
2. Clone the repository and install it with DKMS (reads name/version from `dkms.conf`, so no need to pass them):
```bash
git clone https://github.com/mischa85/Ozzy
sudo dkms install ./Ozzy
```
3. Load the module immediately (DKMS autoloads it after reboot):
```bash
sudo modprobe snd-usb-ozzy
```

To uninstall, find the registered module/version with `dkms status`, then run `sudo dkms remove ozzy/<version> --all`.

To pick up driver source changes (e.g. `git pull`), DKMS copied your source at install time so it won't see edits on its own — reinstall to refresh it:
```bash
sudo dkms remove ozzy/1.0.0 --all
sudo dkms install ./Ozzy
```

**Manual build (no DKMS)**

Without DKMS, the module must be rebuilt by hand after every kernel update.

1. Clone and build:
```bash
git clone https://github.com/mischa85/Ozzy
Expand Down Expand Up @@ -325,6 +352,7 @@ Whether you need to support your own legacy hardware or understand how professio
**Linux module issues?**
- Check kernel logs: `dmesg | grep ozzy`
- Verify module loaded: `lsmod | grep snd_usb_ozzy`
- DKMS build failing? Run `sudo dkms status` to see the module/version, then check the build log at `/var/lib/dkms/ozzy/<version>/build/make.log`

**Reporting Issues:**
When filing a bug report, please include:
Expand Down
11 changes: 11 additions & 0 deletions dkms.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
PACKAGE_NAME="ozzy"
PACKAGE_VERSION="1.0.0"

BUILT_MODULE_NAME[0]="snd-usb-ozzy"
BUILT_MODULE_LOCATION[0]="linux"
DEST_MODULE_LOCATION[0]="/kernel/sound/usb/ozzy"

MAKE[0]="make -C linux KERNELDIR=/lib/modules/${kernelver}/build"
CLEAN="make -C linux KERNELDIR=/lib/modules/${kernelver}/build clean"

AUTOINSTALL="yes"