[PATCH i-g-t v2 0/3] Documentation updates, with chamelium and audio

[PATCH i-g-t v2 0/3] Documentation updates, with chamelium and audio

[Paul Kocialkowski]

Changes since v1:
* Added a note about network timeouts when the Chamelium board is disconnected

_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx

[PATCH i-g-t v2 1/3] lib/igt_core: Use HTML character for documentation comment in example

[Paul Kocialkowski]

The gtkdoc output for the example configuration given in the file
confuses gtkdoc because of the use of # for comments, that is
interpreted as a headline (although it is an example block).

This uses the HTML character instead to ensure the rendering is correct.

Signed-off-by: Paul Kocialkowski <paul.kocialkowski@linux.intel.com>
---
 lib/igt_core.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/lib/igt_core.c b/lib/igt_core.c
index 58d64dc2..c8753a6f 100644
--- a/lib/igt_core.c
+++ b/lib/igt_core.c
@@ -235,12 +235,12 @@
  * An example configuration follows:
  *
  * |[<!-- language="plain" -->
- *	# The common configuration secton follows.
+ *	&num; The common configuration secton follows.
  *	[Common]
  *	FrameDumpPath=/tmp # The path to dump frames that fail comparison checks
  *
- *	# The following section is used for configuring the Device Under Test.
- *	# It is not mandatory and allows overriding default values.
+ *	&num; The following section is used for configuring the Device Under Test.
+ *	&num; It is not mandatory and allows overriding default values.
  *	[DUT]
  *	SuspendResumeDelay=10
  * ]|
-- 
2.14.0

_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx

[PATCH i-g-t v2 2/3] docs: Add user and developer documentation about Chamelium support

[Paul Kocialkowski]

This introduces plain-text documentation about the Chamelium aimed at
users who wish to deploy the platform, as well as developers who wish
to work on improving IGT support for it.

Given the contents of this documentation, it felt more relevant to make
it part of the tree instead of the API reference.

Signed-off-by: Paul Kocialkowski <paul.kocialkowski@linux.intel.com>
---
 docs/chamelium.txt | 153 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 153 insertions(+)
 create mode 100644 docs/chamelium.txt

