blob: 8a03a91e728b0f9bc4feb23a4bdd9f22fdf5952d [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.
Clemens Ladisch31ef9132011-03-15 07:53:21 +010032 */
Takashi Sakamotobe4a2892014-04-25 22:44:42 +090033enum cip_flags {
Takashi Sakamoto7b3b0d82014-04-25 22:44:49 +090034 CIP_NONBLOCKING = 0x00,
35 CIP_BLOCKING = 0x01,
Takashi Sakamoto10550be2014-04-25 22:44:51 +090036 CIP_SYNC_TO_DEVICE = 0x02,
Takashi Sakamoto7ab56642014-04-25 22:45:03 +090037 CIP_EMPTY_WITH_TAG0 = 0x04,
Takashi Sakamotoc8bdf492014-04-25 22:45:04 +090038 CIP_DBC_IS_END_EVENT = 0x08,
Takashi Sakamoto69702232014-04-25 22:45:05 +090039 CIP_WRONG_DBS = 0x10,
Takashi Sakamotob84b1a22014-04-25 22:45:07 +090040 CIP_SKIP_DBC_ZERO_CHECK = 0x20,
Takashi Sakamotob6bc8122014-04-25 22:45:16 +090041 CIP_SKIP_INIT_DBC_CHECK = 0x40,
Takashi Sakamoto9d591242014-04-25 22:45:27 +090042 CIP_EMPTY_HAS_WRONG_DBC = 0x80,
Clemens Ladisch31ef9132011-03-15 07:53:21 +010043};
44
45/**
Takashi Sakamoto5f217f92014-11-18 23:59:40 +090046 * enum cip_sfc - supported Sampling Frequency Codes (SFCs)
47 * @CIP_SFC_32000: 32,000 data blocks
48 * @CIP_SFC_44100: 44,100 data blocks
49 * @CIP_SFC_48000: 48,000 data blocks
50 * @CIP_SFC_88200: 88,200 data blocks
51 * @CIP_SFC_96000: 96,000 data blocks
52 * @CIP_SFC_176400: 176,400 data blocks
53 * @CIP_SFC_192000: 192,000 data blocks
54 * @CIP_SFC_COUNT: the number of supported SFCs
55 *
56 * These values are used to show nominal Sampling Frequency Code in
57 * Format Dependent Field (FDF) of AMDTP packet header. In IEC 61883-6:2002,
58 * this code means the number of events per second. Actually the code
59 * represents the number of data blocks transferred per second in an AMDTP
60 * stream.
61 *
62 * In IEC 61883-6:2005, some extensions were added to support more types of
63 * data such as 'One Bit LInear Audio', therefore the meaning of SFC became
64 * different depending on the types.
65 *
66 * Currently our implementation is compatible with IEC 61883-6:2002.
Clemens Ladisch31ef9132011-03-15 07:53:21 +010067 */
68enum cip_sfc {
69 CIP_SFC_32000 = 0,
70 CIP_SFC_44100 = 1,
71 CIP_SFC_48000 = 2,
72 CIP_SFC_88200 = 3,
73 CIP_SFC_96000 = 4,
74 CIP_SFC_176400 = 5,
75 CIP_SFC_192000 = 6,
Clemens Ladischa7304e32011-09-04 22:16:10 +020076 CIP_SFC_COUNT
Clemens Ladisch31ef9132011-03-15 07:53:21 +010077};
78
Takashi Sakamoto2b3fc452014-04-25 22:44:46 +090079#define AMDTP_IN_PCM_FORMAT_BITS SNDRV_PCM_FMTBIT_S32
80
Clemens Ladisch31ef9132011-03-15 07:53:21 +010081#define AMDTP_OUT_PCM_FORMAT_BITS (SNDRV_PCM_FMTBIT_S16 | \
82 SNDRV_PCM_FMTBIT_S32)
83
Takashi Sakamoto83d8d722014-04-25 22:44:47 +090084
85/*
Takashi Sakamoto77d2a8a2014-04-25 22:44:50 +090086 * This module supports maximum 64 PCM channels for one PCM stream
87 * This is for our convenience.
88 */
89#define AMDTP_MAX_CHANNELS_FOR_PCM 64
90
91/*
Takashi Sakamoto83d8d722014-04-25 22:44:47 +090092 * AMDTP packet can include channels for MIDI conformant data.
93 * Each MIDI conformant data channel includes 8 MPX-MIDI data stream.
94 * Each MPX-MIDI data stream includes one data stream from/to MIDI ports.
95 *
96 * This module supports maximum 1 MIDI conformant data channels.
97 * Then this AMDTP packets can transfer maximum 8 MIDI data streams.
98 */
99#define AMDTP_MAX_CHANNELS_FOR_MIDI 1
100
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100101struct fw_unit;
102struct fw_iso_context;
103struct snd_pcm_substream;
Takashi Sakamoto7b2d99f2014-04-25 22:44:52 +0900104struct snd_pcm_runtime;
Takashi Sakamoto83d8d722014-04-25 22:44:47 +0900105struct snd_rawmidi_substream;
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100106
Takashi Sakamoto3ff7e8f2014-04-25 22:44:44 +0900107enum amdtp_stream_direction {
108 AMDTP_OUT_STREAM = 0,
109 AMDTP_IN_STREAM
110};
111
Takashi Sakamotobe4a2892014-04-25 22:44:42 +0900112struct amdtp_stream {
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100113 struct fw_unit *unit;
Takashi Sakamotobe4a2892014-04-25 22:44:42 +0900114 enum cip_flags flags;
Takashi Sakamoto3ff7e8f2014-04-25 22:44:44 +0900115 enum amdtp_stream_direction direction;
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100116 struct fw_iso_context *context;
117 struct mutex mutex;
118
119 enum cip_sfc sfc;
120 unsigned int data_block_quadlets;
121 unsigned int pcm_channels;
122 unsigned int midi_ports;
Takashi Sakamotobe4a2892014-04-25 22:44:42 +0900123 void (*transfer_samples)(struct amdtp_stream *s,
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100124 struct snd_pcm_substream *pcm,
125 __be32 *buffer, unsigned int frames);
Takashi Sakamoto77d2a8a2014-04-25 22:44:50 +0900126 u8 pcm_positions[AMDTP_MAX_CHANNELS_FOR_PCM];
127 u8 midi_position;
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100128
129 unsigned int syt_interval;
Clemens Ladische84d15f2011-09-04 22:12:48 +0200130 unsigned int transfer_delay;
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100131 unsigned int source_node_id_field;
132 struct iso_packets_buffer buffer;
133
134 struct snd_pcm_substream *pcm;
Clemens Ladisch76fb8782012-05-13 22:03:09 +0200135 struct tasklet_struct period_tasklet;
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100136
Clemens Ladischec00f5e2011-03-15 07:57:24 +0100137 int packet_index;
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100138 unsigned int data_block_counter;
139
140 unsigned int data_block_state;
141
142 unsigned int last_syt_offset;
143 unsigned int syt_offset_state;
144
145 unsigned int pcm_buffer_pointer;
146 unsigned int pcm_period_pointer;
Clemens Ladisch92b862c2012-05-13 19:07:22 +0200147 bool pointer_flush;
Takashi Sakamoto65845f22014-08-29 13:40:45 +0900148 bool double_pcm_frames;
Takashi Sakamoto83d8d722014-04-25 22:44:47 +0900149
150 struct snd_rawmidi_substream *midi[AMDTP_MAX_CHANNELS_FOR_MIDI * 8];
Clemens Ladisch25ca9172014-11-25 22:54:10 +0100151 int midi_fifo_limit;
152 int midi_fifo_used[AMDTP_MAX_CHANNELS_FOR_MIDI * 8];
Takashi Sakamoto7b3b0d82014-04-25 22:44:49 +0900153
Takashi Sakamotod9cd0062014-04-25 22:45:06 +0900154 /* quirk: fixed interval of dbc between previos/current packets. */
155 unsigned int tx_dbc_interval;
156
Takashi Sakamoto7b3b0d82014-04-25 22:44:49 +0900157 bool callbacked;
158 wait_queue_head_t callback_wait;
159 struct amdtp_stream *sync_slave;
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100160};
161
Takashi Sakamotobe4a2892014-04-25 22:44:42 +0900162int amdtp_stream_init(struct amdtp_stream *s, struct fw_unit *unit,
Takashi Sakamoto3ff7e8f2014-04-25 22:44:44 +0900163 enum amdtp_stream_direction dir,
Takashi Sakamotobe4a2892014-04-25 22:44:42 +0900164 enum cip_flags flags);
165void amdtp_stream_destroy(struct amdtp_stream *s);
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100166
Takashi Sakamotobe4a2892014-04-25 22:44:42 +0900167void amdtp_stream_set_parameters(struct amdtp_stream *s,
168 unsigned int rate,
169 unsigned int pcm_channels,
170 unsigned int midi_ports);
171unsigned int amdtp_stream_get_max_payload(struct amdtp_stream *s);
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100172
Takashi Sakamotobe4a2892014-04-25 22:44:42 +0900173int amdtp_stream_start(struct amdtp_stream *s, int channel, int speed);
174void amdtp_stream_update(struct amdtp_stream *s);
175void amdtp_stream_stop(struct amdtp_stream *s);
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100176
Takashi Sakamoto7b2d99f2014-04-25 22:44:52 +0900177int amdtp_stream_add_pcm_hw_constraints(struct amdtp_stream *s,
178 struct snd_pcm_runtime *runtime);
Takashi Sakamotobe4a2892014-04-25 22:44:42 +0900179void amdtp_stream_set_pcm_format(struct amdtp_stream *s,
180 snd_pcm_format_t format);
181void amdtp_stream_pcm_prepare(struct amdtp_stream *s);
182unsigned long amdtp_stream_pcm_pointer(struct amdtp_stream *s);
183void amdtp_stream_pcm_abort(struct amdtp_stream *s);
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100184
Clemens Ladischc5280e92011-10-16 21:39:00 +0200185extern const unsigned int amdtp_syt_intervals[CIP_SFC_COUNT];
Takashi Sakamoto1017abe2014-04-25 22:44:59 +0900186extern const unsigned int amdtp_rate_table[CIP_SFC_COUNT];
Clemens Ladischa7304e32011-09-04 22:16:10 +0200187
Takashi Sakamotobe4a2892014-04-25 22:44:42 +0900188/**
189 * amdtp_stream_running - check stream is running or not
190 * @s: the AMDTP stream
191 *
192 * If this function returns true, the stream is running.
193 */
194static inline bool amdtp_stream_running(struct amdtp_stream *s)
Clemens Ladisch20b65dd2011-09-04 22:15:44 +0200195{
196 return !IS_ERR(s->context);
197}
198
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100199/**
Takashi Sakamotobe4a2892014-04-25 22:44:42 +0900200 * amdtp_streaming_error - check for streaming error
201 * @s: the AMDTP stream
Clemens Ladischec00f5e2011-03-15 07:57:24 +0100202 *
203 * If this function returns true, the stream's packet queue has stopped due to
204 * an asynchronous error.
205 */
Takashi Sakamotobe4a2892014-04-25 22:44:42 +0900206static inline bool amdtp_streaming_error(struct amdtp_stream *s)
Clemens Ladischec00f5e2011-03-15 07:57:24 +0100207{
208 return s->packet_index < 0;
209}
210
211/**
Takashi Sakamoto83d8d722014-04-25 22:44:47 +0900212 * amdtp_stream_pcm_running - check PCM substream is running or not
213 * @s: the AMDTP stream
214 *
215 * If this function returns true, PCM substream in the AMDTP stream is running.
216 */
217static inline bool amdtp_stream_pcm_running(struct amdtp_stream *s)
218{
219 return !!s->pcm;
220}
221
222/**
Takashi Sakamotobe4a2892014-04-25 22:44:42 +0900223 * amdtp_stream_pcm_trigger - start/stop playback from a PCM device
224 * @s: the AMDTP stream
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100225 * @pcm: the PCM device to be started, or %NULL to stop the current device
226 *
227 * Call this function on a running isochronous stream to enable the actual
228 * transmission of PCM data. This function should be called from the PCM
229 * device's .trigger callback.
230 */
Takashi Sakamotobe4a2892014-04-25 22:44:42 +0900231static inline void amdtp_stream_pcm_trigger(struct amdtp_stream *s,
232 struct snd_pcm_substream *pcm)
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100233{
234 ACCESS_ONCE(s->pcm) = pcm;
235}
236
Takashi Sakamoto83d8d722014-04-25 22:44:47 +0900237/**
238 * amdtp_stream_midi_trigger - start/stop playback/capture with a MIDI device
239 * @s: the AMDTP stream
240 * @port: index of MIDI port
241 * @midi: the MIDI device to be started, or %NULL to stop the current device
242 *
243 * Call this function on a running isochronous stream to enable the actual
244 * transmission of MIDI data. This function should be called from the MIDI
245 * device's .trigger callback.
246 */
247static inline void amdtp_stream_midi_trigger(struct amdtp_stream *s,
248 unsigned int port,
249 struct snd_rawmidi_substream *midi)
250{
251 if (port < s->midi_ports)
252 ACCESS_ONCE(s->midi[port]) = midi;
253}
254
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100255static inline bool cip_sfc_is_base_44100(enum cip_sfc sfc)
256{
257 return sfc & 1;
258}
259
Takashi Sakamoto7b3b0d82014-04-25 22:44:49 +0900260static inline void amdtp_stream_set_sync(enum cip_flags sync_mode,
261 struct amdtp_stream *master,
262 struct amdtp_stream *slave)
263{
264 if (sync_mode == CIP_SYNC_TO_DEVICE) {
265 master->flags |= CIP_SYNC_TO_DEVICE;
266 slave->flags |= CIP_SYNC_TO_DEVICE;
267 master->sync_slave = slave;
268 } else {
269 master->flags &= ~CIP_SYNC_TO_DEVICE;
270 slave->flags &= ~CIP_SYNC_TO_DEVICE;
271 master->sync_slave = NULL;
272 }
273
274 slave->sync_slave = NULL;
275}
276
277/**
278 * amdtp_stream_wait_callback - sleep till callbacked or timeout
279 * @s: the AMDTP stream
280 * @timeout: msec till timeout
281 *
282 * If this function return false, the AMDTP stream should be stopped.
283 */
284static inline bool amdtp_stream_wait_callback(struct amdtp_stream *s,
285 unsigned int timeout)
286{
287 return wait_event_timeout(s->callback_wait,
288 s->callbacked == true,
289 msecs_to_jiffies(timeout)) > 0;
290}
291
Clemens Ladisch31ef9132011-03-15 07:53:21 +0100292#endif