Import translated manuals from JM CVS Repository.

[linuxjm/jm.git] / manual / LDP_man-pages / draft / man4 / dsp56k.4

'\" t
.\" Copyright (c) 2000 lars brinkhoff <lars@nocrew.org>
.\"
.\" 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
.\" the License, or (at your option) any later version.
.\"
.\" The GNU General Public License's references to "object code"
.\" and "executables" are to be interpreted as the output of any
.\" document formatting or typesetting system, including
.\" intermediate and printed output.
.\"
.\" This manual is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" 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.
.\"
.\" Modified, Thu Jan 27 19:16:19 CET 2000, lars@nocrew.org
.\"
.\" Japanese Version Copyright (c) 2000 Yuichi SATO
.\"         all rights reserved.
.\" Translated Tue Jul 11 20:05:48 JST 2000
.\"         by Yuichi SATO <sato@complex.eng.hokudai.ac.jp>
.\"
.\"WORD:        handshake       ¥Ï¥ó¥É¥·¥§¥¤¥¯
.\"WORD:        device          ¥Ç¥Ð¥¤¥¹
.\"WORD:        processer       ¥×¥í¥»¥Ã¥µ¡¼
.\"WORD:        transmit        Á÷¿®
.\"WORD:        recieve         ¼õ¿®
.\"WORD:        quantity        ñ°Ì
.\"
.TH DSP56K 4 2000-03-01 "Linux" "Linux Programmer's Manual"
.\"O .SH NAME
.SH ̾Á°
.\"O dsp56k \- DSP56001 interface device
dsp56k \- DSP56001 ¤Î¥¤¥ó¥¿¡¼¥Õ¥§¡¼¥¹¡¦¥Ç¥Ð¥¤¥¹
.\"O .SH SYNOPSIS
.SH ½ñ¼°
.nf
#include <asm/dsp56k.h>
.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 ", 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
.\"O .SH CONFIGURATION
.SH ÀßÄê
.\"O The dsp56k device is a character device with major number 55 and minor
.\"O number 0.
dsp56k ¥Ç¥Ð¥¤¥¹¤Ï¡¢¥á¥¸¥ã¡¼ÈÖ¹æ 55¡¢¥Þ¥¤¥Ê¡¼ÈÖ¹æ 0 ¤Î
¥­¥ã¥é¥¯¥¿¡¼¡¦¥Ç¥Ð¥¤¥¹¤Ç¤¢¤ë¡£
.\"O .SH DESCRIPTION
.SH ÀâÌÀ
.\"O The Motorola DSP56001 is a fully programmable 24-bit digital signal
.\"O processor found in Atari Falcon030-compatible computers.
.\"O The \fIdsp56k\fP special file is used to control the DSP56001, and
.\"O to send and receive data using the bidirectional handshaked host
.\"O port.
Motorola DSP56001 ¤Ï¡¢Atari Falcon030 ¸ß´¹¤Î¥³¥ó¥Ô¥å¡¼¥¿¤Ç»È¤ï¤ì¤Æ¤¤¤ë
¥Õ¥ë¥×¥í¥°¥é¥Þ¥Ö¥ë¤Ê 24 ¥Ó¥Ã¥È¤Î¥Ç¥¸¥¿¥ë¥·¥°¥Ê¥ë¥×¥í¥»¥Ã¥µ¡¼¤Ç¤¢¤ë¡£
¥¹¥Ú¥·¥ã¥ë¥Õ¥¡¥¤¥ë \fIdsp56k\fP ¤Ï¡¢DSP56001 ¤ÎÀ©¸æ¤È
ÁÐÊý¸þ¥Ï¥ó¥É¥·¥§¥¤¥¯¥Û¥¹¥È¥Ý¡¼¥È¤Ç¤Î¥Ç¡¼¥¿¤ÎÁ÷¼õ¿®¤Î¤¿¤á¤Ë»È¤ï¤ì¤ë¡£
.PP
.\"O To send a data stream to the signal processor, use
.\"O .BR write (2)
.\"O to the
.\"O device, and
.\"O .BR read (2)
.\"O to receive processed data.
.\"O The data can be sent or
.\"O received in 8, 16, 24, or 32-bit quantities on the host side, but will
.\"O always be seen as 24-bit quantities in the DSP56001.
¥Ç¡¼¥¿¥¹¥È¥ê¡¼¥à¤ò¥·¥°¥Ê¥ë¥×¥í¥»¥Ã¥µ¡¼¤ËÁ÷¿®¤¹¤ë¤¿¤á¤Ë¤Ï¡¢
¥Ç¥Ð¥¤¥¹¤ËÂФ·¤Æ
.BR write (2)
¤ò»È¤¦¤³¤È¡£
½èÍý¤µ¤ì¤¿¥Ç¡¼¥¿¤ò¼õ¿®¤¹¤ë¤¿¤á¤Ë¤Ï¡¢
.BR read (2)
¤ò»È¤¦¤³¤È¡£
¥Û¥¹¥È¦¤Ç¤Ï¡¢¥Ç¡¼¥¿¤Ï 8, 16, 24, 32 ¥Ó¥Ã¥Èñ°Ì¤ÇÁ÷¼õ¿®¤Ç¤­¤ë¤¬¡¢
DSP56001 Æâ¤Ç¤Ï¡¢24 ¥Ó¥Ã¥Èñ°Ì¤Ç°·¤ï¤ì¤ë¡£
.PP
.\"O The following
.\"O .BR ioctl (2)
.\"O calls are used to control the
.\"O \fIdsp56k\fP device:
¼¡¤Î
.BR ioctl (2)
¥³¡¼¥ë¤¬ \fIdsp56k\fP ¥Ç¥Ð¥¤¥¹¤òÀ©¸æ¤¹¤ë¤¿¤á¤Ë»È¤ï¤ì¤ë¡£
.IP \fBDSP56K_UPLOAD\fP
.\"O resets the DSP56001 and uploads a program.
.\"O The third
.\"O .BR ioctl(2)
.\"O argument must be a pointer to a \fIstruct dsp56k_binary\fP with members
.\"O \fIbin\fP pointing to a DSP56001 binary program, and \fIlen\fP set to
.\"O the length of the program, counted in 24-bit words.
DSP56001 ¤ò¥ê¥»¥Ã¥È¤·¡¢¥×¥í¥°¥é¥à¤ò¥¢¥Ã¥×¥í¡¼¥É¤¹¤ë¡£
.BR ioctl (2)
¤Î 3 ÈÖÌܤΰú¤­¿ô¤Ï¡¢
¹½Â¤ÂÎ \fIstruct dsp56k_binary\fP ¤Ø¤Î¥Ý¥¤¥ó¥¿¤Ç¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£
¹½Â¤ÂΤΥá¥ó¥Ð¡¼ \fIbin\fP ¤Ï DSP56001 ¥Ð¥¤¥Ê¥ê¥×¥í¥°¥é¥à¤ò»Ø¤·¡¢
¹½Â¤ÂΤΥá¥ó¥Ð¡¼ \fIlen\fP ¤Ï 24 ¥Ó¥Ã¥È¥ï¡¼¥É¤Ç¿ô¤¨¤¿
¥×¥í¥°¥é¥à¤ÎŤµ¤ËÀßÄꤵ¤ì¤Æ¤¤¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£
.IP \fBDSP56K_SET_TX_WSIZE\fP
.\"O sets the transmit word size.
.\"O Allowed values are in the range 1 to 4,
.\"O and is the number of bytes that will be sent at a time to the
.\"O DSP56001.
.\"O These data quantities will either be padded with zero
.\"O bytes, or truncated to fit the native 24-bit data format of the
.\"O DSP56001.
Á÷¿®¥ï¡¼¥É¥µ¥¤¥º¤òÀßÄꤹ¤ë¡£
ÀßÄê¤Ç¤­¤ëÃÍ¤Ï 1 ¡Á 4 ¤ÎÈϰϤǡ¢¤³¤Î¥Ð¥¤¥È¿ôʬ¤À¤± 1 ÅÙ¤Ë DSP56001 ¤ËÁ÷¿®¤¹¤ë¡£
¤³¤Î¥Ç¡¼¥¿Ã±°Ì¤Ï¡¢DSP56001 ËÜÍè¤Î 24 ¥Ó¥Ã¥È¥Ç¡¼¥¿·Á¼°¤Ë¹ç¤ï¤»¤ë¤¿¤á¡¢
¥¼¥í¤Î¥Ð¥¤¥È¤ÇËä¤á¤é¤ì¤¿¤ê¡¢ÀÚ¤êµÍ¤á¤é¤ì¤¿¤ê¤¹¤ë¡£
.IP \fBDSP56K_SET_RX_WSIZE\fP
.\"O sets the receive word size.
.\"O Allowed values are in the range 1 to 4,
.\"O and is the number of bytes that will be received at a time from the
.\"O DSP56001.
.\"O These data quantities will either truncated, or padded with
.\"O a null byte (\(aq\\0\(aq) to fit the native 24-bit data format of the DSP56001.
¼õ¿®¥ï¡¼¥É¥µ¥¤¥º¤òÀßÄꤹ¤ë¡£
ÀßÄê¤Ç¤­¤ëÃÍ¤Ï 1 ¡Á 4 ¤ÎÈϰϤǡ¢
¤³¤Î¥Ð¥¤¥È¿ôʬ¤À¤± 1 ÅÙ¤Ë DSP56001 ¤«¤é¼õ¿®¤¹¤ë¡£
¤³¤Î¥Ç¡¼¥¿Ã±°Ì¤Ï¡¢DSP56001 ËÜÍè¤Î 24 ¥Ó¥Ã¥È¥Ç¡¼¥¿·Á¼°¤Ë¹ç¤ï¤»¤ë¤¿¤á¡¢
ÀÚ¤êµÍ¤á¤é¤ì¤¿¤ê¡¢NULL ¥Ð¥¤¥È (\(aq\\0\(aq) ¤ÇËä¤á¤é¤ì¤¿¤ê¤¹¤ë¡£
.IP \fBDSP56K_HOST_FLAGS\fP
.\"O read and write the host flags.
.\"O The host flags are four
.\"O general-purpose bits that can be read by both the hosting computer and
.\"O the DSP56001.
.\"O Bits 0 and 1 can be written by the host, and bits 2 and
.\"O 3 can be written by the DSP56001.
¥Û¥¹¥È¥Õ¥é¥°¤òÆɤ߽ñ¤­¤¹¤ë¡£
¥Û¥¹¥È¥Õ¥é¥°¤Ï¡¢°ìÈÌŪ¤ÊÌÜŪ¤Ç»È¤¦¤³¤È¤Î¤Ç¤­¤ë¥Ó¥Ã¥È¤Ç¡¢
¥Û¥¹¥È¥³¥ó¥Ô¥å¡¼¥¿¤È DSP56001 ¤ÎξÊý¤«¤éÆɤळ¤È¤¬¤Ç¤­¤ë¡£
¥Ó¥Ã¥È 0 ¤È 1 ¤Ï¡¢¥Û¥¹¥È¤Ë¤è¤Ã¤Æ½ñ¤­¹þ¤à¤³¤È¤¬¤Ç¤­¡¢
¥Ó¥Ã¥È 2 ¤È 3 ¤Ï¡¢DSP56001 ¤Ë¤è¤Ã¤Æ½ñ¤­¹þ¤à¤³¤È¤¬¤Ç¤­¤ë¡£

.\"O To access the host flags, the third
.\"O .BR ioctl (2)
.\"O argument must be a pointer
.\"O to a \fIstruct dsp56k_host_flags\fP.
.\"O If bit 0 or 1 is set in the
.\"O \fIdir\fP member, the corresponding bit in \fIout\fP will be written
.\"O to the host flags.
.\"O The state of all host flags will be returned in
.\"O the lower four bits of the \fIstatus\fP member.
¥Û¥¹¥È¥Õ¥é¥°¤Ë¥¢¥¯¥»¥¹¤¹¤ë¤¿¤á¤Ë¤Ï¡¢
.BR ioctl (2)
¤Î 3 ÈÖÌܤΰú¤­¿ô¤¬
¹½Â¤ÂÎ \fIstruct dsp56k_host_flags\fP ¤Ø¤Î¥Ý¥¤¥ó¥¿¤Ç¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£
¤³¤Î¹½Â¤ÂΤΥá¥ó¥Ð¡¼ \fIdir\fP ¤Î¥Ó¥Ã¥È 0 ¤Þ¤¿¤Ï 1 ¤¬ÀßÄꤵ¤ì¤ë¤È¡¢
¥á¥ó¥Ð¡¼ \fIout\fP ¤ÎÂбþ¤¹¤ë¥Ó¥Ã¥È¤ÎÃͤ¬¥Û¥¹¥È¥Õ¥é¥°¤Ë½ñ¤­¹þ¤Þ¤ì¤ë¡£
¤¹¤Ù¤Æ¤Î¥Û¥¹¥È¥Õ¥é¥°¤Î¾õÂ֤ϡ¢¹½Â¤ÂΤΥá¥ó¥Ð¡¼ \fIstatus\fP ¤Î
²¼¤«¤é 4 ¥Ó¥Ã¥È¤È¤·¤ÆÊÖ¤µ¤ì¤ë¡£
.IP \fBDSP56K_HOST_CMD\fP
.\"O sends a host command.
.\"O Allowed values are in the range 0 to 31, and is a
.\"O user-defined command handled by the program running in the DSP56001.
¥Û¥¹¥È¥³¥Þ¥ó¥É¤òÁ÷¿®¤¹¤ë¡£
Á÷¿®¤Ç¤­¤ëÃÍ¤Ï 0 ¡Á 31 ¤ÎÈϰϤǡ¢DSP56001 ¤ÇÆ°ºî¤·¤Æ¤¤¤ë¥×¥í¥°¥é¥à¤Ë¤è¤Ã¤Æ
½èÍý¤µ¤ì¤ë¥æ¡¼¥¶¡¼ÄêµÁ¥³¥Þ¥ó¥É¤Ç¤¢¤ë¡£
.\"O .SH FILES
.SH ¥Õ¥¡¥¤¥ë
/dev/dsp56k
.\"O .\" .SH AUTHORS
.\" .SH Ãø¼Ô
.\" Fredrik Noring <noring@nocrew.org>, lars brinkhoff <lars@nocrew.org>,
.\" Tomas Berndtsson <tomas@nocrew.org>.
.\"O .SH "SEE ALSO"
.SH ´ØÏ¢¹àÌÜ
.IR linux/include/asm-m68k/dsp56k.h ,
.IR linux/drivers/char/dsp56k.c ,
.IR http://dsp56k.nocrew.org/ ,
DSP56000/DSP56001 Digital Signal Processor User's Manual