diff --git a/docs/chamelium.txt b/docs/chamelium.txt
new file mode 100644
index 00000000..d3704b62
--- /dev/null
+++ b/docs/chamelium.txt
@@ -0,0 +1,153 @@
+Chamelium Support in IGT
+========================
+
+This document provides information, instructions and a tasks list for Chamelium
+support in IGT.
+
+Introduction
+------------
+
+The Chamelium is a platform that acts as a display monitor emulator. It provides
+advanced access and control over the various signals a display receives.
+
+As such, it allows testing display features that can otherwise not be tested in
+IGT without external hardware.
+
+The platform was developed by Google in order to test display and audio-related
+features of ChromeOS devices. It was initially developed internally by Google as
+part of the ChromeOS effort under the name Chameleon and was later made external
+as part of the ChromiumOS effort, under the name Chamelium.
+
+It consists of a custom-made display emulator board connected to an Arrow SoCKit
+via a flexible cable, with two DisplayPort connectors, one HDMI and one VGA.
+
+The SoCKit uses a Cyclone V SoC, with both a FPGA and an ARM CPU. While the FPGA
+is used for logic control, the CPU runs daemons that allow the board to be
+controlled over the network via a XMLRPC interface.
+
+Documentation
+-------------
+
+Documentation about the Chamelium is made available by Google through the
+ChromiumOS projet wiki: https://www.chromium.org/chromium-os/testing/chamelium
+
+Deploying the Chamelium With IGT
+--------------------------------
+
+Instructions from the ChromiumOS wiki detail how to setup the Chamelium:
+https://www.chromium.org/chromium-os/testing/chamelium#TOC-Setting-up-Chamelium
+
+The should be followed up until the "Setup your Linux host, DUT and the FPGA"
+section. At this point, IGT has to be configured to connect to the Chamelium.
+
+It may be necessary to give the Chamelium a static IP address, depending on
+the network setup. This can be configured (via the serial console) by editing
+the Debian-styled /etc/network/interfaces configuration file.
+
+Chamelium support requires setting up dedicated IGT configuration, as explained
+in the Core and Chamelium parts of the IGT API Reference in the documentation.
+
+Note that running the chamelium tests with the Chamelium configuration deployed
+and the Chamelium disconnected or unreachable will result in network timeouts
+that take seconds. It is thus preferable (especially in the case of an automated
+CI system with a shared testlist) to remove the Chamelium configuration from the
+hosts that shouldn't connect to the Chameliun so that they can be skipped, which
+is faster than a network timeout.
+
+An example fully-featured configuration follows:
+[Common]
+FrameDumpPath=/root/
+
+[Chamelium]
+URL=http://192.168.72.1:9992
+
+[Chamelium:DP-1]
+ChameliumPortID=1
+
+[Chamelium:HDMI-A-2]
+ChameliumPortID=3
+
+[Chamelium:VGA-1]
+ChameliumPortID=4
+
+[DUT]
+SuspendResumeDelay=2
+
+Debugging the Chamelium
+-----------------------
+
+Logs that may be useful for debugging can be obtained either by connecting to
+the board via SSH or serial console and looking at the daemon logs from
+/var/log, such as:
+$ tail -f /var/log/chameleon*
+
+Daemon Source, Build and Deploy
+-------------------------------
+
+Source code for the daemon running on the Chamelium is available at:
+https://chromium.googlesource.com/chromiumos/platform/chameleon/
+
+Building the daemon requires a GNU EABI ARMv7 GCC toolchain, that must be
+specified via the CC variable, such as:
+$ make CC=arm-linux-gnueabihf-gcc
+
+The result can be deployed to the chamelium with the remote-install target and
+specifying the network address for the chamelium via the CHAMELEON_HOST
+variable, such as:
+$ make remote-install CHAMELEON_HOST=192.168.72.1
+
+The process requires the Chamelium to be connected to the Internet to succeed.
+
+Contributing Changes to the Daemon
+----------------------------------
+
+Contributions to the Chamelium daemon, just like any contribution to ChromiumOS,
+are submitted and reviewed at: https://chromium-review.googlesource.com/
+
+The ChromiumOS project provides an extensive developer guide:
+https://www.chromium.org/chromium-os/developer-guide that assumes running within
+the ChromiumOS build system. Since this is likely not the case for contributing
+to the Chamelium daemon, only the part about uploading changes is relevant:
+https://www.chromium.org/chromium-os/developer-guide#TOC-Upload-your-changes-and-get-a-code-review
+
+Most of the process is about using the Gerrit web interface for submitting and
+having the change reviewed and not forgetting the Change-Id, TEST= and BUG=
+fields in the commit.
+
+Current Support in IGT
+----------------------
+
+Support for the Chamelium platform in IGT is found in the following places:
+* lib/igt_chamelium.c: library with Chamelium-related helpers
+* tests/chamelium.c: sub-tests using the Chamelium
+
+As of late August 2017, the following features are tested by IGT:
+* Pixel-by-pixel frame integrity tests for DP and HDMI
+* Error-trend-based frame integrity tests for VGA
+* CRC-based frame integrity tests for DP and HDMI
+* Hotplug event simple tests for all interfaces
+* Hotplug event stressing tests, emulating a flaky cable for DisplayPort and
+  HDMI
+* Hotplug event during suspend test for all interfaces, either separately for
+  each interface or combined
+* EDID display identifier integrity check for all interfaces
+* EDID display identifier change during suspend for all interfaces
+
+Future Developments
+-------------------
+
+With the current generation of the hardware platform, support for testing a
+number of additional display features could be included as future developments,
+including:
+* Audio capture from HDMI and DP
+* High-bandwidth Digital Content Protection (HDCP) streaming to the display
+* Remote control forwarding (CEC) sent from the display
+* YUV colorspace for HDMI, instead of RGB
+* Partial testing of DP Multi-Stream Transport (MST) using an external MST hub
+  and the two available DP connectors of the platform
+
+While HDCP is already supported by the Chamelium daemon, features such as CEC
+and YUV are not and must be implemented there before any support for them can
+be added to IGT. Audio is supported by the Chamelium daemon for HDMI only and
+a way to retrieve the captured data via the XMLRPC interface needs to be added
+to the daemon.
-- 
2.14.0

