[igt-dev] [PATCH] docs/chamelium: Update sections of a network and a config file in detail

[Gwan-gyeong Mun]

It updates a network setting between a Target PC and a Chamelium.
And it adds informations of Chamelium-specific keys for DRM connector and
Chamelium Port ID in detail.
And it adds "Running the Chamelium With IGT" section.

Signed-off-by: Gwan-gyeong Mun <gwan-gyeong.mun at intel.com>
---
 docs/chamelium.txt | 45 +++++++++++++++++++++++++++++++++++++++------
 1 file changed, 39 insertions(+), 6 deletions(-)

diff --git a/docs/chamelium.txt b/docs/chamelium.txt
index ed154990..13584a41 100644
--- a/docs/chamelium.txt
+++ b/docs/chamelium.txt
@@ -44,6 +44,9 @@ 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.
 
+This document supposes that target PC's network IP has "192.168.1.1/24" and
+the Chamelium's network IP has "192.168.1.2/24".
+
 Chamelium support requires setting up dedicated IGT configuration, as explained
 in the Core and Chamelium parts of the IGT API Reference in the documentation.
 
@@ -60,14 +63,42 @@ by the IGT tests is common to all connectors and thus one machine running a test
 on a given connector may reset the Chamelium while another machine is running
 a test on another connector.
 
-An example fully-featured configuration follows:
+IGT's behavior can be configured through a configuration file.
+By default, this file is expected to exist in ~/.igtrc
+In order to run tests using the Chamelium, a valid configuration file must be
+present. It must contain Chamelium-specific keys as shown with the following
+example:
+
+# The common configuration section follows.
 [Common]
-FrameDumpPath=/root/
+# The path to dump frames that fail comparison checks
+FrameDumpPath=/tmp/
 
-[Chamelium]
-URL=http://192.168.72.1:9992
+# The following section is used for configuring the Device Under Test.
+# It is not mandatory and allows overriding default values.
+[DUT]
+SuspendResumeDelay=15
 
+[Chamelium]
+# The URL used for connecting to the Chamelium's RPC server
+URL=http://192.168.1.2:9992
+
+# The rest of the sections are used for defining connector mappings.
+# This is required so any tests using the Chamelium know which connector
+# on the test machine should be connected to each Chamelium port.
+#
+# In the event that any of these mappings are specified incorrectly,
+# any hotplugging tests for the incorrect connector mapping will fail.
+
+# The name of the DRM connector
+# The DP-1 of [Chamelium:DP-1] and the HDMI-A-1 of [Chamelium:HDMI-A-1] indicate
+# "connector info type" of /sys/kernel/debug/dri/0/i915_display_info.
 [Chamelium:DP-1]
+# The ChameliumPortID indicates physical port (device) id of a Chamelium Board.
+# A Chamelium daemon program defines these port ids as
+# DP1 = 1, DP2 = 2, HDMI = 3, and VGA = 4
+# The port ids are defined at:
+# https://chromium.googlesource.com/chromiumos/platform/chameleon/+/master/chameleond/utils/ids.py
 ChameliumPortID=1
 
 [Chamelium:HDMI-A-2]
@@ -76,8 +107,10 @@ ChameliumPortID=3
 [Chamelium:VGA-1]
 ChameliumPortID=4
 
-[DUT]
-SuspendResumeDelay=2
+Running the Chamelium With IGT
+------------------------------
+
+$ ./scripts/run-tests.sh -t chamelium
 
 Debugging the Chamelium
 -----------------------
-- 
2.18.0

---------------------------------------------------------------------
Intel Finland Oy
Registered Address: PL 281, 00181 Helsinki 
Business Identity Code: 0357606 - 4 
Domiciled in Helsinki 

This e-mail and any attachments may contain confidential material for
the sole use of the intended recipient(s). Any review or distribution
by others is strictly prohibited. If you are not the intended
recipient, please contact the sender and delete all copies.