blob: 26b909329e54d96d7fcb075f9538599aaf30cb09 [file] [log] [blame]
Clemens Ladisch31ef9132011-03-15 07:53:21 +01001#ifndef SOUND_FIREWIRE_AMDTP_H_INCLUDED
2#define SOUND_FIREWIRE_AMDTP_H_INCLUDED
3
Clemens Ladisch20b65dd2011-09-04 22:15:44 +02004#include <linux/err.h>
Clemens Ladisch76fb8782012-05-13 22:03:09 +02005#include <linux/interrupt.h>
Clemens Ladisch31ef9132011-03-15 07:53:21 +01006#include <linux/mutex.h>
Takashi Sakamoto777fb572013-11-19 13:29:24 +09007#include <sound/asound.h>
Clemens Ladisch31ef9132011-03-15 07:53:21 +01008#include "packets-buffer.h"
9
10/**
Takashi Sakamotobe4a2892014-04-25 22:44:42 +090011 * enum cip_flags - describes details of the streaming protocol
Clemens Ladisch31ef9132011-03-15 07:53:21 +010012 * @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.
Clemens Ladische84d15f2011-09-04 22:12:48 +020016 * @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.
Takashi Sakamoto7b3b0d82014-04-25 22:44:49 +090019 * @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.
Takashi Sakamoto7ab56642014-04-25 22:45:03 +090021 * @CIP_EMPTY_WITH_TAG0: Only for in-stream. Empty in-packets have TAG0.
Takashi Sakamotoc8bdf492014-04-25 22:45:04 +090022 * @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.
Takashi Sakamoto69702232014-04-25 22:45:05 +090024 * @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.
Takashi Sakamoto5f217f92014-11-18 23:59:40 +090026 * @CIP_SKIP_DBC_ZERO_CHECK: Only for in-stream. Packets with zero in dbc is
Takashi Sakamotob84b1a22014-04-25 22:45:07 +090027 * skipped for detecting discontinuity.
Takashi Sakamotob6bc8122014-04-25 22:45:16 +090028 * @CIP_SKIP_INIT_DBC_CHECK: Only for in-stream. The value of dbc in first
29 * packet is not continuous from an initial value.
Takashi Sakamoto9d591242014-04-25 22:45:27 +090030 * @CIP_EMPTY_HAS_WRONG_DBC: Only for in-stream. The value of dbc in empty
31 * packet is wrong but the others are correct.
Takashi Sakamotoa2064712015-05-22 23:00:50 +090032 * @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.
Clemens Ladisch31ef9132011-03-15 07:53:21 +010035 */
Takashi Sakamotobe4a2892014-04-25 22:44:42 +090036enum cip_flags {
Takashi Sakamoto7b3b0d82014-04-25 22:44:49 +090037 CIP_NONBLOCKING = 0x00,
38 CIP_BLOCKING = 0x01,
Takashi Sakamoto10550be2014-04-25 22:44:51 +090039 CIP_SYNC_TO_DEVICE = 0x02,
Takashi Sakamoto7ab56642014-04-25 22:45:03 +090040 CIP_EMPTY_WITH_TAG0 = 0x04,
Takashi Sakamotoc8bdf492014-04-25 22:45:04 +090041 CIP_DBC_IS_END_EVENT = 0x08,
Takashi Sakamoto69702232014-04-25 22:45:05 +090042 CIP_WRONG_DBS = 0x10,
Takashi Sakamotob84b1a22014-04-25 22:45:07 +090043 CIP_SKIP_DBC_ZERO_CHECK = 0x20,
Takashi Sakamotob6bc8122014-04-25 22:45:16 +090044 CIP_SKIP_INIT_DBC_CHECK = 0x40,
Takashi Sakamoto9d591242014-04-25 22:45:27 +090045 CIP_EMPTY_HAS_WRONG_DBC = 0x80,
Takashi Sakamotoa2064712015-05-22 23:00:50 +090046 CIP_JUMBO_PAYLOAD = 0x100,
Clemens Ladisch31ef9132011-03-15 07:53:21 +010047};
48
49/**
Takashi Sakamoto5f217f92014-11-18 23:59:40 +090050 * 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
59 *
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
64 * stream.
65 *
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.
69 *
70 * Currently our implementation is compatible with IEC 61883-6:2002.
Clemens Ladisch31ef9132011-03-15 07:53:21 +010071 */
72enum cip_sfc {
73 CIP_SFC_32000 = 0,
74 CIP_SFC_44100 = 1,
75 CIP_SFC_48000 = 2,
76 CIP_SFC_88200 = 3,
77 CIP_SFC_96000 = 4,
78 CIP_SFC_176400 = 5,
79 CIP_SFC_192000 = 6,
Clemens Ladischa7304e32011-09-04 22:16:10 +020080 CIP_SFC_COUNT
Clemens Ladisch31ef9132011-03-15 07:53:21 +010081};
82
Takashi Sakamoto2b3fc452014-04-25 22:44:46 +090083#define AMDTP_IN_PCM_FORMAT_BITS SNDRV_PCM_FMTBIT_S32
84
Clemens Ladisch31ef9132011-03-15 07:53:21 +010085#define AMDTP_OUT_PCM_FORMAT_BITS (SNDRV_PCM_FMTBIT_S16 | \
86 SNDRV_PCM_FMTBIT_S32)
87
Takashi Sakamoto83d8d722014-04-25 22:44:47 +090088
89/*
Takashi Sakamoto77d2a8a2014-04-25 22:44:50 +090090 * This module supports maximum 64 PCM channels for one PCM stream
91 * This is for our convenience.
92 */
93#define AMDTP_MAX_CHANNELS_FOR_PCM 64
94
95/*
Takashi Sakamoto83d8d722014-04-25 22:44:47 +090096 * 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.
99 *
100 * This module supports maximum 1 MIDI conformant data channels.
101 * Then this AMDTP packets can transfer maximum 8 MIDI data streams.
102 */
103#define AMDTP_MAX_CHANNELS_FOR_MIDI 1
104
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100105struct fw_unit;
106struct fw_iso_context;
107struct snd_pcm_substream;
Takashi Sakamoto7b2d99f2014-04-25 22:44:52 +0900108struct snd_pcm_runtime;
Takashi Sakamoto83d8d722014-04-25 22:44:47 +0900109struct snd_rawmidi_substream;
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100110
Takashi Sakamoto3ff7e8f2014-04-25 22:44:44 +0900111enum amdtp_stream_direction {
112 AMDTP_OUT_STREAM = 0,
113 AMDTP_IN_STREAM
114};
115
Takashi Sakamotobe4a2892014-04-25 22:44:42 +0900116struct amdtp_stream {
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100117 struct fw_unit *unit;
Takashi Sakamotobe4a2892014-04-25 22:44:42 +0900118 enum cip_flags flags;
Takashi Sakamoto3ff7e8f2014-04-25 22:44:44 +0900119 enum amdtp_stream_direction direction;
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100120 struct fw_iso_context *context;
121 struct mutex mutex;
122
123 enum cip_sfc sfc;
124 unsigned int data_block_quadlets;
125 unsigned int pcm_channels;
126 unsigned int midi_ports;
Takashi Sakamotobe4a2892014-04-25 22:44:42 +0900127 void (*transfer_samples)(struct amdtp_stream *s,
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100128 struct snd_pcm_substream *pcm,
129 __be32 *buffer, unsigned int frames);
Takashi Sakamoto77d2a8a2014-04-25 22:44:50 +0900130 u8 pcm_positions[AMDTP_MAX_CHANNELS_FOR_PCM];
131 u8 midi_position;
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100132
133 unsigned int syt_interval;
Clemens Ladische84d15f2011-09-04 22:12:48 +0200134 unsigned int transfer_delay;
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100135 unsigned int source_node_id_field;
136 struct iso_packets_buffer buffer;
137
138 struct snd_pcm_substream *pcm;
Clemens Ladisch76fb8782012-05-13 22:03:09 +0200139 struct tasklet_struct period_tasklet;
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100140
Clemens Ladischec00f5e2011-03-15 07:57:24 +0100141 int packet_index;
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100142 unsigned int data_block_counter;
143
144 unsigned int data_block_state;
145
146 unsigned int last_syt_offset;
147 unsigned int syt_offset_state;
148
149 unsigned int pcm_buffer_pointer;
150 unsigned int pcm_period_pointer;
Clemens Ladisch92b862c2012-05-13 19:07:22 +0200151 bool pointer_flush;
Takashi Sakamoto65845f22014-08-29 13:40:45 +0900152 bool double_pcm_frames;
Takashi Sakamoto83d8d722014-04-25 22:44:47 +0900153
154 struct snd_rawmidi_substream *midi[AMDTP_MAX_CHANNELS_FOR_MIDI * 8];
Clemens Ladisch25ca9172014-11-25 22:54:10 +0100155 int midi_fifo_limit;
156 int midi_fifo_used[AMDTP_MAX_CHANNELS_FOR_MIDI * 8];
Takashi Sakamoto7b3b0d82014-04-25 22:44:49 +0900157
Takashi Sakamotod9cd0062014-04-25 22:45:06 +0900158 /* quirk: fixed interval of dbc between previos/current packets. */
159 unsigned int tx_dbc_interval;
160
Takashi Sakamoto7b3b0d82014-04-25 22:44:49 +0900161 bool callbacked;
162 wait_queue_head_t callback_wait;
163 struct amdtp_stream *sync_slave;
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100164};
165
Takashi Sakamotobe4a2892014-04-25 22:44:42 +0900166int amdtp_stream_init(struct amdtp_stream *s, struct fw_unit *unit,
Takashi Sakamoto3ff7e8f2014-04-25 22:44:44 +0900167 enum amdtp_stream_direction dir,
Takashi Sakamotobe4a2892014-04-25 22:44:42 +0900168 enum cip_flags flags);
169void amdtp_stream_destroy(struct amdtp_stream *s);
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100170
Takashi Sakamotobe4a2892014-04-25 22:44:42 +0900171void amdtp_stream_set_parameters(struct amdtp_stream *s,
172 unsigned int rate,
173 unsigned int pcm_channels,
174 unsigned int midi_ports);
175unsigned int amdtp_stream_get_max_payload(struct amdtp_stream *s);
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100176
Takashi Sakamotobe4a2892014-04-25 22:44:42 +0900177int amdtp_stream_start(struct amdtp_stream *s, int channel, int speed);
178void amdtp_stream_update(struct amdtp_stream *s);
179void amdtp_stream_stop(struct amdtp_stream *s);
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100180
Takashi Sakamoto7b2d99f2014-04-25 22:44:52 +0900181int amdtp_stream_add_pcm_hw_constraints(struct amdtp_stream *s,
182 struct snd_pcm_runtime *runtime);
Takashi Sakamotobe4a2892014-04-25 22:44:42 +0900183void amdtp_stream_set_pcm_format(struct amdtp_stream *s,
184 snd_pcm_format_t format);
185void amdtp_stream_pcm_prepare(struct amdtp_stream *s);
186unsigned long amdtp_stream_pcm_pointer(struct amdtp_stream *s);
187void amdtp_stream_pcm_abort(struct amdtp_stream *s);
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100188
Clemens Ladischc5280e92011-10-16 21:39:00 +0200189extern const unsigned int amdtp_syt_intervals[CIP_SFC_COUNT];
Takashi Sakamoto1017abe2014-04-25 22:44:59 +0900190extern const unsigned int amdtp_rate_table[CIP_SFC_COUNT];
Clemens Ladischa7304e32011-09-04 22:16:10 +0200191
Takashi Sakamotobe4a2892014-04-25 22:44:42 +0900192/**
193 * amdtp_stream_running - check stream is running or not
194 * @s: the AMDTP stream
195 *
196 * If this function returns true, the stream is running.
197 */
198static inline bool amdtp_stream_running(struct amdtp_stream *s)
Clemens Ladisch20b65dd2011-09-04 22:15:44 +0200199{
200 return !IS_ERR(s->context);
201}
202
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100203/**
Takashi Sakamotobe4a2892014-04-25 22:44:42 +0900204 * amdtp_streaming_error - check for streaming error
205 * @s: the AMDTP stream
Clemens Ladischec00f5e2011-03-15 07:57:24 +0100206 *
207 * If this function returns true, the stream's packet queue has stopped due to
208 * an asynchronous error.
209 */
Takashi Sakamotobe4a2892014-04-25 22:44:42 +0900210static inline bool amdtp_streaming_error(struct amdtp_stream *s)
Clemens Ladischec00f5e2011-03-15 07:57:24 +0100211{
212 return s->packet_index < 0;
213}
214
215/**
Takashi Sakamoto83d8d722014-04-25 22:44:47 +0900216 * amdtp_stream_pcm_running - check PCM substream is running or not
217 * @s: the AMDTP stream
218 *
219 * If this function returns true, PCM substream in the AMDTP stream is running.
220 */
221static inline bool amdtp_stream_pcm_running(struct amdtp_stream *s)
222{
223 return !!s->pcm;
224}
225
226/**
Takashi Sakamotobe4a2892014-04-25 22:44:42 +0900227 * amdtp_stream_pcm_trigger - start/stop playback from a PCM device
228 * @s: the AMDTP stream
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100229 * @pcm: the PCM device to be started, or %NULL to stop the current device
230 *
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.
234 */
Takashi Sakamotobe4a2892014-04-25 22:44:42 +0900235static inline void amdtp_stream_pcm_trigger(struct amdtp_stream *s,
236 struct snd_pcm_substream *pcm)
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100237{
238 ACCESS_ONCE(s->pcm) = pcm;
239}
240
Takashi Sakamoto83d8d722014-04-25 22:44:47 +0900241/**
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
246 *
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.
250 */
251static inline void amdtp_stream_midi_trigger(struct amdtp_stream *s,
252 unsigned int port,
253 struct snd_rawmidi_substream *midi)
254{
255 if (port < s->midi_ports)
256 ACCESS_ONCE(s->midi[port]) = midi;
257}
258
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100259static inline bool cip_sfc_is_base_44100(enum cip_sfc sfc)
260{
261 return sfc & 1;
262}
263
Takashi Sakamoto7b3b0d82014-04-25 22:44:49 +0900264static inline void amdtp_stream_set_sync(enum cip_flags sync_mode,
265 struct amdtp_stream *master,
266 struct amdtp_stream *slave)
267{
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;
272 } else {
273 master->flags &= ~CIP_SYNC_TO_DEVICE;
274 slave->flags &= ~CIP_SYNC_TO_DEVICE;
275 master->sync_slave = NULL;
276 }
277
278 slave->sync_slave = NULL;
279}
280
281/**
282 * amdtp_stream_wait_callback - sleep till callbacked or timeout
283 * @s: the AMDTP stream
284 * @timeout: msec till timeout
285 *
286 * If this function return false, the AMDTP stream should be stopped.
287 */
288static inline bool amdtp_stream_wait_callback(struct amdtp_stream *s,
289 unsigned int timeout)
290{
291 return wait_event_timeout(s->callback_wait,
292 s->callbacked == true,
293 msecs_to_jiffies(timeout)) > 0;
294}
295
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100296#endif