1 #ifndef SOUND_FIREWIRE_AMDTP_H_INCLUDED
2 #define SOUND_FIREWIRE_AMDTP_H_INCLUDED
5 #include <linux/interrupt.h>
6 #include <linux/mutex.h>
7 #include <sound/asound.h>
8 #include "packets-buffer.h"
11 * enum cip_flags - describes details of the streaming protocol
12 * @CIP_NONBLOCKING: In non-blocking mode, each packet contains
13 * sample_rate/8000 samples, with rounding up or down to adjust
14 * for clock skew and left-over fractional samples. This should
15 * be used if supported by the device.
16 * @CIP_BLOCKING: In blocking mode, each packet contains either zero or
17 * SYT_INTERVAL samples, with these two types alternating so that
18 * the overall sample rate comes out right.
19 * @CIP_SYNC_TO_DEVICE: In sync to device mode, time stamp in out packets is
20 * generated by in packets. Defaultly this driver generates timestamp.
21 * @CIP_EMPTY_WITH_TAG0: Only for in-stream. Empty in-packets have TAG0.
22 * @CIP_DBC_IS_END_EVENT: Only for in-stream. The value of dbc in an in-packet
23 * corresponds to the end of event in the packet. Out of IEC 61883.
24 * @CIP_WRONG_DBS: Only for in-stream. The value of dbs is wrong in in-packets.
25 * The value of data_block_quadlets is used instead of reported value.
26 * @CIP_SKIP_DBC_ZERO_CHECK: Only for in-stream. Packets with zero in dbc is
27 * skipped for detecting discontinuity.
28 * @CIP_SKIP_INIT_DBC_CHECK: Only for in-stream. The value of dbc in first
29 * packet is not continuous from an initial value.
30 * @CIP_EMPTY_HAS_WRONG_DBC: Only for in-stream. The value of dbc in empty
31 * packet is wrong but the others are correct.
32 * @CIP_JUMBO_PAYLOAD: Only for in-stream. The number of data blocks in an
33 * packet is larger than IEC 61883-6 defines. Current implementation
34 * allows 5 times as large as IEC 61883-6 defines.
37 CIP_NONBLOCKING
= 0x00,
39 CIP_SYNC_TO_DEVICE
= 0x02,
40 CIP_EMPTY_WITH_TAG0
= 0x04,
41 CIP_DBC_IS_END_EVENT
= 0x08,
43 CIP_SKIP_DBC_ZERO_CHECK
= 0x20,
44 CIP_SKIP_INIT_DBC_CHECK
= 0x40,
45 CIP_EMPTY_HAS_WRONG_DBC
= 0x80,
46 CIP_JUMBO_PAYLOAD
= 0x100,
50 * enum cip_sfc - supported Sampling Frequency Codes (SFCs)
51 * @CIP_SFC_32000: 32,000 data blocks
52 * @CIP_SFC_44100: 44,100 data blocks
53 * @CIP_SFC_48000: 48,000 data blocks
54 * @CIP_SFC_88200: 88,200 data blocks
55 * @CIP_SFC_96000: 96,000 data blocks
56 * @CIP_SFC_176400: 176,400 data blocks
57 * @CIP_SFC_192000: 192,000 data blocks
58 * @CIP_SFC_COUNT: the number of supported SFCs
60 * These values are used to show nominal Sampling Frequency Code in
61 * Format Dependent Field (FDF) of AMDTP packet header. In IEC 61883-6:2002,
62 * this code means the number of events per second. Actually the code
63 * represents the number of data blocks transferred per second in an AMDTP
66 * In IEC 61883-6:2005, some extensions were added to support more types of
67 * data such as 'One Bit LInear Audio', therefore the meaning of SFC became
68 * different depending on the types.
70 * Currently our implementation is compatible with IEC 61883-6:2002.
83 #define AMDTP_IN_PCM_FORMAT_BITS SNDRV_PCM_FMTBIT_S32
85 #define AMDTP_OUT_PCM_FORMAT_BITS (SNDRV_PCM_FMTBIT_S16 | \
90 * This module supports maximum 64 PCM channels for one PCM stream
91 * This is for our convenience.
93 #define AMDTP_MAX_CHANNELS_FOR_PCM 64
96 * AMDTP packet can include channels for MIDI conformant data.
97 * Each MIDI conformant data channel includes 8 MPX-MIDI data stream.
98 * Each MPX-MIDI data stream includes one data stream from/to MIDI ports.
100 * This module supports maximum 1 MIDI conformant data channels.
101 * Then this AMDTP packets can transfer maximum 8 MIDI data streams.
103 #define AMDTP_MAX_CHANNELS_FOR_MIDI 1
106 struct fw_iso_context
;
107 struct snd_pcm_substream
;
108 struct snd_pcm_runtime
;
109 struct snd_rawmidi_substream
;
111 enum amdtp_stream_direction
{
112 AMDTP_OUT_STREAM
= 0,
116 struct amdtp_stream
{
117 struct fw_unit
*unit
;
118 enum cip_flags flags
;
119 enum amdtp_stream_direction direction
;
120 struct fw_iso_context
*context
;
124 unsigned int data_block_quadlets
;
125 unsigned int pcm_channels
;
126 unsigned int midi_ports
;
127 void (*transfer_samples
)(struct amdtp_stream
*s
,
128 struct snd_pcm_substream
*pcm
,
129 __be32
*buffer
, unsigned int frames
);
130 u8 pcm_positions
[AMDTP_MAX_CHANNELS_FOR_PCM
];
133 unsigned int syt_interval
;
134 unsigned int transfer_delay
;
135 unsigned int source_node_id_field
;
136 struct iso_packets_buffer buffer
;
138 struct snd_pcm_substream
*pcm
;
139 struct tasklet_struct period_tasklet
;
142 unsigned int data_block_counter
;
144 unsigned int data_block_state
;
146 unsigned int last_syt_offset
;
147 unsigned int syt_offset_state
;
149 unsigned int pcm_buffer_pointer
;
150 unsigned int pcm_period_pointer
;
152 bool double_pcm_frames
;
154 struct snd_rawmidi_substream
*midi
[AMDTP_MAX_CHANNELS_FOR_MIDI
* 8];
156 int midi_fifo_used
[AMDTP_MAX_CHANNELS_FOR_MIDI
* 8];
158 /* quirk: fixed interval of dbc between previos/current packets. */
159 unsigned int tx_dbc_interval
;
162 wait_queue_head_t callback_wait
;
163 struct amdtp_stream
*sync_slave
;
166 int amdtp_stream_init(struct amdtp_stream
*s
, struct fw_unit
*unit
,
167 enum amdtp_stream_direction dir
,
168 enum cip_flags flags
);
169 void amdtp_stream_destroy(struct amdtp_stream
*s
);
171 void amdtp_stream_set_parameters(struct amdtp_stream
*s
,
173 unsigned int pcm_channels
,
174 unsigned int midi_ports
);
175 unsigned int amdtp_stream_get_max_payload(struct amdtp_stream
*s
);
177 int amdtp_stream_start(struct amdtp_stream
*s
, int channel
, int speed
);
178 void amdtp_stream_update(struct amdtp_stream
*s
);
179 void amdtp_stream_stop(struct amdtp_stream
*s
);
181 int amdtp_stream_add_pcm_hw_constraints(struct amdtp_stream
*s
,
182 struct snd_pcm_runtime
*runtime
);
183 void amdtp_stream_set_pcm_format(struct amdtp_stream
*s
,
184 snd_pcm_format_t format
);
185 void amdtp_stream_pcm_prepare(struct amdtp_stream
*s
);
186 unsigned long amdtp_stream_pcm_pointer(struct amdtp_stream
*s
);
187 void amdtp_stream_pcm_abort(struct amdtp_stream
*s
);
189 extern const unsigned int amdtp_syt_intervals
[CIP_SFC_COUNT
];
190 extern const unsigned int amdtp_rate_table
[CIP_SFC_COUNT
];
193 * amdtp_stream_running - check stream is running or not
194 * @s: the AMDTP stream
196 * If this function returns true, the stream is running.
198 static inline bool amdtp_stream_running(struct amdtp_stream
*s
)
200 return !IS_ERR(s
->context
);
204 * amdtp_streaming_error - check for streaming error
205 * @s: the AMDTP stream
207 * If this function returns true, the stream's packet queue has stopped due to
208 * an asynchronous error.
210 static inline bool amdtp_streaming_error(struct amdtp_stream
*s
)
212 return s
->packet_index
< 0;
216 * amdtp_stream_pcm_running - check PCM substream is running or not
217 * @s: the AMDTP stream
219 * If this function returns true, PCM substream in the AMDTP stream is running.
221 static inline bool amdtp_stream_pcm_running(struct amdtp_stream
*s
)
227 * amdtp_stream_pcm_trigger - start/stop playback from a PCM device
228 * @s: the AMDTP stream
229 * @pcm: the PCM device to be started, or %NULL to stop the current device
231 * Call this function on a running isochronous stream to enable the actual
232 * transmission of PCM data. This function should be called from the PCM
233 * device's .trigger callback.
235 static inline void amdtp_stream_pcm_trigger(struct amdtp_stream
*s
,
236 struct snd_pcm_substream
*pcm
)
238 ACCESS_ONCE(s
->pcm
) = pcm
;
242 * amdtp_stream_midi_trigger - start/stop playback/capture with a MIDI device
243 * @s: the AMDTP stream
244 * @port: index of MIDI port
245 * @midi: the MIDI device to be started, or %NULL to stop the current device
247 * Call this function on a running isochronous stream to enable the actual
248 * transmission of MIDI data. This function should be called from the MIDI
249 * device's .trigger callback.
251 static inline void amdtp_stream_midi_trigger(struct amdtp_stream
*s
,
253 struct snd_rawmidi_substream
*midi
)
255 if (port
< s
->midi_ports
)
256 ACCESS_ONCE(s
->midi
[port
]) = midi
;
259 static inline bool cip_sfc_is_base_44100(enum cip_sfc sfc
)
264 static inline void amdtp_stream_set_sync(enum cip_flags sync_mode
,
265 struct amdtp_stream
*master
,
266 struct amdtp_stream
*slave
)
268 if (sync_mode
== CIP_SYNC_TO_DEVICE
) {
269 master
->flags
|= CIP_SYNC_TO_DEVICE
;
270 slave
->flags
|= CIP_SYNC_TO_DEVICE
;
271 master
->sync_slave
= slave
;
273 master
->flags
&= ~CIP_SYNC_TO_DEVICE
;
274 slave
->flags
&= ~CIP_SYNC_TO_DEVICE
;
275 master
->sync_slave
= NULL
;
278 slave
->sync_slave
= NULL
;
282 * amdtp_stream_wait_callback - sleep till callbacked or timeout
283 * @s: the AMDTP stream
284 * @timeout: msec till timeout
286 * If this function return false, the AMDTP stream should be stopped.
288 static inline bool amdtp_stream_wait_callback(struct amdtp_stream
*s
,
289 unsigned int timeout
)
291 return wait_event_timeout(s
->callback_wait
,
292 s
->callbacked
== true,
293 msecs_to_jiffies(timeout
)) > 0;