'\" t
.\" Copyright (c) 2000 lars brinkhoff <lars@nocrew.org>
.\"
+.\" %%%LICENSE_START(GPLv2+_DOC_FULL)
.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2 of
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public
-.\" License along with this manual; if not, write to the Free
-.\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
-.\" USA.
+.\" License along with this manual; if not, see
+.\" <http://www.gnu.org/licenses/>.
+.\" %%%LICENSE_END
.\"
.\" Modified, Thu Jan 27 19:16:19 CET 2000, lars@nocrew.org
.\"
-.TH DSP56K 4 2000-03-01 "" "Linux Programmer's Manual"
+.TH DSP56K 4 2012-08-05 "Linux" "Linux Programmer's Manual"
.SH NAME
dsp56k \- DSP56001 interface device
.SH SYNOPSIS
.sp
.BI "ssize_t read(int " fd ", void *" data ", size_t " length );
.BI "ssize_t write(int " fd ", void *" data ", size_t " length );
-.BI "int ioctl(int " fd ", \s-1DSP56K_UPLOAD\s+1, struct dsp56k_upload *" program );
-.BI "int ioctl(int " fd ", \s-1DSP56K_SET_TX_WSIZE\s+1, int " wsize );
-.BI "int ioctl(int " fd ", \s-1DSP56K_SET_RX_WSIZE\s+1, int " wsize );
-.BI "int ioctl(int " fd ", \s-1DSP56K_HOST_FLAGS\s+1, struct dsp56k_host_flags *" flags );
-.BI "int ioctl(int " fd ", \s-1DSP56K_HOST_CMD\s+1, int " cmd );
+
+.BI "int ioctl(int " fd ", DSP56K_UPLOAD, struct dsp56k_upload *" program );
+.BI "int ioctl(int " fd ", DSP56K_SET_TX_WSIZE, int " wsize );
+.BI "int ioctl(int " fd ", DSP56K_SET_RX_WSIZE, int " wsize );
+.BI "int ioctl(int " fd ", DSP56K_HOST_FLAGS, struct dsp56k_host_flags *" flags );
+.BI "int ioctl(int " fd ", DSP56K_HOST_CMD, int " cmd );
.fi
.SH CONFIGURATION
The dsp56k device is a character device with major number 55 and minor
.SH DESCRIPTION
The Motorola DSP56001 is a fully programmable 24-bit digital signal
processor found in Atari Falcon030-compatible computers.
-The \fBdsp56k\fP special file is used to control the DSP56001, and
-to send and receive data using the bi-directional handshaked host
+The \fIdsp56k\fP special file is used to control the DSP56001, and
+to send and receive data using the bidirectional handshaked host
port.
.PP
To send a data stream to the signal processor, use
The following
.BR ioctl (2)
calls are used to control the
-\fBdsp56k\fP device:
+\fIdsp56k\fP device:
.IP \fBDSP56K_UPLOAD\fP
resets the DSP56001 and uploads a program.
The third
.BR ioctl (2)
-argument must be a pointer to a \fBstruct dsp56k_binary\fP with members
-\fBbin\fP pointing to a DSP56001 binary program, and \fBlen\fP set to
+argument must be a pointer to a \fIstruct dsp56k_binary\fP with members
+\fIbin\fP pointing to a DSP56001 binary program, and \fIlen\fP set to
the length of the program, counted in 24-bit words.
.IP \fBDSP56K_SET_TX_WSIZE\fP
sets the transmit word size.
and is the number of bytes that will be received at a time from the
DSP56001.
These data quantities will either truncated, or padded with
-a null byte ('\\0') to fit the native 24-bit data format of the DSP56001.
+a null byte (\(aq\\0\(aq) to fit the native 24-bit data format of the DSP56001.
.IP \fBDSP56K_HOST_FLAGS\fP
read and write the host flags.
The host flags are four
To access the host flags, the third
.BR ioctl (2)
argument must be a pointer
-to a \fBstruct dsp56k_host_flags\fP.
+to a \fIstruct dsp56k_host_flags\fP.
If bit 0 or 1 is set in the
-\fBdir\fP member, the corresponding bit in \fBout\fP will be written
+\fIdir\fP member, the corresponding bit in \fIout\fP will be written
to the host flags.
The state of all host flags will be returned in
-the lower four bits of the \fBstatus\fP member.
+the lower four bits of the \fIstatus\fP member.
.IP \fBDSP56K_HOST_CMD\fP
sends a host command.
Allowed values are in the range 0 to 31, and is a
user-defined command handled by the program running in the DSP56001.
.SH FILES
/dev/dsp56k
-.SH AUTHORS
-Fredrik Noring <noring@nocrew.org>, lars brinkhoff <lars@nocrew.org>,
-Tomas Berndtsson <tomas@nocrew.org>.
-.SH "SEE ALSO"
-linux/include/asm-m68k/dsp56k.h,
-linux/drivers/char/dsp56k.c,
-http://dsp56k.nocrew.org/,
+.\" .SH AUTHORS
+.\" Fredrik Noring <noring@nocrew.org>, lars brinkhoff <lars@nocrew.org>,
+.\" Tomas Berndtsson <tomas@nocrew.org>.
+.SH SEE ALSO
+.IR linux/include/asm-m68k/dsp56k.h ,
+.IR linux/drivers/char/dsp56k.c ,
+.UR http://dsp56k.nocrew.org/
+.UE ,
DSP56000/DSP56001 Digital Signal Processor User's Manual
projects / thirdparty / man-pages.git / blobdiff