hal/doc/spec hal-spec.html,1.67,1.68 hal-spec.xml.in,1.48,1.49

Richard Hughes hughsient at freedesktop.org
Wed Sep 28 09:33:11 PDT 2005


Update of /cvs/hal/hal/doc/spec
In directory gabe:/tmp/cvs-serv11498

Modified Files:
	hal-spec.html hal-spec.xml.in 
Log Message:
Apply patch to add documentation for the new mmc.* properties and the platform.* descriptions for "platform bus" support.

Index: hal-spec.html
===================================================================
RCS file: /cvs/hal/hal/doc/spec/hal-spec.html,v
retrieving revision 1.67
retrieving revision 1.68
diff -u -d -r1.67 -r1.68
--- hal-spec.html	22 Aug 2005 01:13:57 -0000	1.67
+++ hal-spec.html	28 Sep 2005 16:33:09 -0000	1.68
@@ -400,6 +400,14 @@
 ></DT
 ><DT
 ><A
+HREF="#device-properties-laptop-panel"
+><TT
+CLASS="literal"
+>laptop_panel</TT
+> namespace</A
+></DT
+><DT
+><A
 HREF="#device-properties-ac_adaptor"
 ><TT
 CLASS="literal"
@@ -552,21 +560,21 @@
 ><DL
 ><DT
 ><A
-HREF="#AEN3395"
+HREF="#AEN3439"
 >Interface org.freedesktop.Hal.Manager</A
 ></DT
 ><DD
 ><DL
 ><DT
 ><A
-HREF="#AEN3406"
+HREF="#AEN3450"
 >Example</A
 ></DT
 ></DL
 ></DD
 ><DT
 ><A
-HREF="#AEN3414"
+HREF="#AEN3458"
 >Interface org.freedesktop.Hal.Device</A
 ></DT
 ></DL
@@ -3746,7 +3754,7 @@
 ><TD
 ><TT
 CLASS="literal"
->ccw.tape.mediumstate</TT
+>ccw.tape.medium_state</TT
 > (string)</TD
 ><TD
 >example: no medium</TD
@@ -5500,6 +5508,45 @@
 ><TD
 ><TT
 CLASS="literal"
+>volume.disc.is_vcd</TT
+> (bool)</TD
+><TD
+>&nbsp;</TD
+><TD
+>Yes</TD
+><TD
+>Is true only if the disc is a Video CD</TD
+></TR
+><TR
+><TD
+><TT
+CLASS="literal"
+>volume.disc.is_svcd</TT
+> (bool)</TD
+><TD
+>&nbsp;</TD
+><TD
+>Yes</TD
+><TD
+>Is true only if the disc is a Super Video CD</TD
+></TR
+><TR
+><TD
+><TT
+CLASS="literal"
+>volume.disc.is_videodvd</TT
+> (bool)</TD
+><TD
+>&nbsp;</TD
+><TD
+>Yes</TD
+><TD
+>Is true only if the disc is a Video DVD</TD
+></TR
+><TR
+><TD
+><TT
+CLASS="literal"
 >volume.disc.is_appendable</TT
 > (bool)</TD
 ><TD
@@ -5711,7 +5758,7 @@
 ><P
 ></P
 ><A
-NAME="AEN1752"
+NAME="AEN1770"
 ></A
 ><TABLE
 BORDER="1"
@@ -6199,7 +6246,7 @@
 ><P
 ></P
 ><A
-NAME="AEN1946"
+NAME="AEN1964"
 ></A
 ><TABLE
 BORDER="1"
@@ -6411,7 +6458,7 @@
 ><P
 ></P
 ><A
-NAME="AEN2032"
+NAME="AEN2050"
 ></A
 ><TABLE
 BORDER="1"
@@ -6565,7 +6612,7 @@
 ><P
 ></P
 ><A
-NAME="AEN2090"
+NAME="AEN2108"
 ></A
 ><TABLE
 BORDER="1"
@@ -6696,7 +6743,7 @@
 ><P
 ></P
 ><A
-NAME="AEN2132"
+NAME="AEN2150"
 ></A
 ><TABLE
 BORDER="1"
@@ -6769,7 +6816,7 @@
 ><P
 ></P
 ><A
-NAME="AEN2154"
+NAME="AEN2172"
 ></A
 ><TABLE
 BORDER="1"
@@ -6836,7 +6883,7 @@
 ><P
 ></P
 ><A
-NAME="AEN2174"
+NAME="AEN2192"
 ></A
 ><TABLE
 BORDER="1"
@@ -6901,7 +6948,7 @@
 ><P
 ></P
 ><A
-NAME="AEN2194"
+NAME="AEN2212"
 ></A
 ><TABLE
 BORDER="1"
@@ -7028,7 +7075,7 @@
 ><P
 ></P
 ><A
-NAME="AEN2238"
+NAME="AEN2256"
 ></A
 ><TABLE
 BORDER="1"
@@ -7165,7 +7212,7 @@
 ><P
 ></P
 ><A
-NAME="AEN2286"
+NAME="AEN2304"
 ></A
 ><TABLE
 BORDER="1"
