original/man4/dsp56k.4

   1 '\" t
   2 .\" Copyright (c) 2000 lars brinkhoff <lars@nocrew.org>
   3 .\"
   4 .\" This is free documentation; you can redistribute it and/or
   5 .\" modify it under the terms of the GNU General Public License as
   6 .\" published by the Free Software Foundation; either version 2 of
   7 .\" the License, or (at your option) any later version.
   8 .\"
   9 .\" The GNU General Public License's references to "object code"
  10 .\" and "executables" are to be interpreted as the output of any
  11 .\" document formatting or typesetting system, including
  12 .\" intermediate and printed output.
  13 .\"
  14 .\" This manual is distributed in the hope that it will be useful,
  15 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 .\" GNU General Public License for more details.
  18 .\"
  19 .\" You should have received a copy of the GNU General Public
  20 .\" License along with this manual; if not, write to the Free
  21 .\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
  22 .\" USA.
  23 .\"
  24 .\" Modified, Thu Jan 27 19:16:19 CET 2000, lars@nocrew.org
  25 .\"
  26 .TH DSP56K 4 2000-03-01 "Linux" "Linux Programmer's Manual"
  27 .SH NAME
  28 dsp56k \- DSP56001 interface device
  29 .SH SYNOPSIS
  30 .nf
  31 #include <asm/dsp56k.h>
  32 .sp
  33 .BI "ssize_t read(int " fd ", void *" data ", size_t " length );
  34 .BI "ssize_t write(int " fd ", void *" data ", size_t " length );
  35
  36 .BI "int ioctl(int " fd ", DSP56K_UPLOAD, struct dsp56k_upload *" program );
  37 .BI "int ioctl(int " fd ", DSP56K_SET_TX_WSIZE, int " wsize );
  38 .BI "int ioctl(int " fd ", DSP56K_SET_RX_WSIZE, int " wsize );
  39 .BI "int ioctl(int " fd ", DSP56K_HOST_FLAGS, struct dsp56k_host_flags *" flags );
  40 .BI "int ioctl(int " fd ", DSP56K_HOST_CMD, int " cmd );
  41 .fi
  42 .SH CONFIGURATION
  43 The dsp56k device is a character device with major number 55 and minor
  44 number 0.
  45 .SH DESCRIPTION
  46 The Motorola DSP56001 is a fully programmable 24-bit digital signal
  47 processor found in Atari Falcon030-compatible computers.
  48 The \fIdsp56k\fP special file is used to control the DSP56001, and
  49 to send and receive data using the bidirectional handshaked host
  50 port.
  51 .PP
  52 To send a data stream to the signal processor, use
  53 .BR write (2)
  54 to the
  55 device, and
  56 .BR read (2)
  57 to receive processed data.
  58 The data can be sent or
  59 received in 8, 16, 24, or 32-bit quantities on the host side, but will
  60 always be seen as 24-bit quantities in the DSP56001.
  61 .PP
  62 The following
  63 .BR ioctl (2)
  64 calls are used to control the
  65 \fIdsp56k\fP device:
  66 .IP \fBDSP56K_UPLOAD\fP
  67 resets the DSP56001 and uploads a program.
  68 The third
  69 .BR ioctl (2)
  70 argument must be a pointer to a \fIstruct dsp56k_binary\fP with members
  71 \fIbin\fP pointing to a DSP56001 binary program, and \fIlen\fP set to
  72 the length of the program, counted in 24-bit words.
  73 .IP \fBDSP56K_SET_TX_WSIZE\fP
  74 sets the transmit word size.
  75 Allowed values are in the range 1 to 4,
  76 and is the number of bytes that will be sent at a time to the
  77 DSP56001.
  78 These data quantities will either be padded with zero
  79 bytes, or truncated to fit the native 24-bit data format of the
  80 DSP56001.
  81 .IP \fBDSP56K_SET_RX_WSIZE\fP
  82 sets the receive word size.
  83 Allowed values are in the range 1 to 4,
  84 and is the number of bytes that will be received at a time from the
  85 DSP56001.
  86 These data quantities will either truncated, or padded with
  87 a null byte (\(aq\\0\(aq) to fit the native 24-bit data format of the DSP56001.
  88 .IP \fBDSP56K_HOST_FLAGS\fP
  89 read and write the host flags.
  90 The host flags are four
  91 general-purpose bits that can be read by both the hosting computer and
  92 the DSP56001.
  93 Bits 0 and 1 can be written by the host, and bits 2 and
  94 3 can be written by the DSP56001.
  95
  96 To access the host flags, the third
  97 .BR ioctl (2)
  98 argument must be a pointer
  99 to a \fIstruct dsp56k_host_flags\fP.
 100 If bit 0 or 1 is set in the
 101 \fIdir\fP member, the corresponding bit in \fIout\fP will be written
 102 to the host flags.
 103 The state of all host flags will be returned in
 104 the lower four bits of the \fIstatus\fP member.
 105 .IP \fBDSP56K_HOST_CMD\fP
 106 sends a host command.
 107 Allowed values are in the range 0 to 31, and is a
 108 user-defined command handled by the program running in the DSP56001.
 109 .SH FILES
 110 /dev/dsp56k
 111 .\" .SH AUTHORS
 112 .\" Fredrik Noring <noring@nocrew.org>, lars brinkhoff <lars@nocrew.org>,
 113 .\" Tomas Berndtsson <tomas@nocrew.org>.
 114 .SH "SEE ALSO"
 115 .IR linux/include/asm-m68k/dsp56k.h ,
 116 .IR linux/drivers/char/dsp56k.c ,
 117 .IR http://dsp56k.nocrew.org/ ,
 118 DSP56000/DSP56001 Digital Signal Processor User's Manual