draft/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 .\" Japanese Version Copyright (c) 2000 Yuichi SATO
  27 .\"         all rights reserved.
  28 .\" Translated Tue Jul 11 20:05:48 JST 2000
  29 .\"         by Yuichi SATO <sato@complex.eng.hokudai.ac.jp>
  30 .\"
  31 .\"WORD:        handshake       ハンドシェイク
  32 .\"WORD:        device          デバイス
  33 .\"WORD:        processer       プロセッサー
  34 .\"WORD:        transmit        送信
  35 .\"WORD:        recieve         受信
  36 .\"WORD:        quantity        単位
  37 .\"
  38 .TH DSP56K 4 2000-03-01 "Linux" "Linux Programmer's Manual"
  39 .\"O .SH NAME
  40 .SH 名前
  41 .\"O dsp56k \- DSP56001 interface device
  42 dsp56k \- DSP56001 のインターフェース・デバイス
  43 .\"O .SH SYNOPSIS
  44 .SH 書式
  45 .nf
  46 #include <asm/dsp56k.h>
  47 .sp
  48 .BI "ssize_t read(int " fd ", void *" data ", size_t " length );
  49 .BI "ssize_t write(int " fd ", void *" data ", size_t " length );
  50
  51 .BI "int ioctl(int " fd ", DSP56K_UPLOAD, struct dsp56k_upload *" program );
  52 .BI "int ioctl(int " fd ", DSP56K_SET_TX_WSIZE, int " wsize );
  53 .BI "int ioctl(int " fd ", DSP56K_SET_RX_WSIZE, int " wsize );
  54 .BI "int ioctl(int " fd ", DSP56K_HOST_FLAGS, struct dsp56k_host_flags *" flags );
  55 .BI "int ioctl(int " fd ", DSP56K_HOST_CMD, int " cmd );
  56 .fi
  57 .\"O .SH CONFIGURATION
  58 .SH 設定
  59 .\"O The dsp56k device is a character device with major number 55 and minor
  60 .\"O number 0.
  61 dsp56k デバイスは、メジャー番号 55、マイナー番号 0 の
  62 キャラクター・デバイスである。
  63 .\"O .SH DESCRIPTION
  64 .SH 説明
  65 .\"O The Motorola DSP56001 is a fully programmable 24-bit digital signal
  66 .\"O processor found in Atari Falcon030-compatible computers.
  67 .\"O The \fIdsp56k\fP special file is used to control the DSP56001, and
  68 .\"O to send and receive data using the bidirectional handshaked host
  69 .\"O port.
  70 Motorola DSP56001 は、Atari Falcon030 互換のコンピュータで使われている
  71 フルプログラマブルな 24 ビットのデジタルシグナルプロセッサーである。
  72 スペシャルファイル \fIdsp56k\fP は、DSP56001 の制御と
  73 双方向ハンドシェイクホストポートでのデータの送受信のために使われる。
  74 .PP
  75 .\"O To send a data stream to the signal processor, use
  76 .\"O .BR write (2)
  77 .\"O to the
  78 .\"O device, and
  79 .\"O .BR read (2)
  80 .\"O to receive processed data.
  81 .\"O The data can be sent or
  82 .\"O received in 8, 16, 24, or 32-bit quantities on the host side, but will
  83 .\"O always be seen as 24-bit quantities in the DSP56001.
  84 データストリームをシグナルプロセッサーに送信するためには、
  85 デバイスに対して
  86 .BR write (2)
  87 を使うこと。
  88 処理されたデータを受信するためには、
  89 .BR read (2)
  90 を使うこと。
  91 ホスト側では、データは 8, 16, 24, 32 ビット単位で送受信できるが、
  92 DSP56001 内では、24 ビット単位で扱われる。
  93 .PP
  94 .\"O The following
  95 .\"O .BR ioctl (2)
  96 .\"O calls are used to control the
  97 .\"O \fIdsp56k\fP device:
  98 次の
  99 .BR ioctl (2)
 100 コールが \fIdsp56k\fP デバイスを制御するために使われる。
 101 .IP \fBDSP56K_UPLOAD\fP
 102 .\"O resets the DSP56001 and uploads a program.
 103 .\"O The third
 104 .\"O .BR ioctl(2)
 105 .\"O argument must be a pointer to a \fIstruct dsp56k_binary\fP with members
 106 .\"O \fIbin\fP pointing to a DSP56001 binary program, and \fIlen\fP set to
 107 .\"O the length of the program, counted in 24-bit words.
 108 DSP56001 をリセットし、プログラムをアップロードする。
 109 .BR ioctl (2)
 110 の 3 番目の引き数は、
 111 構造体 \fIstruct dsp56k_binary\fP へのポインタでなければならない。
 112 構造体のメンバー \fIbin\fP は DSP56001 バイナリプログラムを指し、
 113 構造体のメンバー \fIlen\fP は 24 ビットワードで数えた
 114 プログラムの長さに設定されていなければならない。
 115 .IP \fBDSP56K_SET_TX_WSIZE\fP
 116 .\"O sets the transmit word size.
 117 .\"O Allowed values are in the range 1 to 4,
 118 .\"O and is the number of bytes that will be sent at a time to the
 119 .\"O DSP56001.
 120 .\"O These data quantities will either be padded with zero
 121 .\"O bytes, or truncated to fit the native 24-bit data format of the
 122 .\"O DSP56001.
 123 送信ワードサイズを設定する。
 124 設定できる値は 1 〜 4 の範囲で、このバイト数分だけ 1 度に DSP56001 に送信する。
 125 このデータ単位は、DSP56001 本来の 24 ビットデータ形式に合わせるため、
 126 ゼロのバイトで埋められたり、切り詰められたりする。
 127 .IP \fBDSP56K_SET_RX_WSIZE\fP
 128 .\"O sets the receive word size.
 129 .\"O Allowed values are in the range 1 to 4,
 130 .\"O and is the number of bytes that will be received at a time from the
 131 .\"O DSP56001.
 132 .\"O These data quantities will either truncated, or padded with
 133 .\"O a null byte (\(aq\\0\(aq) to fit the native 24-bit data format of the DSP56001.
 134 受信ワードサイズを設定する。
 135 設定できる値は 1 〜 4 の範囲で、
 136 このバイト数分だけ 1 度に DSP56001 から受信する。
 137 このデータ単位は、DSP56001 本来の 24 ビットデータ形式に合わせるため、
 138 切り詰められたり、NULL バイト (\(aq\\0\(aq) で埋められたりする。
 139 .IP \fBDSP56K_HOST_FLAGS\fP
 140 .\"O read and write the host flags.
 141 .\"O The host flags are four
 142 .\"O general-purpose bits that can be read by both the hosting computer and
 143 .\"O the DSP56001.
 144 .\"O Bits 0 and 1 can be written by the host, and bits 2 and
 145 .\"O 3 can be written by the DSP56001.
 146 ホストフラグを読み書きする。
 147 ホストフラグは、一般的な目的で使うことのできるビットで、
 148 ホストコンピュータと DSP56001 の両方から読むことができる。
 149 ビット 0 と 1 は、ホストによって書き込むことができ、
 150 ビット 2 と 3 は、DSP56001 によって書き込むことができる。
 151
 152 .\"O To access the host flags, the third
 153 .\"O .BR ioctl (2)
 154 .\"O argument must be a pointer
 155 .\"O to a \fIstruct dsp56k_host_flags\fP.
 156 .\"O If bit 0 or 1 is set in the
 157 .\"O \fIdir\fP member, the corresponding bit in \fIout\fP will be written
 158 .\"O to the host flags.
 159 .\"O The state of all host flags will be returned in
 160 .\"O the lower four bits of the \fIstatus\fP member.
 161 ホストフラグにアクセスするためには、
 162 .BR ioctl (2)
 163 の 3 番目の引き数が
 164 構造体 \fIstruct dsp56k_host_flags\fP へのポインタでなければならない。
 165 この構造体のメンバー \fIdir\fP のビット 0 または 1 が設定されると、
 166 メンバー \fIout\fP の対応するビットの値がホストフラグに書き込まれる。
 167 すべてのホストフラグの状態は、構造体のメンバー \fIstatus\fP の
 168 下から 4 ビットとして返される。
 169 .IP \fBDSP56K_HOST_CMD\fP
 170 .\"O sends a host command.
 171 .\"O Allowed values are in the range 0 to 31, and is a
 172 .\"O user-defined command handled by the program running in the DSP56001.
 173 ホストコマンドを送信する。
 174 送信できる値は 0 〜 31 の範囲で、DSP56001 で動作しているプログラムによって
 175 処理されるユーザー定義コマンドである。
 176 .\"O .SH FILES
 177 .SH ファイル
 178 /dev/dsp56k
 179 .\"O .\" .SH AUTHORS
 180 .\" .SH 著者
 181 .\" Fredrik Noring <noring@nocrew.org>, lars brinkhoff <lars@nocrew.org>,
 182 .\" Tomas Berndtsson <tomas@nocrew.org>.
 183 .\"O .SH "SEE ALSO"
 184 .SH 関連項目
 185 .IR linux/include/asm-m68k/dsp56k.h ,
 186 .IR linux/drivers/char/dsp56k.c ,
 187 .IR http://dsp56k.nocrew.org/ ,
 188 DSP56000/DSP56001 Digital Signal Processor User's Manual