@@ -7444,7 +7491,7 @@
 ><P
 ></P
 ><A
-NAME="AEN2383"
+NAME="AEN2401"
 ></A
 ><TABLE
 BORDER="1"
@@ -7686,7 +7733,7 @@
 ><P
 ></P
 ><A
-NAME="AEN2472"
+NAME="AEN2490"
 ></A
 ><TABLE
 BORDER="1"
@@ -7787,6 +7834,86 @@
 ><HR><H3
 CLASS="sect2"
 ><A
+NAME="device-properties-laptop-panel"
+><TT
+CLASS="literal"
+>laptop_panel</TT
+> namespace</A
+></H3
+><P
+>&#13;
+        Device objects with the capability <TT
+CLASS="literal"
+>laptop_panel</TT
+>
+        represent devices capable of changing the brightness of the display.
+
+      </P
+><DIV
+CLASS="informaltable"
+><P
+></P
+><A
+NAME="AEN2532"
+></A
+><TABLE
+BORDER="1"
+BGCOLOR="#E0E0E0"
+CELLSPACING="0"
+CELLPADDING="4"
+CLASS="CALSTABLE"
+><THEAD
+><TR
+><TH
+>Key (type)</TH
+><TH
+>Values</TH
+><TH
+>Mandatory</TH
+><TH
+>Description</TH
+></TR
+></THEAD
+><TBODY
+><TR
+><TD
+><TT
+CLASS="literal"
+>laptop_panel.num_levels</TT
+> (int)</TD
+><TD
+>&nbsp;</TD
+><TD
+>Yes</TD
+><TD
+>&#13;                The brightness levels supported by the adaptor.
+              </TD
+></TR
+><TR
+><TD
+><TT
+CLASS="literal"
+>laptop_panel.acpi_method</TT
+> (string)</TD
+><TD
+>&nbsp;</TD
+><TD
+>Yes</TD
+><TD
+>&#13;                The acpi method to use in scripts, e.g. toshiba, ibm, sony etc.
+              </TD
+></TR
+></TBODY
+></TABLE
+><P
+></P
+></DIV
+></DIV
+><DIV
+CLASS="sect2"
+><HR><H3
+CLASS="sect2"
+><A
 NAME="device-properties-ac_adaptor"
 ><TT
 CLASS="literal"
@@ -7807,7 +7934,7 @@
 ><P
 ></P
 ><A
-NAME="AEN2514"
+NAME="AEN2558"
 ></A
 ><TABLE
 BORDER="1"
@@ -7875,7 +8002,7 @@
 ><P
 ></P
 ><A
-NAME="AEN2534"
+NAME="AEN2578"
 ></A
 ><TABLE
 BORDER="1"
@@ -8721,7 +8848,7 @@
 ><P
 ></P
 ><A
-NAME="AEN2843"
+NAME="AEN2887"
 ></A
 ><TABLE
 BORDER="1"
@@ -8835,7 +8962,7 @@
 ><P
 ></P
 ><A
-NAME="AEN2887"
+NAME="AEN2931"
 ></A
 ><TABLE
 BORDER="1"
@@ -8903,7 +9030,7 @@
 ><P
 ></P
 ><A
-NAME="AEN2908"
+NAME="AEN2952"
 ></A
 ><TABLE
 BORDER="1"
@@ -8997,7 +9124,7 @@
 ><P
 ></P
 ><A
-NAME="AEN2940"
+NAME="AEN2984"
 ></A
 ><TABLE
 BORDER="1"
@@ -9108,7 +9235,7 @@
 ><P
 ></P
 ><A
-NAME="AEN2982"
+NAME="AEN3026"
 ></A
 ><TABLE
 BORDER="1"
@@ -9246,7 +9373,7 @@
 ><P
 ></P
 ><A
-NAME="AEN3038"
+NAME="AEN3082"
 ></A
 ><TABLE
 BORDER="1"
@@ -9338,7 +9465,7 @@
 ><P
 ></P
 ><A
-NAME="AEN3066"
+NAME="AEN3110"
 ></A
 ><TABLE
 BORDER="1"
@@ -9497,7 +9624,7 @@
 ><P
 ></P
 ><A
-NAME="AEN3118"
+NAME="AEN3162"
 ></A
 ><TABLE
 BORDER="1"
@@ -9626,7 +9753,7 @@
 ><P
 ></P
 ><A
-NAME="AEN3159"
+NAME="AEN3203"
 ></A
 ><TABLE
 BORDER="1"
@@ -10694,7 +10821,7 @@
 ><P
 ></P
 ><A
-NAME="AEN3353"
+NAME="AEN3397"
 ></A
 ><TABLE
 BORDER="1"
@@ -10854,7 +10981,7 @@
 ><HR><H2
 CLASS="sect1"
 ><A
-NAME="AEN3395"
+NAME="AEN3439"
 >Interface org.freedesktop.Hal.Manager</A
 ></H2
 ><P
@@ -10970,7 +11097,7 @@
 ><HR><H3
 CLASS="sect2"
 ><A
