[11/13] Documentation for ccwgroup bus.
Cornelia Huck
cohuck at de.ibm.com
Mon Jun 27 01:45:40 PDT 2005
[11/13] Documentation for ccwgroup bus.
Document the properties of ccwgroup devices.
hal-spec.xml.in | 331 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 files changed, 331 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
@@ -1754,6 +1754,337 @@
</informaltable>
</sect2>
+ <sect2 id="device-properties-ccwgroup">
+ <title><literal>ccwgroup</literal> namespace</title>
+
+ <para>
+
+ Device objects that represent groups of <literal>ccw</literal> devices
+ (when <literal>info.bus</literal> is set to <literal>ccwgroup</literal>
+ have the properties specified 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>ccwgroup.online</literal> (int)</entry>
+ <entry>example: 1</entry>
+ <entry>Yes</entry>
+ <entry>Online status</entry>
+ </row>
+ <row>
+ <entry><literal>ccwgroup.bus_id</literal> (string)</entry>
+ <entry>example: 0.0.f588</entry>
+ <entry>Yes</entry>
+ <entry>The device's bus id in sysfs</entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>
+
+ The following properties describe <literal>ccwgroup</literal> devices
+ where <literal>linux.driver</literal> is <literal>qeth</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>ccwgroup.qeth.large_send</literal> (string)
+ </entry>
+ <entry>example: TSO</entry>
+ <entry>No</entry>
+ <entry>Whether large send is provided. Can be "no", "EDDP"
+ (software) or "TSO" (hardware).</entry>
+ </row>
+ <row>
+ <entry><literal>ccwgroup.qeth.card_type</literal> (string)</entry>
+ <entry>example: OSD_1000</entry>
+ <entry>Yes</entry>
+ <entry>Type of the card</entry>
+ </row>
+ <row>
+ <entry><literal>ccwgroup.qeth.checksumming</literal> (string)
+ </entry>
+ <entry>example: sw checksumming</entry>
+ <entry>No</entry>
+ <entry>The method used to checksum incoming packets</entry>
+ </row>
+ <row>
+ <entry><literal>ccwgroup.qeth.canonical_macaddr</literal> (int)
+ </entry>
+ <entry>example: 0</entry>
+ <entry>No</entry>
+ <entry>Specifies the token ring macaddress format. Not valid in
+ layer2 mode and for ethernet devices.</entry>
+ </row>
+ <row>
+ <entry><literal>ccwgroup.qeth.broadcast_mode</literal> (string)
+ </entry>
+ <entry>example: broadcast_allrings</entry>
+ <entry>No</entry>
+ <entry>The scope of token ring broadcasts. Not valid in layer2
+ mode and for ethernet devices.</entry>
+ </row>
+ <row>
+ <entry><literal>ccwgroup.qeth.fake_broadcast</literal> (int)
+ </entry>
+ <entry>example: 0</entry>
+ <entry>No</entry>
+ <entry>Whether to fake broadcast capability. Not valid in layer2
+ mode.</entry>
+ </row>
+ <row>
+ <entry><literal>ccwgroup.qeth.fake_ll</literal> (int)</entry>
+ <entry>example: 0</entry>
+ <entry>No</entry>
+ <entry>Whether to add a faked link level header to packets.
+ Not valid in layer2 mode.</entry>
+ </row>
+ <row>
+ <entry><literal>ccwgroup.qeth.layer2</literal> (int)</entry>
+ <entry>example: 0</entry>
+ <entry>No</entry>
+ <entry>Whether the card operates in layer 2 mode</entry>
+ </row>
+ <row>
+ <entry><literal>ccwgroup.qeth.portname</literal> (string)</entry>
+ <entry>example: OSAPORT</entry>
+ <entry>No</entry>
+ <entry>The port name which has been specified for the card</entry>
+ </row>
+ <row>
+ <entry><literal>ccwgroup.qeth.portno</literal> (int)</entry>
+ <entry>example: 0</entry>
+ <entry>No</entry>
+ <entry>The relative port number on the card</entry>
+ </row>
+ <row>
+ <entry><literal>ccwgroup.qeth.buffer_count</literal> (int)</entry>
+ <entry>example: 16</entry>
+ <entry>Yes</entry>
+ <entry>Number of inbound buffers used</entry>
+ </row>
+ <row>
+ <entry><literal>ccwgroup.qeth.add_hhlen</literal> (int)</entry>
+ <entry>example: 0</entry>
+ <entry>No</entry>
+ <entry>How much additional space is provided in the hardware
+ header in skbs in front of packets</entry>
+ </row>
+ <row>
+ <entry><literal>ccwgroup.qeth.priority_queueing</literal>
+ (string)</entry>
+ <entry>example: always queue 2</entry>
+ <entry>No</entry>
+ <entry>Which priority queueing algorithm is to be used</entry>
+ </row>
+ <row>
+ <entry><literal>ccwgroup.qeth.route4</literal> (string)</entry>
+ <entry>example: no</entry>
+ <entry>No</entry>
+ <entry>Whether the card has a routing functionality for ipv4.
+ Not valid in layer2 mode.</entry>
+ </row>
+ <row>
+ <entry><literal>ccwgroup.qeth.route6</literal> (string)</entry>
+ <entry>example: no</entry>
+ <entry>No</entry>
+ <entry>Whether the card has a routing functionality for ipv6.
+ Not valid in layer2 mode.</entry>
+ </row>
+ <row>
+ <entry><literal>ccwgroup.qeth.state</literal> (string)</entry>
+ <entry>example: UP (LAN ONLINE)</entry>
+ <entry>Yes</entry>
+ <entry>The device's current state</entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>
+
+ The following properties describe <literal>ccwgroup</literal> devices
+ where <literal>linux.driver</literal> is <literal>ctc</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>ccwgroup.ctc.protocol</literal> (int)</entry>
+ <entry>example: 0</entry>
+ <entry>Yes</entry>
+ <entry>The protocol/method used by the connection</entry>
+ </row>
+ <row>
+ <entry><literal>ccwgroup.ctc.type</literal> (string)</entry>
+ <entry>example: CTC/A</entry>
+ <entry>Yes</entry>
+ <entry>The device/connection type</entry>
+ </row>
+ <row>
+ <entry><literal>ccwgroup.ctc.buffer</literal> (int) </entry>
+ <entry>example: 32768</entry>
+ <entry>No</entry>
+ <entry>The maximum buffer size of the connection</entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>
+
+ The following properties describe <literal>ccwgroup</literal> devices
+ where <literal>linux.driver</literal> is <literal>lcs</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>ccwgroup.lcs.portnumber</literal> (int)</entry>
+ <entry>example: 0</entry>
+ <entry>Yes</entry>
+ <entry>The port on the card that is used</entry>
+ </row>
+ <row>
+ <entry><literal>ccwgroup.lcs.type</literal> (string)</entry>
+ <entry>example: OSA LCS card</entry>
+ <entry>Yes</entry>
+ <entry>The type of the card</entry>
+ </row>
+ <row>
+ <entry><literal>ccwgroup.lcs.lancmd_timeout</literal> (int)
+ </entry>
+ <entry>example: 5</entry>
+ <entry>Yes</entry>
+ <entry>The timeout value for LAN commands in seconds</entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>
+
+ The following properties describe <literal>ccwgroup</literal> devices
+ where <literal>linux.driver</literal> is <literal>claw</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>ccwgroup.claw.api_type</literal> (string)</entry>
+ <entry></entry>
+ <entry>Yes</entry>
+ <entry>Determines the packing algorithm for outgoing pakets
+ (matching the remote peer)
+ </entry>
+ </row>
+ <row>
+ <entry></entry>
+ <entry>IP</entry>
+ <entry></entry>
+ <entry>Using the IP protocol</entry>
+ </row>
+ <row>
+ <entry></entry>
+ <entry>PACKED</entry>
+ <entry></entry>
+ <entry>Using an enhanced packing algorithm</entry>
+ </row>
+ <row>
+ <entry></entry>
+ <entry>TCPIP</entry>
+ <entry></entry>
+ <entry>Using the TCP/IP protocol</entry>
+ </row>
+ <row>
+ <entry><literal>ccwgroup.claw.adapter_name</literal> (string)
+ </entry>
+ <entry>example: RS1</entry>
+ <entry>Yes</entry>
+ <entry>The host name of the remote communication peer.</entry>
+ </row>
+ <row>
+ <entry><literal>ccwgroup.claw.host_name</literal> (string)</entry>
+ <entry>example: LNX1</entry>
+ <entry>Yes</entry>
+ <entry>The host name of the local adapter.</entry>
+ </row>
+ <row>
+ <entry><literal>ccwgroup.claw.read_buffer</literal> (int)</entry>
+ <entry>example: 4</entry>
+ <entry>Yes</entry>
+ <entry>The number of read buffers allocated</entry>
+ </row>
+ <row>
+ <entry><literal>ccwgroup.claw.write_buffer</literal> (int)</entry>
+ <entry>example: 5</entry>
+ <entry>Yes</entry>
+ <entry>The number of write buffers allocated</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
More information about the Hal
mailing list