summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorGravatar ddennedy 2005-02-16 16:54:58 +0000
committerGravatar ddennedy 2005-02-16 16:54:58 +0000
commit246f623e3565912a8b407108524e02dfae547855 (patch)
tree80dddedefab9886023c109eacb4763a7b31f6f0c /doc
parentadd comment about assumptions made in raw1394_get_port_info (diff)
add functions for allocating and releasing bandwidth and channels
git-svn-id: svn://svn.linux1394.org/libraw1394/trunk@154 53a565d1-3bb7-0310-b661-cf11e63c67ab
Diffstat (limited to 'doc')
-rw-r--r--doc/libraw1394.sgml126
1 files changed, 125 insertions, 1 deletions
diff --git a/doc/libraw1394.sgml b/doc/libraw1394.sgml
index 8b4e394..f61b669 100644
--- a/doc/libraw1394.sgml
+++ b/doc/libraw1394.sgml
@@ -4,7 +4,7 @@
<bookinfo>
<title>libraw1394</title>
- <subtitle>version 1.1.0</subtitle>
+ <subtitle>version 1.2.0</subtitle>
<copyright>
<year>2001-2004</year>
@@ -4893,6 +4893,130 @@
<refentry>
<refmeta>
+<refentrytitle><phrase id="API-raw1394-bandwidth-modify">raw1394_bandwidth_modify</phrase></refentrytitle>
+</refmeta>
+<refnamediv>
+ <refname>raw1394_bandwidth_modify</refname>
+ <refpurpose>
+ allocate or release bandwidth
+ </refpurpose>
+</refnamediv>
+<refsynopsisdiv>
+ <title>Synopsis</title>
+ <funcsynopsis><funcprototype>
+ <funcdef>int <function>raw1394_bandwidth_modify </function></funcdef>
+ <paramdef>raw1394handle_t <parameter>handle</parameter></paramdef>
+ <paramdef>unsigned int <parameter>bandwidth</parameter></paramdef>
+ <paramdef>enum raw1394_modify_mode <parameter>mode</parameter></paramdef>
+ </funcprototype></funcsynopsis>
+</refsynopsisdiv>
+<refsect1>
+ <title>Arguments</title>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>handle</parameter></term>
+ <listitem>
+ <para>
+ a libraw1394 handle
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>bandwidth</parameter></term>
+ <listitem>
+ <para>
+ IEEE 1394 Bandwidth Alloction Units
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>mode</parameter></term>
+ <listitem>
+ <para>
+ whether to allocate or free
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+</refsect1>
+<refsect1>
+ <title>Description</title>
+ <para>
+ Communicates with the isochronous resource manager.
+ </para>
+</refsect1>
+<refsect1>
+ <title>Return</title>
+ <para>
+ -1 for failure, 0 for success
+ </para>
+</refsect1>
+</refentry>
+
+<refentry>
+<refmeta>
+<refentrytitle><phrase id="API-raw1394-channel-modify">raw1394_channel_modify</phrase></refentrytitle>
+</refmeta>
+<refnamediv>
+ <refname>raw1394_channel_modify</refname>
+ <refpurpose>
+ allocate or release isochronous channel
+ </refpurpose>
+</refnamediv>
+<refsynopsisdiv>
+ <title>Synopsis</title>
+ <funcsynopsis><funcprototype>
+ <funcdef>int <function>raw1394_channel_modify </function></funcdef>
+ <paramdef>raw1394handle_t <parameter>handle</parameter></paramdef>
+ <paramdef>unsigned int <parameter>channel</parameter></paramdef>
+ <paramdef>enum raw1394_modify_mode <parameter>mode</parameter></paramdef>
+ </funcprototype></funcsynopsis>
+</refsynopsisdiv>
+<refsect1>
+ <title>Arguments</title>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>handle</parameter></term>
+ <listitem>
+ <para>
+ a libraw1394 handle
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>channel</parameter></term>
+ <listitem>
+ <para>
+ isochronous channel
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>mode</parameter></term>
+ <listitem>
+ <para>
+ whether to allocate or free
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+</refsect1>
+<refsect1>
+ <title>Description</title>
+ <para>
+ Communicates with the isochronous resource manager.
+ </para>
+</refsect1>
+<refsect1>
+ <title>Return</title>
+ <para>
+ -1 for failure, 0 for success
+ </para>
+</refsect1>
+</refentry>
+
+<refentry>
+<refmeta>
<refentrytitle><phrase id="API-int">int</phrase></refentrytitle>
</refmeta>
<refnamediv>