Debian Codegraph @

upstream/debian-unstable/man4/dsp56k.4

raw
1 .\" Copyright 2000, Lars Brinkhoff <[email protected]>
2 .\" Copyright, the authors of the Linux man-pages project
3 .\"
4 .\" SPDX-License-Identifier: GPL-2.0-or-later
5 .\"
6 .TH dsp56k 4 2026-02-08 "Linux man-pages 6.18"
7 .SH NAME
8 dsp56k \- DSP56001 interface device
9 .SH SYNOPSIS
10 .nf
11 .B #include <asm/dsp56k.h>
12 .P
13 .BI "ssize_t read(int " fd ", void *" data ", size_t " length );
14 .BI "ssize_t write(int " fd ", void *" data ", size_t " length );
15 .P
16 .BI "int ioctl(int " fd ", DSP56K_UPLOAD, struct dsp56k_upload *" program );
17 .BI "int ioctl(int " fd ", DSP56K_SET_TX_WSIZE, int " wsize );
18 .BI "int ioctl(int " fd ", DSP56K_SET_RX_WSIZE, int " wsize );
19 .BI "int ioctl(int " fd ", DSP56K_HOST_FLAGS, struct dsp56k_host_flags *" flags );
20 .BI "int ioctl(int " fd ", DSP56K_HOST_CMD, int " cmd );
21 .fi
22 .SH CONFIGURATION
23 The
24 .I dsp56k
25 device is a character device with major number 55 and minor
26 number 0.
27 .SH DESCRIPTION
28 The Motorola DSP56001 is a fully programmable 24-bit digital signal
29 processor found in Atari Falcon030-compatible computers.
30 The
31 .I dsp56k
32 special file is used to control the DSP56001, and
33 to send and receive data using the bidirectional handshaked host
34 port.
35 .P
36 To send a data stream to the signal processor, use
37 .BR write (2)
38 to the
39 device, and
40 .BR read (2)
41 to receive processed data.
42 The data can be sent or
43 received in 8, 16, 24, or 32-bit quantities on the host side, but will
44 always be seen as 24-bit quantities in the DSP56001.
45 .P
46 The following
47 .BR ioctl (2)
48 calls are used to control the
49 .I dsp56k
50 device:
51 .TP
52 .B DSP56K_UPLOAD
53 resets the DSP56001 and uploads a program.
54 The third
55 .BR ioctl (2)
56 argument must be a pointer to a
57 .I struct\~dsp56k_upload
58 with members
59 .I .bin
60 pointing to a DSP56001 binary program, and
61 .I .len
62 set to
63 the length of the program, counted in 24-bit words.
64 .TP
65 .B DSP56K_SET_TX_WSIZE
66 sets the transmit word size.
67 Allowed values are in the range 1 to 4,
68 and is the number of bytes that will be sent at a time to the
69 DSP56001.
70 These data quantities will either be padded with bytes containing zero,
71 or truncated to fit the native 24-bit data format of the
72 DSP56001.
73 .TP
74 .B DSP56K_SET_RX_WSIZE
75 sets the receive word size.
76 Allowed values are in the range 1 to 4,
77 and is the number of bytes that will be received at a time from the DSP56001.
78 These data quantities will either truncated,
79 or padded with a null byte (\[aq]\[rs]0\[aq]),
80 to fit the native 24-bit data format of the DSP56001.
81 .TP
82 .B DSP56K_HOST_FLAGS
83 read and write the host flags.
84 The host flags are four
85 general-purpose bits that can be read by both the hosting computer and
86 the DSP56001.
87 Bits 0 and 1 can be written by the host, and bits 2 and
88 3 can be written by the DSP56001.
89 .IP
90 To access the host flags, the third
91 .BR ioctl (2)
92 argument must be a pointer
93 to a
94 .IR struct\~dsp56k_host_flags .
95 If bit 0 or 1 is set in the
96 .I .dir
97 member, the corresponding bit in
98 .I .out
99 will be written
100 to the host flags.
101 The state of all host flags will be returned in
102 the lower four bits of the
103 .I .status
104 member.
105 .TP
106 .B DSP56K_HOST_CMD
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 .I /dev/dsp56k
112 .\" .SH AUTHORS
113 .\" Fredrik Noring <[email protected]>, lars brinkhoff <[email protected]>,
114 .\" Tomas Berndtsson <[email protected]>.
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