-NAME="AEN3406"
+NAME="AEN3450"
 >Example</A
 ></H3
 ><P
@@ -11088,7 +11215,7 @@
 ><HR><H2
 CLASS="sect1"
 ><A
-NAME="AEN3414"
+NAME="AEN3458"
 >Interface org.freedesktop.Hal.Device</A
 ></H2
 ><P

Index: hal-spec.xml.in
===================================================================
RCS file: /cvs/hal/hal/doc/spec/hal-spec.xml.in,v
retrieving revision 1.48
retrieving revision 1.49
diff -u -d -r1.48 -r1.49
--- hal-spec.xml.in	3 Sep 2005 15:58:33 -0000	1.48
+++ hal-spec.xml.in	28 Sep 2005 16:33:09 -0000	1.49
@@ -1176,6 +1176,43 @@
     </sect2>
 
 
+    <sect2 id="device-properties-platform">
+      <title><literal>platform</literal> namespace</title>
+      <para>
+
+	Devices that are built into the platform or present on busses that
+	cannot be properly enumerated (e.g. ISA) are represented by device
+	objects where <literal>info.bus</literal> equals
+	<literal>platform</literal>. These kind of devices are commonly,
+	somewhat incorrectly, called legacy devices.
+
+      </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>platform.id</literal> (string)</entry>
+              <entry>example: serial</entry>
+              <entry>Yes</entry>
+              <entry>Device identification</entry>
+            </row>
+          </tbody>
+        </tgroup>
+      </informaltable>
+
+    </sect2>
+
+
     <sect2 id="device-properties-ide-host">
       <title><literal>ide_host</literal> namespace</title>
 
@@ -1496,6 +1533,130 @@
       </informaltable>
     </sect2>
 
+
+    <sect2 id="device-properties-mmc_host">
+      <title><literal>mmc_host</literal> namespace</title>
+      <para>
+
+	Device objects with <literal>info.bus</literal> set to
+	<literal>mmc_host</literal> represent MultiMediaCard or
+	Secure Digital host adaptors. The following properties
+	are available for such device objects.
+
+      </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>mmc_host.host</literal> (int)</entry>
+              <entry></entry>
+              <entry>Yes</entry>
+              <entry>A unique number identifying the MMC/SD host adaptor</entry>
+            </row>
+          </tbody>
+        </tgroup>
+      </informaltable>
+    </sect2>
+
+
+    <sect2 id="device-properties-mmc">
+      <title><literal>mmc</literal> namespace</title>
+      <para>
+
+	Device objects with <literal>info.bus</literal> set to
+	<literal>mmc</literal> represent MultiMediaCard or Secure
+	Digital cards. The following properties are available for
+	such device objects.
+
+      </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>mmc.cid</literal> (string)</entry>
+              <entry>example: 0150415330303842413a1a8083003a9d</entry>
+              <entry>Yes</entry>
+              <entry>Card Identification Data register (unique for every card
+              in existence)</entry>
+            </row>
+
+            <row>
+              <entry><literal>mmc.csd</literal> (string)</entry>
+              <entry>example: 005d013213598067b6d9cfff1640002d</entry>
+              <entry>Yes</entry>
+              <entry>Card Specific Data register</entry>
+            </row>
+
+            <row>
+              <entry><literal>mmc.scr</literal> (string)</entry>
+              <entry>example: 00a5000000410000</entry>
+              <entry>Only for SD cards</entry>
+              <entry>SD Card Register</entry>
+            </row>
+
+            <row>
+              <entry><literal>mmc.rca</literal> (int)</entry>
+              <entry>example: 8083</entry>
+              <entry>Yes</entry>
+              <entry>Card bus address</entry>
+            </row>
+
+            <row>
+              <entry><literal>mmc.oem</literal> (string)</entry>
+              <entry></entry>
+              <entry>Yes</entry>
+              <entry>Card OEM distributor</entry>
+            </row>
+
+            <row>
+              <entry><literal>mmc.date</literal> (string)</entry>
+              <entry>example: 10/2003</entry>
+              <entry>Yes</entry>
+              <entry>Manufacturing date</entry>
+            </row>
+
+            <row>
+              <entry><literal>mmc.serial</literal> (int)</entry>
+              <entry>example: 0x3a1a8083</entry>
+              <entry>Yes</entry>
+              <entry>Card serial number</entry>
+            </row>
+
+            <row>
+              <entry><literal>mmc.hwrev</literal> (int)</entry>
+              <entry>example: 4</entry>
+              <entry>Yes</entry>
+              <entry>Hardware revision</entry>
+            </row>
+
+            <row>
+              <entry><literal>mmc.fwrev</literal> (int)</entry>
+              <entry>example: 1</entry>
+              <entry>Yes</entry>
+              <entry>Firmware revision</entry>
+            </row>
+          </tbody>
+        </tgroup>
+      </informaltable>
+    </sect2>
+
+
     <sect2 id="device-properties-ccw">
       <title><literal>ccw</literal> namespace</title>
 




More information about the hal-commit mailing list