[10/13] Documentation for ccw bus.

[Cornelia Huck]

[10/13] Documentation for ccw bus.

Document the properties of ccw devices.

 hal-spec.xml.in |  257 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 257 insertions(+)

Index: doc/spec/hal-spec.xml.in
===================================================================
RCS file: /cvs/hal/hal/doc/spec/hal-spec.xml.in,v
retrieving revision 1.38
diff -u -r1.38 hal-spec.xml.in
--- doc/spec/hal-spec.xml.in	24 Mar 2005 01:15:31 -0000	1.38
+++ doc/spec/hal-spec.xml.in	23 Jun 2005 13:59:56 -0000
@@ -1496,7 +1496,264 @@
       </informaltable>
     </sect2>
 
+    <sect2 id="device-properties-ccw">
+      <title><literal>ccw</literal> namespace</title>
 
+      <para>
+
+	Device objects that represent s390 ccw devices (when <literal>info.bus
+	</literal> is set to <literal>ccw</literal>) are represented by the
+	properties below.
+
+      </para>
+
+      <informaltable>
+        <tgroup cols="2">
+          <thead>
+            <row>
+              <entry>Key (type)</entry>
+              <entry>Values</entry>
+              <entry>Mandatory</entry>
+              <entry>Description</entry>
+            </row>
+          </thead>
+          <tbody>
+
+            <row>
+              <entry><literal>ccw.devtype</literal> (string)</entry>
+              <entry>example: 1732/01</entry>
+              <entry>Yes</entry>
+              <entry>Device type/model or n/a</entry>
+            </row>
+            <row>
+              <entry><literal>ccw.cutype</literal> (string)</entry>
+              <entry>example: 1731/01</entry>
+              <entry>Yes</entry>
+              <entry>Control unit type/model</entry>
+            </row>
+            <row>
+              <entry><literal>ccw.cmb_enable</literal> (int)</entry>
+              <entry>example: 1</entry>
+              <entry>Yes</entry>
+              <entry>If channel measurements are enabled</entry>
+            </row>
+            <row>
+              <entry><literal>ccw.availability</literal> (string)</entry>
+              <entry>example: good</entry>
+              <entry>Yes</entry>
+              <entry>Can be one of 'good', 'boxed', 'no path',
+		or 'no device'</entry>
+            </row>
+            <row>
+              <entry><literal>ccw.online</literal> (int)</entry>
+              <entry>example: 1</entry>
+              <entry>Yes</entry>
+              <entry>Online status</entry>
+            </row>
+            <row>
+              <entry><literal>ccw.bus_id</literal> (string)</entry>
+              <entry>example: 0.0.f588</entry>
+              <entry>Yes</entry>
+              <entry>The device's bus id in sysfs</entry>
+            </row>
+            <row>
+              <entry><literal>ccw.subchannel.pim</literal> (int)</entry>
+              <entry>example: 0x80</entry>
+              <entry>No</entry>
+              <entry>path installed mask</entry>
+            </row>
+            <row>
+              <entry><literal>ccw.subchannel.pam</literal> (int)</entry>
+              <entry>example: 0x80</entry>
+              <entry>No</entry>
+              <entry>path available mask</entry>
+            </row>
+            <row>
+              <entry><literal>ccw.subchannel.pom</literal> (int)</entry>
+              <entry>example: 0xff</entry>
+              <entry>No</entry>
+              <entry>path operational mask</entry>
+            </row>
+            <row>
+              <entry><literal>ccw.subchannel.chpid0..7</literal> (int)</entry>
+              <entry>example: 0x40</entry>
+              <entry>No</entry>
+              <entry>channel path ids</entry>
+            </row>
+
+          </tbody>
+        </tgroup>
+      </informaltable>
+
+	<para>
+
+	The following properties describe <literal>ccw</literal> devices where
+	<literal>linux.driver</literal> is either <literal>dasd-eckd</literal>
+	or <literal>dasd-fba</literal>.
+
+	</para>
+      <informaltable>
+        <tgroup cols="2">
+          <thead>
+            <row>
+              <entry>Key (type)</entry>
+              <entry>Values</entry>
+              <entry>Mandatory</entry>
+              <entry>Description</entry>
+            </row>
+          </thead>
+          <tbody>
+            <row>
+              <entry><literal>ccw.dasd.use_diag</literal> (int)</entry>
+              <entry>example: 0</entry>
+              <entry>Yes</entry>
+              <entry>If the device driver shall use diagnose calls to access
+	      the device</entry>
+            </row>
+            <row>
+              <entry><literal>ccw.dasd.readonly</literal> (int)</entry>
+              <entry>example: 0</entry>
+              <entry>Yes</entry>
+              <entry>If the device can only be accessed readonly</entry>
+            </row>
+            <row>
+              <entry><literal>ccw.dasd.discipline</literal> (string)</entry>
+              <entry>example: ECKD</entry>
+              <entry>No</entry>
+              <entry>The dasd discipline used to access the device</entry>
+            </row>
+
+          </tbody>
+        </tgroup>
+      </informaltable>
+
+	<para>
+
+	The following properties describe <literal>ccw</literal> devices where
+	<literal>linux.driver</literal> is <literal>zfcp</literal>. They are
+	only present when <literal>ccw.online = 1</literal>.
+
+	</para>
+      <informaltable>
+        <tgroup cols="2">
+          <thead>
+            <row>
+              <entry>Key (type)</entry>
+              <entry>Values</entry>
+              <entry>Mandatory</entry>
+              <entry>Description</entry>
+            </row>
+          </thead>
+          <tbody>
+            <row>
+              <entry><literal>ccw.zfcp.in_recovery</literal> (int)</entry>
+              <entry>example: 0</entry>
+              <entry>Yes</entry>
+              <entry>Shows whether the adapter is currently in recovery</entry>
+            </row>
+            <row>
+              <entry><literal>ccw.zfcp.failed</literal> (int)</entry>
+              <entry>example: 0</entry>
+              <entry>Yes</entry>
+              <entry>Shows whether the adapter is in failed state</entry>
+            </row>
+
+          </tbody>
+        </tgroup>
+      </informaltable>
+
+	<para>
+
+	The following properties describe <literal>ccw</literal> devices where
+	<literal>linux.driver</literal> is of the form <literal>tape_3xxx
+	</literal>.
+
+	</para>
+      <informaltable>
+        <tgroup cols="2">
+          <thead>
+            <row>
+              <entry>Key (type)</entry>
+              <entry>Values</entry>
+              <entry>Mandatory</entry>
+              <entry>Description</entry>
+            </row>
+          </thead>
+          <tbody>
+            <row>
+              <entry><literal>ccw.tape.state</literal> (string)</entry>
+              <entry>example: IN_USE</entry>
+              <entry>Yes</entry>
+              <entry>The current status of the tape</entry>
+            </row>
+            <row>
+              <entry><literal>ccw.tape.operation</literal> (string)</entry>
+              <entry>example: REW</entry>
+              <entry>Yes</entry>
+              <entry>A three-letter mnemonic of the current tape operation
+	      </entry>
+            </row>
+            <row>
+              <entry><literal>ccw.tape.mediumstate</literal> (string)</entry>
+              <entry>example: no medium</entry>
+              <entry>No</entry>
+              <entry>If <literal>ccw.online = 1</literal>, shows whether a tape 
+	      is loaded</entry>
+            </row>
+            <row>
+              <entry><literal>ccw.tape.blocksize</literal> (int)</entry>
+              <entry>example: 512</entry>
+              <entry>No</entry>
+              <entry>If <literal>ccw.online = 1</literal>, shows the blocksize
+	      used for reads and writes to the tape</entry>
+            </row>
+
+          </tbody>
+        </tgroup>
+      </informaltable>
+
+	<para>
+
+	The following properties describe <literal>ccw</literal> devices where
+	<literal>linux.driver</literal> is <literal>3270</literal>.
+
+	</para>
+      <informaltable>
+        <tgroup cols="2">
+          <thead>
+            <row>
+              <entry>Key (type)</entry>
+              <entry>Values</entry>
+              <entry>Mandatory</entry>
+              <entry>Description</entry>
+            </row>
+          </thead>
+          <tbody>
+            <row>
+              <entry><literal>ccw.3270.model</literal> (int)</entry>
+              <entry>example: 3</entry>
+              <entry>Yes</entry>
+              <entry>The model of the device, determining rows and columns
+	      </entry>
+            </row>
+            <row>
+              <entry><literal>ccw.3270.rows</literal> (int)</entry>
+              <entry>example: 32</entry>
+              <entry>Yes</entry>
+              <entry>The number of rows</entry>
+            </row>
+            <row>
+              <entry><literal>ccw.3270.columns</literal> (int)</entry>
+              <entry>example: 80</entry>
+              <entry>Yes</entry>
+              <entry>The number of columns</entry>
+            </row>
+
+          </tbody>
+        </tgroup>
+      </informaltable>
+    </sect2>
+
 
     <sect2 id="device-properties-block">
       <title><literal>block</literal> namespace</title>
_______________________________________________
hal mailing list
hal at lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/hal