summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorGravatar Dan Dennedy 2008-04-29 23:09:22 -0700
committerGravatar Dan Dennedy 2008-04-29 23:09:22 -0700
commit3b4d2eed60f88f780393568b122164f8985088b9 (patch)
tree9f38966162b622e42b1dba8a995959995be1cde5 /doc
parentjuju/raw1394-iso.c: bugfix size of mmap'ed isochronous buffer to prevent (diff)
libraw1394.sgml, raw1394.h: remove information about deprecated isochronous
API that has been removed.
Diffstat (limited to 'doc')
-rw-r--r--doc/libraw1394.sgml418
1 files changed, 3 insertions, 415 deletions
diff --git a/doc/libraw1394.sgml b/doc/libraw1394.sgml
index 9987865..5d5a65b 100644
--- a/doc/libraw1394.sgml
+++ b/doc/libraw1394.sgml
@@ -546,7 +546,7 @@
</listitem>
<listitem>
<para>iso handler (called when an iso packet is received)
- (deprecated by the new iso API)</para>
+ </para>
</listitem>
<listitem>
<para>fcp handler (called when a FCP command or response is
@@ -1726,7 +1726,7 @@
<title>Returns</title>
<para>
the error code of the last <function>raw1394_read</function>, <function>raw1394_write</function>,
- <function>raw1394_lock</function> or <function>raw1394_iso_write</function>. The error code is either an internal
+ <function>raw1394_lock</function>. The error code is either an internal
error (i.e. not a bus error) or a combination of acknowledge code and
response code, as appropriate.
</para>
@@ -2714,7 +2714,7 @@
Care must be taken when replacing the tag handler and calling the synchronous
versions of the transaction functions (i.e. <function>raw1394_read</function>, <function>raw1394_write</function>,
- <function>raw1394_lock</function>, <function>raw1394_iso_write</function>) since these do pass pointers to &amp;struct
+ <function>raw1394_lock</function>) since these do pass pointers to &amp;struct
raw1394_reqhandle as the tag and expect the callback to be invoked.
</para>
</refsect1>
@@ -5025,418 +5025,6 @@
</refsect1>
</refentry>
-<refentry>
-<refmeta>
-<refentrytitle><phrase id="API-int">int</phrase></refentrytitle>
-</refmeta>
-<refnamediv>
- <refname>int</refname>
- <refpurpose>
- DEPRECATED
- </refpurpose>
-</refnamediv>
-<refsynopsisdiv>
- <title>Synopsis</title>
- <funcsynopsis><funcprototype>
- <funcdef>typedef <function>int </function></funcdef>
- <paramdef>* <parameter>iso_handler_t</parameter></paramdef>
- </funcprototype></funcsynopsis>
-</refsynopsisdiv>
-<refsect1>
- <title>Arguments</title>
- <variablelist>
- <varlistentry>
- <term><parameter>iso_handler_t</parameter></term>
- <listitem>
- <para>
- -- undescribed --
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect1>
-<refsect1>
- <title>Description</title>
- <para>
- DEPRECATED
- </para>
-</refsect1>
-</refentry>
-
-<refentry>
-<refmeta>
-<refentrytitle><phrase id="API-raw1394-set-iso-handler">raw1394_set_iso_handler</phrase></refentrytitle>
-</refmeta>
-<refnamediv>
- <refname>raw1394_set_iso_handler</refname>
- <refpurpose>
- set isochronous packet handler (DEPRECATED)
- </refpurpose>
-</refnamediv>
-<refsynopsisdiv>
- <title>Synopsis</title>
- <funcsynopsis><funcprototype>
- <funcdef>iso_handler_t <function>raw1394_set_iso_handler </function></funcdef>
- <paramdef>raw1394handle_t <parameter>handle</parameter></paramdef>
- <paramdef>unsigned int <parameter>channel</parameter></paramdef>
- <paramdef>iso_handler_t <parameter>new_h</parameter></paramdef>
- </funcprototype></funcsynopsis>
-</refsynopsisdiv>
-<refsect1>
- <title>Arguments</title>
- <variablelist>
- <varlistentry>
- <term><parameter>handle</parameter></term>
- <listitem>
- <para>
- libraw1394 handle
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>channel</parameter></term>
- <listitem>
- <para>
- -- undescribed --
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>new_h</parameter></term>
- <listitem>
- <para>
- pointer to new handler
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect1>
-<refsect1>
- <title>Description</title>
- <para>
- DEPRECATED
- </para><para>
-
- Sets the handler to be called when an isochronous packet is received to
- <parameter>new_h</parameter> and returns the old handler. The default handler does nothing.
- </para><para>
-
- In order to actually get iso packet events, receiving on a specific channel
- first has to be enabled with <function>raw1394_start_iso_rcv</function> and can be stopped again
- with <function>raw1394_stop_iso_rcv</function>.
- </para>
-</refsect1>
-</refentry>
-
-<refentry>
-<refmeta>
-<refentrytitle><phrase id="API-raw1394-start-iso-rcv">raw1394_start_iso_rcv</phrase></refentrytitle>
-</refmeta>
-<refnamediv>
- <refname>raw1394_start_iso_rcv</refname>
- <refpurpose>
- enable isochronous receiving (DEPRECATED)
- </refpurpose>
-</refnamediv>
-<refsynopsisdiv>
- <title>Synopsis</title>
- <funcsynopsis><funcprototype>
- <funcdef>int <function>raw1394_start_iso_rcv </function></funcdef>
- <paramdef>raw1394handle_t <parameter>handle</parameter></paramdef>
- <paramdef>unsigned int <parameter>channel</parameter></paramdef>
- </funcprototype></funcsynopsis>
-</refsynopsisdiv>
-<refsect1>
- <title>Arguments</title>
- <variablelist>
- <varlistentry>
- <term><parameter>handle</parameter></term>
- <listitem>
- <para>
- libraw1394 handle
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>channel</parameter></term>
- <listitem>
- <para>
- channel number to start receiving on
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect1>
-<refsect1>
- <title>Description</title>
- <para>
- DEPRECATED
- </para><para>
-
- Enables the reception of isochronous packets in <parameter>channel</parameter> on <parameter>handle</parameter>.
- Isochronous packets are then passed to the callback specified with
- <function>raw1394_set_iso_handler</function>.
- </para>
-</refsect1>
-</refentry>
-
-<refentry>
-<refmeta>
-<refentrytitle><phrase id="API-raw1394-stop-iso-rcv">raw1394_stop_iso_rcv</phrase></refentrytitle>
-</refmeta>
-<refnamediv>
- <refname>raw1394_stop_iso_rcv</refname>
- <refpurpose>
- stop isochronous receiving (DEPRECATED)
- </refpurpose>
-</refnamediv>
-<refsynopsisdiv>
- <title>Synopsis</title>
- <funcsynopsis><funcprototype>
- <funcdef>int <function>raw1394_stop_iso_rcv </function></funcdef>
- <paramdef>raw1394handle_t <parameter>handle</parameter></paramdef>
- <paramdef>unsigned int <parameter>channel</parameter></paramdef>
- </funcprototype></funcsynopsis>
-</refsynopsisdiv>
-<refsect1>
- <title>Arguments</title>
- <variablelist>
- <varlistentry>
- <term><parameter>handle</parameter></term>
- <listitem>
- <para>
- libraw1394 handle
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>channel</parameter></term>
- <listitem>
- <para>
- channel to stop receiving on
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect1>
-<refsect1>
- <title>Description</title>
- <para>
- DEPRECATED
- </para><para>
-
- Stops the reception of isochronous packets in <parameter>channel</parameter> on <parameter>handle</parameter>.
- </para>
-</refsect1>
-</refentry>
-
-<refentry>
-<refmeta>
-<refentrytitle><phrase id="API-raw1394-start-iso-write">raw1394_start_iso_write</phrase></refentrytitle>
-</refmeta>
-<refnamediv>
- <refname>raw1394_start_iso_write</refname>
- <refpurpose>
- initiate an isochronous packet write (DEPRECATED)
- </refpurpose>
-</refnamediv>
-<refsynopsisdiv>
- <title>Synopsis</title>
- <funcsynopsis><funcprototype>
- <funcdef>int <function>raw1394_start_iso_write </function></funcdef>
- <paramdef>raw1394handle_t <parameter>handle</parameter></paramdef>
- <paramdef>unsigned int <parameter>channel</parameter></paramdef>
- <paramdef>unsigned int <parameter>tag</parameter></paramdef>
- <paramdef>unsigned int <parameter>sy</parameter></paramdef>
- <paramdef>unsigned int <parameter>speed</parameter></paramdef>
- <paramdef>size_t <parameter>length</parameter></paramdef>
- <paramdef>quadlet_t * <parameter>data</parameter></paramdef>
- <paramdef>unsigned long <parameter>rawtag</parameter></paramdef>
- </funcprototype></funcsynopsis>
-</refsynopsisdiv>
-<refsect1>
- <title>Arguments</title>
- <variablelist>
- <varlistentry>
- <term><parameter>handle</parameter></term>
- <listitem>
- <para>
- libraw1394 handle
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>channel</parameter></term>
- <listitem>
- <para>
- channel number on which to send on
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>tag</parameter></term>
- <listitem>
- <para>
- data to be put into packet's tag field
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>sy</parameter></term>
- <listitem>
- <para>
- data to be put into packet's sy field
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>speed</parameter></term>
- <listitem>
- <para>
- speed at which to send
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>length</parameter></term>
- <listitem>
- <para>
- amount of data to send
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>data</parameter></term>
- <listitem>
- <para>
- pointer to data to send
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>rawtag</parameter></term>
- <listitem>
- <para>
- data to identify the request to completion handler
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect1>
-<refsect1>
- <title>Description</title>
- <para>
- DEPRECATED
- </para><para>
-
- This function starts the specified isochronous packet transmission and
- returns <constant>0</constant> for success and a negative number for an error, in which case
- errno will be set.
- </para><para>
-
- When the send completes, a <function>raw1394_loop_iterate</function> will call the tag handler
- and pass it the tag and error code of the transaction. <parameter>tag</parameter> should therefore
- be set to something that uniquely identifies this transaction (e.g. a struct
- pointer casted to unsigned long).
- </para><para>
-
- Isochronous packets are automatically
- </para>
-</refsect1>
-</refentry>
-
-<refentry>
-<refmeta>
-<refentrytitle><phrase id="API-raw1394-iso-write">raw1394_iso_write</phrase></refentrytitle>
-</refmeta>
-<refnamediv>
- <refname>raw1394_iso_write</refname>
- <refpurpose>
- DEPRECATED
- </refpurpose>
-</refnamediv>
-<refsynopsisdiv>
- <title>Synopsis</title>
- <funcsynopsis><funcprototype>
- <funcdef>int <function>raw1394_iso_write </function></funcdef>
- <paramdef>raw1394handle_t <parameter>handle</parameter></paramdef>
- <paramdef>unsigned int <parameter>channel</parameter></paramdef>
- <paramdef>unsigned int <parameter>tag</parameter></paramdef>
- <paramdef>unsigned int <parameter>sy</parameter></paramdef>
- <paramdef>unsigned int <parameter>speed</parameter></paramdef>
- <paramdef>size_t <parameter>length</parameter></paramdef>
- <paramdef>quadlet_t * <parameter>data</parameter></paramdef>
- </funcprototype></funcsynopsis>
-</refsynopsisdiv>
-<refsect1>
- <title>Arguments</title>
- <variablelist>
- <varlistentry>
- <term><parameter>handle</parameter></term>
- <listitem>
- <para>
- libraw1394 handle
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>channel</parameter></term>
- <listitem>
- <para>
- -- undescribed --
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>tag</parameter></term>
- <listitem>
- <para>
- -- undescribed --
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>sy</parameter></term>
- <listitem>
- <para>
- -- undescribed --
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>speed</parameter></term>
- <listitem>
- <para>
- -- undescribed --
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>length</parameter></term>
- <listitem>
- <para>
- -- undescribed --
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>data</parameter></term>
- <listitem>
- <para>
- -- undescribed --
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect1>
-<refsect1>
- <title>Description</title>
- <para>
- DEPRECATED
- </para>
-</refsect1>
-</refentry>
-
</chapter>
</book>