intel/display: adapt README to current implementation

This commit is contained in:
Christian Helmuth 2024-11-08 15:55:10 +01:00
parent 728ea95857
commit d104ca0561

View File

@ -4,15 +4,16 @@ Default behaviour
~~~~~~~~~~~~~~~~~
When no configuration is provided to the driver, it will enable all connectors
with attached displays and allocate for each display a discrete framebuffer.
It will use the highest resolution as provided by the BIOS or EDID information.
For each connector a separate Capture connection will be requested labeled
according to the connector name. When newly connected displays are detected
by the driver, the new connectors are enabled and another Capture session
labeled according to the connector will be requested.
with attached displays and allocate one shared framebuffer for all displays
(see non-discrete mode below). It will use the highest resolution as provided
by the BIOS or EDID information. For each discrete connector a separate
Capture connection will be requested labeled according to the connector name.
When newly connected displays are detected by the driver, the new connectors
are enabled and another Capture session labeled according to the connector
will be requested.
By default, on hotplug of a display, the current config of the driver will be
re-parsed and re-applied. This behaviour can be disabled by
re-parsed and re-applied. This behaviour can be disabled by
! <config apply_on_hotplug="no"/>
@ -30,21 +31,23 @@ in the configuration as follows:
The exported report has the following format:
! <connectors>
! <connector name="eDP-1" connected="true" brightness="50" width_mm="290" height_mm="170">
! <mode width="1920" height="1080" hz="60" id="1" preferred="true" used="true" width_mm="288" height_mm="165"/>
! ...
! </connector>
! <connector name="DP-1" connected="true" width_mm="280" height_mm="160">
! <mode width="1920" height="1200" hz="60" id="1" preferred="true" width_mm="280" height_mm="160"/>
! <mode width="1920" height="1080" hz="60" id="2" used="true" width_mm="278" height_mm="158"/>
! <mode width="1280" height="1024" hz="60" id="3"/>
! <mode width="1024" height="768" hz="60" id="4"/>
! ...
! </connector>
! <connector name="HDMI-A-1" connected="false"/>
! <merge name="mirror">
! <connector name="eDP-1" connected="true" brightness="50" width_mm="290" height_mm="170">
! <mode width="1920" height="1080" hz="60" id="1" preferred="true" used="true" width_mm="288" height_mm="165"/>
! ...
! </connector>
! <connector name="DP-1" connected="true" width_mm="280" height_mm="160">
! <mode width="1920" height="1200" hz="60" id="1" preferred="true" width_mm="280" height_mm="160"/>
! <mode width="1920" height="1080" hz="60" id="2" used="true" width_mm="278" height_mm="158"/>
! <mode width="1280" height="1024" hz="60" id="3"/>
! <mode width="1024" height="768" hz="60" id="4"/>
! ...
! </connector>
! <connector name="HDMI-A-1" connected="false"/>
! </merge>
! </connectors>
The physical dimension of the display is reported as width_mm and height_mm
The physical dimension of the display is reported as 'width_mm' and 'height_mm'
in millimeter per connector and if available, also per mode. The values can
be used as input to DPI calculations. The currently used mode of the connector
is tagged in the report explicitly.