libraw1394.sgml, raw1394.h: remove information about deprecated isochronous
API that has been removed.
This commit is contained in:
Dan Dennedy
parent
832c9c3d89
commit
3b4d2eed60
50
INSTALL
50
INSTALL
|
|
@ -1,8 +1,8 @@
|
|||
Installation Instructions
|
||||
*************************
|
||||
|
||||
Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005 Free
|
||||
Software Foundation, Inc.
|
||||
Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
|
||||
2006 Free Software Foundation, Inc.
|
||||
|
||||
This file is free documentation; the Free Software Foundation gives
|
||||
unlimited permission to copy, distribute and modify it.
|
||||
|
|
@ -10,7 +10,10 @@ unlimited permission to copy, distribute and modify it.
|
|||
Basic Installation
|
||||
==================
|
||||
|
||||
These are generic installation instructions.
|
||||
Briefly, the shell commands `./configure; make; make install' should
|
||||
configure, build, and install this package. The following
|
||||
more-detailed instructions are generic; see the `README' file for
|
||||
instructions specific to this package.
|
||||
|
||||
The `configure' shell script attempts to guess correct values for
|
||||
various system-dependent variables used during compilation. It uses
|
||||
|
|
@ -23,9 +26,9 @@ debugging `configure').
|
|||
|
||||
It can also use an optional file (typically called `config.cache'
|
||||
and enabled with `--cache-file=config.cache' or simply `-C') that saves
|
||||
the results of its tests to speed up reconfiguring. (Caching is
|
||||
the results of its tests to speed up reconfiguring. Caching is
|
||||
disabled by default to prevent problems with accidental use of stale
|
||||
cache files.)
|
||||
cache files.
|
||||
|
||||
If you need to do unusual things to compile the package, please try
|
||||
to figure out how `configure' could check whether to do them, and mail
|
||||
|
|
@ -35,20 +38,17 @@ some point `config.cache' contains results you don't want to keep, you
|
|||
may remove or edit it.
|
||||
|
||||
The file `configure.ac' (or `configure.in') is used to create
|
||||
`configure' by a program called `autoconf'. You only need
|
||||
`configure.ac' if you want to change it or regenerate `configure' using
|
||||
a newer version of `autoconf'.
|
||||
`configure' by a program called `autoconf'. You need `configure.ac' if
|
||||
you want to change it or regenerate `configure' using a newer version
|
||||
of `autoconf'.
|
||||
|
||||
The simplest way to compile this package is:
|
||||
|
||||
1. `cd' to the directory containing the package's source code and type
|
||||
`./configure' to configure the package for your system. If you're
|
||||
using `csh' on an old version of System V, you might need to type
|
||||
`sh ./configure' instead to prevent `csh' from trying to execute
|
||||
`configure' itself.
|
||||
`./configure' to configure the package for your system.
|
||||
|
||||
Running `configure' takes awhile. While running, it prints some
|
||||
messages telling which features it is checking for.
|
||||
Running `configure' might take a while. While running, it prints
|
||||
some messages telling which features it is checking for.
|
||||
|
||||
2. Type `make' to compile the package.
|
||||
|
||||
|
|
@ -78,7 +78,7 @@ details on some of the pertinent environment variables.
|
|||
by setting variables in the command line or in the environment. Here
|
||||
is an example:
|
||||
|
||||
./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
|
||||
./configure CC=c99 CFLAGS=-g LIBS=-lposix
|
||||
|
||||
*Note Defining Variables::, for more details.
|
||||
|
||||
|
|
@ -87,17 +87,15 @@ Compiling For Multiple Architectures
|
|||
|
||||
You can compile the package for more than one kind of computer at the
|
||||
same time, by placing the object files for each architecture in their
|
||||
own directory. To do this, you must use a version of `make' that
|
||||
supports the `VPATH' variable, such as GNU `make'. `cd' to the
|
||||
own directory. To do this, you can use GNU `make'. `cd' to the
|
||||
directory where you want the object files and executables to go and run
|
||||
the `configure' script. `configure' automatically checks for the
|
||||
source code in the directory that `configure' is in and in `..'.
|
||||
|
||||
If you have to use a `make' that does not support the `VPATH'
|
||||
variable, you have to compile the package for one architecture at a
|
||||
time in the source code directory. After you have installed the
|
||||
package for one architecture, use `make distclean' before reconfiguring
|
||||
for another architecture.
|
||||
With a non-GNU `make', it is safer to compile the package for one
|
||||
architecture at a time in the source code directory. After you have
|
||||
installed the package for one architecture, use `make distclean' before
|
||||
reconfiguring for another architecture.
|
||||
|
||||
Installation Names
|
||||
==================
|
||||
|
|
@ -190,12 +188,12 @@ them in the `configure' command line, using `VAR=value'. For example:
|
|||
./configure CC=/usr/local2/bin/gcc
|
||||
|
||||
causes the specified `gcc' to be used as the C compiler (unless it is
|
||||
overridden in the site shell script). Here is a another example:
|
||||
overridden in the site shell script).
|
||||
|
||||
/bin/bash ./configure CONFIG_SHELL=/bin/bash
|
||||
Unfortunately, this technique does not work for `CONFIG_SHELL' due to
|
||||
an Autoconf bug. Until the bug is fixed you can use this workaround:
|
||||
|
||||
Here the `CONFIG_SHELL=/bin/bash' operand causes subsequent
|
||||
configuration-related scripts to be executed by `/bin/bash'.
|
||||
CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
|
||||
|
||||
`configure' Invocation
|
||||
======================
|
||||
|
|
|
|||
|
|
@ -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 &struct
|
||||
<function>raw1394_lock</function>) since these do pass pointers to &struct
|
||||
raw1394_reqhandle as the tag and expect the callback to be invoked.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
|
@ -5023,418 +5023,6 @@
|
|||
-1 for failure, 0 for success
|
||||
</para>
|
||||
</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>
|
||||
|
|
|
|||
|
|
@ -363,7 +363,7 @@ typedef int raw1394_errcode_t;
|
|||
* roughly the same meaning.
|
||||
*
|
||||
* Returns: the error code of the last raw1394_read(), raw1394_write(),
|
||||
* raw1394_lock() or raw1394_iso_write(). The error code is either an internal
|
||||
* raw1394_lock(). 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.
|
||||
*
|
||||
|
|
@ -651,7 +651,7 @@ typedef int (*tag_handler_t)(raw1394handle_t, unsigned long tag,
|
|||
*
|
||||
* Care must be taken when replacing the tag handler and calling the synchronous
|
||||
* versions of the transaction functions (i.e. raw1394_read(), raw1394_write(),
|
||||
* raw1394_lock(), raw1394_iso_write()) since these do pass pointers to &struct
|
||||
* raw1394_lock()) since these do pass pointers to &struct
|
||||
* raw1394_reqhandle as the tag and expect the callback to be invoked.
|
||||
*
|
||||
* Returns: the old handler
|
||||
|
|
|
|||
Reference in New Issue