original/man4/dsp56k.4

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