firewire/dice/dice-interface.h

1 /* SPDX-License-Identifier: GPL-2.0 */
10  * Generally, all registers can be read like memory, i.e., with quadlet read or
11  * block read transactions with at least quadlet-aligned offset and length.
12  * Writes are not allowed except where noted; quadlet-sized registers must be
15  * All values are in big endian.  The DICE firmware runs on a little-endian CPU
16  * and just byte-swaps _all_ quadlets on the bus, so values without endianness
17  * (e.g. strings) get scrambled and must be byte-swapped again by the driver.
28  * separately to allow them to be extended individually.  Whether a register is
31  * The section offset values are relative to DICE_PRIVATE_SPACE; the offset/
32  * size values are measured in quadlets.  Read-only.
50  * Stores the full 64-bit address (node ID and offset in the node's address
60  * A bitmask with asynchronous events; read-only.  When any event(s) happen,
62  * also written to the address stored in the owner register.
70 /* Write to the clock select register has been finished. */
74 /* Other bits may be used for device-specific events. */
77  * A name that can be customized for each device; read/write.  Padded with zero
78  * bytes.  Quadlets are byte-swapped.  The encoding is whatever the host driver
79  * happens to be using.
85  * The current sample rate and clock source; read/write.  Whether a clock
86  * source or sample rate is supported is device-specific; the internal clock
87  * source is always available.  Low/mid/high = up to 48/96/192 kHz.  This
120  * Enable streaming; read/write.  Writing a non-zero value (re)starts all
128  * Status of the sample clock; read-only.
133 /* The actual sample rate; CLOCK_RATE_32000-_192000 or _NONE. */
137  * Status of all clock sources; read-only.
157  * error occurred since the last time when this register was read with
158  * a quadlet read transaction.
173  * The measured rate of the current clock source, in Hz; read-only.
185  * The version of the DICE driver specification that this device conforms to;
186  * read-only.
191  * Supported sample rates and clock sources; read-only.
216  * Names of all clock sources; read-only.  Quadlets are byte-swapped.  Names
229  * The number of supported capture streams; read-only.
234  * The size of one stream's register block, in quadlets; read-only.  The
241  * The isochronous channel number on which packets are sent, or -1 if the
242  * stream is not to be used; read/write.
247  * The number of audio channels; read-only.  There will be one quadlet per
253  * The number of MIDI ports, 0-8; read-only.  If > 0, there will be one
259  * The speed at which the packets are sent, SCODE_100-_400; read/write.
265  * Names of all audio channels; read-only.  Quadlets are byte-swapped.  Names
273  * Audio IEC60958 capabilities; read-only.  Bitmask with one bit per audio
279  * Send audio data with IEC60958 label; read/write.  Bitmask with one bit per
291  * The number of supported playback streams; read-only.
296  * The size of one stream's register block, in quadlets; read-only.  The
303  * The isochronous channel number on which packets are received, or -1 if the
304  * stream is not to be used; read/write.
309  * Index of first quadlet to be interpreted; read/write.  If > 0, that many
316  * The number of audio channels; read-only.  There will be one quadlet per
322  * The number of MIDI ports, 0-8; read-only.  If > 0, there will be one
328  * Names of all audio channels; read-only.  Quadlets are byte-swapped.  Names
336  * Audio IEC60958 capabilities; read-only.  Bitmask with one bit per audio
342  * Receive audio data with IEC60958 label; read/write.  Bitmask with one bit
350  * This section can be read completely with a block read request.
354  * Current clock source; read-only.
359  * Clock source is locked (boolean); read-only.
364  * Current sample rate (CLOCK_RATE_* >> CLOCK_RATE_SHIFT), _32000-_192000 or
365  * _NONE; read-only.
370  * ADAT user data bits; read-only.