-
Notifications
You must be signed in to change notification settings - Fork 184
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.
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
module: add README with instructions on usage #453
Open
iam-TJ
wants to merge
1
commit into
DisplayLink:main
Choose a base branch
from
iam-TJ:evdi-module-readme
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# evdi kernel module | ||
When installing DisplayLink software using the provided installer or via distro-provided scripts some required configuration is written. When working with the module manually that configuration will not be created automatically. This is likely to cause failure of evdi to discover external DisplayLink devices and lead to much confusion. | ||
|
||
See the shell script `dkms_install.sh` and its `evdi_add_mod_options()` function for the steps required. | ||
|
||
In summary: | ||
|
||
1. Add module options (nmost importantly `initial_device_count=` ) | ||
2. Auto-load the module | ||
|
||
## Module options | ||
Typically `/etc/modprobe.d/evdi.conf` will contain two lines, the second being generated and system-specific: | ||
``` | ||
options evdi initial_device_count=4 | ||
softdep evdi pre: drm_kms_helper i915 | ||
``` | ||
Note: `softdep` above shows the host has an integrated Intel GPU (`i915`). | ||
|
||
## Auto-loading the module | ||
The `dkms_install.sh` script assumes the host is using systemd and adds the auto-load config in `/etc/modules-load.d/` that is used by `systemd-modules-load.service`. For hosts without systemd the convention for loading modules at start-up is via an entry in `/etc/modules`. `modules-load.d` usually has a symbolic link to this file. | ||
|
||
Adding `evdi` to `/etc/modules` therefore should work for a broader range of possible init system scenarios. | ||
|
||
## Usage | ||
It is not obvious that `evdi` (as of v1.14.1) does not auto-detect and configure DisplayLink devices - something one might expect it to do. For that reason the module option `initial_device_count` is required for automatic discovery at load-time. | ||
|
||
Alternatively one can manually add outputs with: | ||
``` | ||
# echo 1 > /sys/devices/evdi/add | ||
``` | ||
and confirm with: | ||
``` | ||
$ cat /sys/devivces/evdi/count | ||
``` | ||
and when in an Xorg session: | ||
``` | ||
$ xrandr --listproviders | ||
Providers: number : 2 | ||
Provider 0: id: 0x43 cap: 0x9, Source Output, Sink Offload crtcs: 3 outputs: 2 associated providers: 5 name:modesetting | ||
Provider 1: id: 0x789 cap: 0x2, Sink Output crtcs: 1 outputs: 1 associated providers: 1 name:modesetting | ||
``` | ||
Here `Provider 1` is the new output and if things work correctly a new output should appear: | ||
``` | ||
$ xrandr --query | ||
... | ||
DVI-I-1-1 disconnected (normal left inverted right x axis y axis) | ||
``` | ||
Once a monitor is detected the resolutions will be reported and GUI tools that manage displays should update to show the newly connected display. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.