From 69acc5f3928f0578438cefdd69b39bc05bb0769b Mon Sep 17 00:00:00 2001 From: duerpei Date: Thu, 14 Apr 2022 10:01:20 +0800 Subject: Readme: Correct some spelling mistakes Bug-AGL:SPEC-4325 Signed-off-by: duerpei Change-Id: I3a315c9c17a1745554b08f277399564104f37fac --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 84af0a7..aa6cc2d 100644 --- a/README.md +++ b/README.md @@ -47,18 +47,18 @@ So, for example, a DRM lease for the first LVDS device on the device `/dev/dri/c ### Dynamic lease transfer When `drm-lease-manager` is started with the `-t` option, the -ownership of a leases resourses can be transfered from +ownership of a leases resources can be transferred from one client to another. This allows the ownership of the leased resources to be transferred without the display being closed and the screen blanking. -`drm-lease-manager` handles the timing of the tranfser and manages the +`drm-lease-manager` handles the timing of the transfer and manages the references to the DRM device, so that the last framebuffer of the old client stays on screen until the new client presents its first frame. The transition can be completed without direct communication between the old and new client applications, however, the client that the lease will be -transitioned *from* must be able to handle unexpected lease revokation. +transitioned *from* must be able to handle unexpected lease revocation. Once the lease is revoked, all DRM API calls referring to the DRM resources managed by the lease will fail with -ENOENT. The client should be able to gracefully handle this condition by, for example, -- cgit From 17bf719d3b141142c6fa908485dec4ca5872fa83 Mon Sep 17 00:00:00 2001 From: Damian Hobson-Garcia Date: Tue, 5 Apr 2022 16:49:22 +0900 Subject: Update README to describe configuration file format Bug-AGL: SPEC-3815 Change-Id: I61d0fdea053ef1bd4f6b78838590636b6ce0ca6c Signed-off-by: Damian Hobson-Garcia --- README.md | 38 +++++++++++++++++++++++++++++++------- 1 file changed, 31 insertions(+), 7 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index aa6cc2d..f9a7650 100644 --- a/README.md +++ b/README.md @@ -24,18 +24,33 @@ The basic build procedure is as follows: `` can be any directory name, but `build` is commonly used. -## Running +## Configuration -Once installed, running the following command will start the DRM Lease Manager daemon +The drm-lease-manager configuration file allows the user to specify the mapping +of DRM connectors to DRM leases. The location of the configuration file can +be specified with the `--config` command line option. - drm-lease-manager [] +The configuration file consists of a list of lease definitions, containing a name +of the lease and a list of the included connector names. -If no DRM device is specified, `/dev/dri/card0` will be used. -More detailed options can be displayed by specifying the `-h` flag. +Each list entry is of the following form: -### Lease naming +```toml +[[lease]] +name="My lease" +connectors=["connector 1", "connector 2"] +``` +* Note: quotes around all string values are mandatory. + +This will create a lease named `My lease` and add the two connectors `connector 1` and +`connector 2` to the lease. +If there is no connector with either of the names exists on the system, that name +will be omitted from the lease. -One DRM lease will be created for each connector on the DRM device (up to the number of available CRTCs). +### Default configuration + +If no configuration file is specified one DRM lease will be created for each connector +on the DRM device (up to the number of available CRTCs). The names of the DRM leases will have the following pattern: @@ -44,6 +59,15 @@ The names of the DRM leases will have the following pattern: So, for example, a DRM lease for the first LVDS device on the device `/dev/dri/card0` would be named `card0-LVDS-1`. +## Running + +Once installed, running the following command will start the DRM Lease Manager daemon + + drm-lease-manager [] + +If no DRM device is specified, `/dev/dri/card0` will be used. +More detailed options can be displayed by specifying the `-h` flag. + ### Dynamic lease transfer When `drm-lease-manager` is started with the `-t` option, the -- cgit From 6a12fcc3821e913ca799ff8981d9415d0a251836 Mon Sep 17 00:00:00 2001 From: Damian Hobson-Garcia Date: Wed, 6 Apr 2022 18:11:38 +0900 Subject: Default to first modesettable DRM device When no DRM device is specified on the command line, try all available DRM devices until an available modesettable device is found. Bug-AGL: SPEC-3815 Change-Id: I72343558fcda755a63aee549767ccc8c00c06724 Signed-off-by: Damian Hobson-Garcia --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index f9a7650..458cdde 100644 --- a/README.md +++ b/README.md @@ -65,8 +65,8 @@ Once installed, running the following command will start the DRM Lease Manager d drm-lease-manager [] -If no DRM device is specified, `/dev/dri/card0` will be used. -More detailed options can be displayed by specifying the `-h` flag. +If no DRM device is specified, the first available device capabale of modesetting will +be used. More detailed options can be displayed by specifying the `-h` flag. ### Dynamic lease transfer -- cgit