_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx

[PATCH i-g-t v2 3/3] docs: Add user documentation about audio support

[Paul Kocialkowski]

This introduces plain-text documentation about the audio test, aimed at
users who wish to setup and run the audio tests.

Given the contents of this documentation, it felt more relevant to make
it part of the tree instead of the API reference.

Signed-off-by: Paul Kocialkowski <paul.kocialkowski@linux.intel.com>
---
 docs/audio.txt | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 docs/audio.txt

diff --git a/docs/audio.txt b/docs/audio.txt
new file mode 100644
index 00000000..158ad5d1
--- /dev/null
+++ b/docs/audio.txt
@@ -0,0 +1,45 @@
+Audio Support in IGT
+====================
+
+This document provides information and instructions about audio support in IGT.
+
+Introduction
+------------
+
+The audio test is aimed at testing the audio features of display connectors,
+such as HDMI.
+
+Test setup
+----------
+
+The setup required for the audio test consists of using an HDMI-VGA adapter with
+an audio-out 3.5 mm jack to extract the audio from the HDMI interface.
+The audio-out jack is connected back to the device-under-test's line-in.
+
+Depending on the behavior of the adapter, it may be necessary to connect a
+ghost VGA dongle to it (in order to emulate a connected display) to enable the
+audio output. There are guides available detailing how to build these.
+
+When executed, the test will automatically send the test audio signal to all
+ALSA audio HDMI outputs and record from the standard ALSA capture device.
+
+Configuration
+-------------
+
+In order to deploy the test, ALSA controls have to be configured to set the
+ALSA capture source to line-in. On Intel x86 systems, this can be achieved
+with the following calls to the amixer utility:
+# amixer sset Line 31 on
+# amixer sset "Input Source" Line
+
+It is then useful to store the ALSA state permanently with the alsactl utility:
+# alsactl store
+
+These settings can be restored with the alsactl utility:
+# alsactl restore
+
+It is desirable to ensure that the alsa-restore and alsa-state systemd services
+are enabled to do this job automatically, especially in the case of an
+automated testing system:
+# systemctl enable alsa-restore
+# systemctl enable alsa-state
-- 
2.14.0

_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx

✓ Fi.CI.BAT: success for Documentation updates, with chamelium and audio

[Patchwork]

== Series Details ==

Series: Documentation updates, with chamelium and audio
URL   : https://patchwork.freedesktop.org/series/29412/
State : success

== Summary ==

IGT patchset tested on top of latest successful build
60f6a12195395934f179d5ecc080353190d19a6c tests: chamelium: Eliminate reset when preparing output

with latest DRM-Tip kernel build CI_DRM_3009
c52f5322612a drm-tip: 2017y-08m-26d-11h-41m-06s UTC integration manifest

Test kms_cursor_legacy:
        Subgroup basic-busy-flip-before-cursor-atomic:
                fail       -> PASS       (fi-snb-2600) fdo#100215 +1

fdo#100215 https://bugs.freedesktop.org/show_bug.cgi?id=100215

