Re: [PATCH i-g-t v9 46/49] docs/unigraf: Add unigraf documentation

["Naladala, Ramanaidu" <Ramanaidu.naladala@intel.com>]

[-- Attachment #1: Type: text/plain, Size: 6833 bytes --]

Hi Louis Chauvet,

On 3/16/2026 9:48 PM, Louis Chauvet wrote:
> Add unigraf documentation to explain how to compile and use it with IGT.
>
> Signed-off-by: Louis Chauvet<louis.chauvet@bootlin.com>
> ---
>   docs/unigraf.txt | 81 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>   1 file changed, 81 insertions(+)
>
> diff --git a/docs/unigraf.txt b/docs/unigraf.txt
> new file mode 100644
> index 000000000000..37996a2ef98b
> --- /dev/null
> +++ b/docs/unigraf.txt
> @@ -0,0 +1,81 @@
> +Unigraf Support in IGT
> +========================
> +
> +This document provides information and instructions for Unigraf support in IGT.
> +
> +Introduction
> +------------
> +
> +Unigraf devices are a set of devices that can be used to test all sort of graphical
> +interface and signals. See Unigraf website for more information about all the
> +capabilities of each devices:https://unigraf.fi
> +
> +Unigraf documentation
> +---------------------
> +
> +All the documentation for libTSI, the library used to communicate with the unigraf,
> +can be found on unigraf website:https://www.unigraf.fi/downloads/
> +
> +Setting up Unigraf
> +------------------
> +
> +For most of the unigraf devices, this should be as simple as "plugging the
> +unigraf and plug the video cable". If you need to install some license, upgrade
> +the firmware... please take a look at the official unigraf documentation.
> +
> +Compiling IGT with Unigraf support
> +----------------------------------
> +
> +Unfortunately, the communication with the device use a proprietary library and the
> +underlying protocol is not open. To use the unigraf you need to install the unigraf
> +SDK, grab the libTSI.so and make it available on the build machine and the DUT.
> +
> +Deploying the Unigraf with IGT
> +------------------------------
> +
> +Unigraf may work out of the box: by default if IGT find a unigraf device, it will
> +try to connect and configure it to use USB-C input. This allows running most of
> +the existing tests without an actual screens.
> +
> +Here is a complete example configuration:
> +
> +        [Unigraf]
> +        # Choose a device using his name, you can find it in UCDConsole (installed with the SDK)
> +        Device=UCD-500 [2434C620]
> +        # Choose a role for the device, you can find it UCDConsole
> +        Role=USB-C, DP Alt Mode Source and Sink
> +        # Choose active input for the device
> +        Input=DP RX
Please document the required Input parameters(DP RX, USB RX) in the 
|igtrc| file for each supported *Role* type. When an input name is 
missing, misspelled, or incompatible with the selected Role, the 
function |unigraf_open_device()| triggers an assertion.
more log info:

Starting subtest: unigraf-connect-edid
(unigraf_connectivity:22870) unigraf/unigraf-CRITICAL: Test assertion failure function unigraf_open_device, file ../lib/unigraf/unigraf.c:495:
(unigraf_connectivity:22870) unigraf/unigraf-CRITICAL: Failed assertion: chosen_input >= 0
(unigraf_connectivity:22870) unigraf/unigraf-CRITICAL: Last errno: 2, No such file or directory
(unigraf_connectivity:22870) unigraf/unigraf-CRITICAL: TSI:0x5dad11372b90: Input DP RX not found.Subtest unigraf-connect-edid failed.
**** DEBUG ****
(unigraf_connectivity:22870) unigraf/unigraf-DEBUG: TSI:(nil): Initialize unigraf...
(unigraf_connectivity:22870) unigraf/unigraf-DEBUG: TSI:(nil): No connector name configured, will autodetect.
(unigraf_connectivity:22870) unigraf/unigraf-DEBUG: TSI:(nil): Detected unigraf device 0: UCD-500 [2607C673]
(unigraf_connectivity:22870) unigraf/unigraf-DEBUG: TSI:0x5dad11372b90: Successfully opened the unigraf device 0.
(unigraf_connectivity:22870) unigraf/unigraf-DEBUG: TSI:0x5dad11372b90: Role 0: DisplayPort Source and Sink
(unigraf_connectivity:22870) unigraf/unigraf-DEBUG: TSI:0x5dad11372b90: Role 1: DisplayPort Source and USB-C, DP Alt Mode Sink
(unigraf_connectivity:22870) unigraf/unigraf-DEBUG: TSI:0x5dad11372b90: Role 2: DisplayPort Sink and USB-C, DP Alt Mode Source
(unigraf_connectivity:22870) unigraf/unigraf-DEBUG: TSI:0x5dad11372b90: Role 3: USB-C, DP Alt Mode Source and Sink
(unigraf_connectivity:22870) unigraf/unigraf-DEBUG: TSI:0x5dad11372b90: Input 0: USB-C RX
(unigraf_connectivity:22870) unigraf/unigraf-CRITICAL: Test assertion failure function unigraf_open_device, file ../lib/unigraf/unigraf.c:495:
(unigraf_connectivity:22870) unigraf/unigraf-CRITICAL: Failed assertion: chosen_input >= 0
(unigraf_connectivity:22870) unigraf/unigraf-CRITICAL: Last errno: 2, No such file or directory
(unigraf_connectivity:22870) unigraf/unigraf-CRITICAL: TSI:0x5dad11372b90: Input DP RX not found.Stack trace:
(unigraf_connectivity:22870) igt_core-INFO:   #0 ../lib/igt_core.c:2108 __igt_fail_assert()
(unigraf_connectivity:22870) igt_core-INFO:   #1 [unigraf_open_device+0xb8e]
(unigraf_connectivity:22870) igt_core-INFO:   #2 ../lib/unigraf/unigraf.c:532 unigraf_require_device()
(unigraf_connectivity:22870) igt_core-INFO:   #3 ../tests/unigraf/unigraf_connectivity.c:58 __igt_unique____real_main35()
(unigraf_connectivity:22870) igt_core-INFO:   #4 ../tests/unigraf/unigraf_connectivity.c:35 main()
(unigraf_connectivity:22870) igt_core-INFO:   #5 ../sysdeps/nptl/libc_start_call_main.h:74 __libc_start_call_main()
(unigraf_connectivity:22870) igt_core-INFO:   #6 ../csu/libc-start.c:128 __libc_start_main@@GLIBC_2.34()
(unigraf_connectivity:22870) igt_core-INFO:   #7 [_start+0x25]
****  END  ****


> +        # Set the connector name used by the unigraf device. If not set, IGT will try to
> +        # autodetect which connector is used.
> +        Connector=DP-2
> +        # Set the EDID used by Unigraf
> +        EDID=DEL_16543_DELL_P2314T_DP
> +        # Enable or disable the use of Unigraf's CRCs instead of the CRTC CRCs
> +        UseCRC=1
> +        # Set the number of emulated MST streams (0 = Single Stream Transport, >=1 = MST)
> +        MSTStreams=0
> +
> +Current Support in IGT
> +----------------------
> +
> +Support for the Unigraf devices in IGT is found in the following places:
> +* lib/unigraf/unigraf.[ch] -> IGT API
> +* lib/unigraf/TSI.h -> Header for libTSI.so, not provided by Unigraf
> +* lib/unigraf/TSI_types.h -> Header containing all the relevant values from unigraf SDK. The unigraf SDK can't be used directly because it is only compatible with windows and c++.
> +
> +Current unigraf.c features are:
> +* Plug, unplug, hotplug pulse
> +* EDID management
> +* MST/SST stream management
> +* CRC calculation
> +
> +Current testing are:
> +* All igt tests that require a display and use a CRC (kms_plane, kms_cursor_crc, ...)
> +* Basic EDID and MST tests
> +
> +Planned tests:
> +* Link training scenarios (link rate, lane count, scrambling, ...)
> +* Bandwidth constraint management
> +* HDCP content protection
> +* Display stream compression
>

[-- Attachment #2: Type: text/html, Size: 8412 bytes --]