Minor documentation fix

Minor documentation fix

[Christophe Coutand]

[-- Attachment #1: Type: text/plain, Size: 155 bytes --]

io/adc/
 -> correct copy/paste in enable_io
 -> add new key

io/common/
 -> updated definition of DEVIO_TABLE, missing select argument

Christophe

[-- Attachment #2: io_adc_sgml --]
[-- Type: application/octet-stream, Size: 1881 bytes --]

Index: adc.sgml
===================================================================
RCS file: /cvs/ecos/ecos/packages/io/adc/current/doc/adc.sgml,v
retrieving revision 1.2
diff -u -r1.2 adc.sgml
--- adc.sgml	29 Jan 2009 17:49:44 -0000	1.2
+++ adc.sgml	6 Jun 2010 07:53:51 -0000
@@ -257,7 +257,7 @@
 int enable_io( cyg_io_handle_t handle )
 {
     return cyg_io_set_config( handle,
-                              CYG_IO_SET_CONFIG_ADC_DISABLE,
+                              CYG_IO_SET_CONFIG_ADC_ENABLE,
                               NULL,
                               NULL);
 }
@@ -265,8 +265,27 @@
 
 </refsect2>
 
-</refsect1>
+<refsect2 id="adc-details-flush"><title>Flushing a Channel</title>
+
+<para>
+In some particular cases, user might require to flush the ADC data buffer. Flushing
+may be perfomed via a <function>set_config</function>
+function:
+</para>
+
+<programlisting width=72>
+int flush_io( cyg_io_handle_t handle )
+{
+    return cyg_io_set_config( handle,
+                              CYG_IO_SET_CONFIG_ADC_DATA_FLUSH,
+                              NULL,
+                              NULL);
+}
+</programlisting>
 
+</refsect2>
+
+</refsect1>
 
 <refsect1 id="adc-config"><title>Configuration</title>
 
Index: ChangeLog
===================================================================
RCS file: /cvs/ecos/ecos/packages/io/adc/current/ChangeLog,v
retrieving revision 1.5
diff -u -r1.5 ChangeLog
--- ChangeLog	29 May 2010 14:33:15 -0000	1.5
+++ ChangeLog	6 Jun 2010 07:50:16 -0000
@@ -1,4 +1,9 @@
-20010-05-25 ccoutand <ccoutand@stmi.com>
+2010-06-06 ccoutand <ccoutand@stmi.com>
+        * doc/adc.sgml
+        Updated documentation, add new ADC data flush and 
+        correct Copy/Paste in enable_io
+
+2010-05-25 ccoutand <ccoutand@stmi.com>
 	* src/adc.c: 
 	Add new key to ADC driver to flush data buffer:
 	CYG_IO_SET_CONFIG_ADC_DATA_FLUSH

[-- Attachment #3: io_common_sgml --]
[-- Type: application/octet-stream, Size: 1541 bytes --]

Index: io.sgml
===================================================================
RCS file: /cvs/ecos/ecos/packages/io/common/current/doc/io.sgml,v
retrieving revision 1.6
diff -u -r1.6 io.sgml
--- io.sgml	29 Jan 2009 17:49:45 -0000	1.6
+++ io.sgml	6 Jun 2010 07:56:20 -0000
@@ -1091,7 +1091,7 @@
 
 
 <PROGRAMLISTING>
-DEVIO_TABLE(l, write, read, get_config, set_config)
+DEVIO_TABLE(l, write, read, select, get_config, set_config)
 </PROGRAMLISTING>
 
 <variablelist>
@@ -1111,6 +1111,11 @@
     <function>cyg_io_read()</function>. </para></listitem>
   </varlistentry>
   <varlistentry>
+    <term>select</term>
+    <listitem><para>The function called as a result of
+    <function>cyg_io_select()</function>. </para></listitem>
+  </varlistentry>
+  <varlistentry>
     <term>get_config</term>
     <listitem><para>The function called as a result of
     <function>cyg_io_get_config()</function>.</para></listitem>
Index: ChangeLog
===================================================================
RCS file: /cvs/ecos/ecos/packages/io/common/current/ChangeLog,v
retrieving revision 1.33
diff -u -r1.33 ChangeLog
--- ChangeLog	29 May 2010 14:28:13 -0000	1.33
+++ ChangeLog	6 Jun 2010 07:59:45 -0000
@@ -1,4 +1,8 @@
-20010-05-25 ccoutand <ccoutand@stmi.com>
+2010-06-06 ccoutand <ccoutand@stmi.com>
+        *doc/io.sgml
+	Updated DEVIO_TABLE definition, missing select argument
+
+2010-05-25 ccoutand <ccoutand@stmi.com>
 	* include/config_keys.h: 
 	Add new key to ADC driver to flush data buffer:
 	CYG_IO_SET_CONFIG_ADC_DATA_FLUSH

Re: Minor documentation fix

[Sergei Gavrikov]

On Sun, 6 Jun 2010, Christophe Coutand wrote:
> io/adc/
> -> correct copy/paste in enable_io
> -> add new key
>
> io/common/
> -> updated definition of DEVIO_TABLE, missing select argument
>
> Christophe

Hi Christophe,

Thank you for you attention to eCos documentation. Checked-in.

Sergei