fi-bdw-5557u     total:279  pass:268  dwarn:0   dfail:0   fail:0   skip:11  time:459s
fi-bdw-gvtdvm    total:279  pass:265  dwarn:0   dfail:0   fail:0   skip:14  time:446s
fi-blb-e6850     total:279  pass:224  dwarn:1   dfail:0   fail:0   skip:54  time:363s
fi-bsw-n3050     total:279  pass:243  dwarn:0   dfail:0   fail:0   skip:36  time:549s
fi-bwr-2160      total:279  pass:184  dwarn:0   dfail:0   fail:0   skip:95  time:252s
fi-bxt-j4205     total:279  pass:260  dwarn:0   dfail:0   fail:0   skip:19  time:519s
fi-byt-j1900     total:279  pass:254  dwarn:1   dfail:0   fail:0   skip:24  time:522s
fi-byt-n2820     total:279  pass:250  dwarn:1   dfail:0   fail:0   skip:28  time:520s
fi-elk-e7500     total:279  pass:230  dwarn:0   dfail:0   fail:0   skip:49  time:439s
fi-glk-2a        total:279  pass:260  dwarn:0   dfail:0   fail:0   skip:19  time:612s
fi-hsw-4770      total:279  pass:263  dwarn:0   dfail:0   fail:0   skip:16  time:444s
fi-hsw-4770r     total:279  pass:263  dwarn:0   dfail:0   fail:0   skip:16  time:426s
fi-ilk-650       total:279  pass:229  dwarn:0   dfail:0   fail:0   skip:50  time:422s
fi-ivb-3520m     total:279  pass:261  dwarn:0   dfail:0   fail:0   skip:18  time:508s
fi-ivb-3770      total:279  pass:261  dwarn:0   dfail:0   fail:0   skip:18  time:476s
fi-kbl-7500u     total:279  pass:261  dwarn:0   dfail:0   fail:0   skip:18  time:478s
fi-kbl-7560u     total:279  pass:269  dwarn:0   dfail:0   fail:0   skip:10  time:599s
fi-kbl-r         total:279  pass:261  dwarn:0   dfail:0   fail:0   skip:18  time:602s
fi-pnv-d510      total:279  pass:223  dwarn:1   dfail:0   fail:0   skip:55  time:524s
fi-skl-6260u     total:279  pass:269  dwarn:0   dfail:0   fail:0   skip:10  time:468s
fi-skl-6700k     total:279  pass:261  dwarn:0   dfail:0   fail:0   skip:18  time:480s
fi-skl-6770hq    total:279  pass:269  dwarn:0   dfail:0   fail:0   skip:10  time:495s
fi-skl-gvtdvm    total:279  pass:266  dwarn:0   dfail:0   fail:0   skip:13  time:443s
fi-skl-x1585l    total:279  pass:268  dwarn:0   dfail:0   fail:0   skip:11  time:485s
fi-snb-2520m     total:279  pass:251  dwarn:0   dfail:0   fail:0   skip:28  time:551s
fi-snb-2600      total:279  pass:250  dwarn:0   dfail:0   fail:0   skip:29  time:404s

== Logs ==

For more details see: https://intel-gfx-ci.01.org/tree/drm-tip/IGTPW_108/
_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx

✗ Fi.CI.IGT: failure for Documentation updates, with chamelium and audio

[Patchwork]

== Series Details ==

Series: Documentation updates, with chamelium and audio
URL   : https://patchwork.freedesktop.org/series/29412/
State : failure

== Summary ==

Test perf:
        Subgroup polling:
                pass       -> FAIL       (shard-hsw) fdo#102252
Test vgem_basic:
        Subgroup unload:
                pass       -> SKIP       (shard-hsw)
Test kms_setmode:
        Subgroup basic:
                pass       -> FAIL       (shard-hsw) fdo#99912
Test kms_flip:
        Subgroup flip-vs-expired-vblank:
                pass       -> FAIL       (shard-hsw)

fdo#102252 https://bugs.freedesktop.org/show_bug.cgi?id=102252
fdo#99912 https://bugs.freedesktop.org/show_bug.cgi?id=99912

shard-hsw        total:2230 pass:1229 dwarn:0   dfail:0   fail:19  skip:982 time:9637s

== Logs ==

For more details see: https://intel-gfx-ci.01.org/tree/drm-tip/IGTPW_108/shards.html
_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx

Re: [PATCH i-g-t v2 3/3] docs: Add user documentation about audio support

[Lyude Paul]

With some small typos I fixed (nothing major):

Reviewed-by: Lyude Paul <lyude@redhat.com>

I've already pushed the patches upstream, thanks!

On Mon, 2017-08-28 at 11:12 +0300, Paul Kocialkowski wrote:
> This introduces plain-text documentation about the audio test, aimed
> at
> users who wish to setup and run the audio tests.
> 
> Given the contents of this documentation, it felt more relevant to
> make
> it part of the tree instead of the API reference.
> 
> Signed-off-by: Paul Kocialkowski <paul.kocialkowski@linux.intel.com>
> ---
>  docs/audio.txt | 45 +++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 45 insertions(+)
>  create mode 100644 docs/audio.txt
> 
> diff --git a/docs/audio.txt b/docs/audio.txt
> new file mode 100644
> index 00000000..158ad5d1
> --- /dev/null
> +++ b/docs/audio.txt
> @@ -0,0 +1,45 @@
> +Audio Support in IGT
> +====================
> +
> +This document provides information and instructions about audio
> support in IGT.
> +
> +Introduction
> +------------
> +
> +The audio test is aimed at testing the audio features of display
> connectors,
> +such as HDMI.
> +
> +Test setup
> +----------
> +
> +The setup required for the audio test consists of using an HDMI-VGA
> adapter with
> +an audio-out 3.5 mm jack to extract the audio from the HDMI
> interface.
> +The audio-out jack is connected back to the device-under-test's
> line-in.
> +
> +Depending on the behavior of the adapter, it may be necessary to
> connect a
> +ghost VGA dongle to it (in order to emulate a connected display) to
> enable the
> +audio output. There are guides available detailing how to build
> these.
> +
> +When executed, the test will automatically send the test audio
> signal to all
> +ALSA audio HDMI outputs and record from the standard ALSA capture
> device.
> +
> +Configuration
> +-------------
> +
> +In order to deploy the test, ALSA controls have to be configured to
> set the
> +ALSA capture source to line-in. On Intel x86 systems, this can be
> achieved
> +with the following calls to the amixer utility:
> +# amixer sset Line 31 on
> +# amixer sset "Input Source" Line
> +
> +It is then useful to store the ALSA state permanently with the
> alsactl utility:
> +# alsactl store
> +
> +These settings can be restored with the alsactl utility:
> +# alsactl restore
> +
> +It is desirable to ensure that the alsa-restore and alsa-state
> systemd services
> +are enabled to do this job automatically, especially in the case of
> an
> +automated testing system:
> +# systemctl enable alsa-restore
> +# systemctl enable alsa-state
-- 
Cheers,
	Lyude
_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx

Re: [PATCH i-g-t v2 2/3] docs: Add user and developer documentation about Chamelium support

[Szwichtenberg, Radoslaw]

On Mon, 2017-08-28 at 11:12 +0300, Paul Kocialkowski wrote:
> This introduces plain-text documentation about the Chamelium aimed at
> users who wish to deploy the platform, as well as developers who wish
> to work on improving IGT support for it.
> 
> Given the contents of this documentation, it felt more relevant to make
> it part of the tree instead of the API reference.
> 
> Signed-off-by: Paul Kocialkowski <paul.kocialkowski@linux.intel.com>
Read it twice and is pretty clear to me. Also no spelling mistakes.
Reviewed-by: Radoslaw Szwichtenberg <radoslaw.szwichtenberg@intel.com>
_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx