Merge tag 'linux-kselftest-3.19-rc1' of git://git.kernel.org/pub/scm/linux/kernel...
[deliverable/linux.git] / sound / firewire / amdtp.h
CommitLineData
31ef9134
CL
1#ifndef SOUND_FIREWIRE_AMDTP_H_INCLUDED
2#define SOUND_FIREWIRE_AMDTP_H_INCLUDED
3
20b65dd0 4#include <linux/err.h>
76fb8789 5#include <linux/interrupt.h>
31ef9134 6#include <linux/mutex.h>
777fb574 7#include <sound/asound.h>
31ef9134
CL
8#include "packets-buffer.h"
9
10/**
be4a2894 11 * enum cip_flags - describes details of the streaming protocol
31ef9134
CL
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.
e84d15f6
CL
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.
7b3b0d85
TS
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.
7ab56645 21 * @CIP_EMPTY_WITH_TAG0: Only for in-stream. Empty in-packets have TAG0.
c8bdf49b
TS
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.
69702239
TS
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.
5f217f90 26 * @CIP_SKIP_DBC_ZERO_CHECK: Only for in-stream. Packets with zero in dbc is
b84b1a27 27 * skipped for detecting discontinuity.
b6bc8123
TS
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.
9d59124c
TS
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.
31ef9134 32 */
be4a2894 33enum cip_flags {
7b3b0d85
TS
34 CIP_NONBLOCKING = 0x00,
35 CIP_BLOCKING = 0x01,
10550bea 36 CIP_SYNC_TO_DEVICE = 0x02,
7ab56645 37 CIP_EMPTY_WITH_TAG0 = 0x04,
c8bdf49b 38 CIP_DBC_IS_END_EVENT = 0x08,
69702239 39 CIP_WRONG_DBS = 0x10,
b84b1a27 40 CIP_SKIP_DBC_ZERO_CHECK = 0x20,
b6bc8123 41 CIP_SKIP_INIT_DBC_CHECK = 0x40,
9d59124c 42 CIP_EMPTY_HAS_WRONG_DBC = 0x80,
31ef9134
CL
43};
44
45/**
5f217f90
TS
46 * 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.
31ef9134
CL
67 */
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,
a7304e3b 76 CIP_SFC_COUNT
31ef9134
CL
77};
78
2b3fc456
TS
79#define AMDTP_IN_PCM_FORMAT_BITS SNDRV_PCM_FMTBIT_S32
80
31ef9134
CL
81#define AMDTP_OUT_PCM_FORMAT_BITS (SNDRV_PCM_FMTBIT_S16 | \
82 SNDRV_PCM_FMTBIT_S32)
83
83d8d72d 84
77d2a8a4
TS
85/*
86 * 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
83d8d72d
TS
91/*
92 * 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
31ef9134
CL
101struct fw_unit;
102struct fw_iso_context;
103struct snd_pcm_substream;
7b2d99fa 104struct snd_pcm_runtime;
83d8d72d 105struct snd_rawmidi_substream;
31ef9134 106
3ff7e8f0
TS
107enum amdtp_stream_direction {
108 AMDTP_OUT_STREAM = 0,
109 AMDTP_IN_STREAM
110};
111
be4a2894 112struct amdtp_stream {
31ef9134 113 struct fw_unit *unit;
be4a2894 114 enum cip_flags flags;
3ff7e8f0 115 enum amdtp_stream_direction direction;
31ef9134
CL
116 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;
be4a2894 123 void (*transfer_samples)(struct amdtp_stream *s,
31ef9134
CL
124 struct snd_pcm_substream *pcm,
125 __be32 *buffer, unsigned int frames);
77d2a8a4
TS
126 u8 pcm_positions[AMDTP_MAX_CHANNELS_FOR_PCM];
127 u8 midi_position;
31ef9134
CL
128
129 unsigned int syt_interval;
e84d15f6 130 unsigned int transfer_delay;
31ef9134
CL
131 unsigned int source_node_id_field;
132 struct iso_packets_buffer buffer;
133
134 struct snd_pcm_substream *pcm;
76fb8789 135 struct tasklet_struct period_tasklet;
31ef9134 136
ec00f5e4 137 int packet_index;
31ef9134
CL
138 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;
92b862c7 147 bool pointer_flush;
65845f29 148 bool double_pcm_frames;
83d8d72d
TS
149
150 struct snd_rawmidi_substream *midi[AMDTP_MAX_CHANNELS_FOR_MIDI * 8];
7b3b0d85 151
d9cd0065
TS
152 /* quirk: fixed interval of dbc between previos/current packets. */
153 unsigned int tx_dbc_interval;
154
53111cdc
TS
155 /* quirk: the first count of data blocks in an rx packet for MIDI */
156 unsigned int rx_blocks_for_midi;
157
7b3b0d85
TS
158 bool callbacked;
159 wait_queue_head_t callback_wait;
160 struct amdtp_stream *sync_slave;
31ef9134
CL
161};
162
be4a2894 163int amdtp_stream_init(struct amdtp_stream *s, struct fw_unit *unit,
3ff7e8f0 164 enum amdtp_stream_direction dir,
be4a2894
TS
165 enum cip_flags flags);
166void amdtp_stream_destroy(struct amdtp_stream *s);
31ef9134 167
be4a2894
TS
168void amdtp_stream_set_parameters(struct amdtp_stream *s,
169 unsigned int rate,
170 unsigned int pcm_channels,
171 unsigned int midi_ports);
172unsigned int amdtp_stream_get_max_payload(struct amdtp_stream *s);
31ef9134 173
be4a2894
TS
174int amdtp_stream_start(struct amdtp_stream *s, int channel, int speed);
175void amdtp_stream_update(struct amdtp_stream *s);
176void amdtp_stream_stop(struct amdtp_stream *s);
31ef9134 177
7b2d99fa
TS
178int amdtp_stream_add_pcm_hw_constraints(struct amdtp_stream *s,
179 struct snd_pcm_runtime *runtime);
be4a2894
TS
180void amdtp_stream_set_pcm_format(struct amdtp_stream *s,
181 snd_pcm_format_t format);
182void amdtp_stream_pcm_prepare(struct amdtp_stream *s);
183unsigned long amdtp_stream_pcm_pointer(struct amdtp_stream *s);
184void amdtp_stream_pcm_abort(struct amdtp_stream *s);
31ef9134 185
c5280e99 186extern const unsigned int amdtp_syt_intervals[CIP_SFC_COUNT];
1017abed 187extern const unsigned int amdtp_rate_table[CIP_SFC_COUNT];
a7304e3b 188
be4a2894
TS
189/**
190 * amdtp_stream_running - check stream is running or not
191 * @s: the AMDTP stream
192 *
193 * If this function returns true, the stream is running.
194 */
195static inline bool amdtp_stream_running(struct amdtp_stream *s)
20b65dd0
CL
196{
197 return !IS_ERR(s->context);
198}
199
ec00f5e4 200/**
be4a2894
TS
201 * amdtp_streaming_error - check for streaming error
202 * @s: the AMDTP stream
ec00f5e4
CL
203 *
204 * If this function returns true, the stream's packet queue has stopped due to
205 * an asynchronous error.
206 */
be4a2894 207static inline bool amdtp_streaming_error(struct amdtp_stream *s)
ec00f5e4
CL
208{
209 return s->packet_index < 0;
210}
211
83d8d72d
TS
212/**
213 * amdtp_stream_pcm_running - check PCM substream is running or not
214 * @s: the AMDTP stream
215 *
216 * If this function returns true, PCM substream in the AMDTP stream is running.
217 */
218static inline bool amdtp_stream_pcm_running(struct amdtp_stream *s)
219{
220 return !!s->pcm;
221}
222
31ef9134 223/**
be4a2894
TS
224 * amdtp_stream_pcm_trigger - start/stop playback from a PCM device
225 * @s: the AMDTP stream
31ef9134
CL
226 * @pcm: the PCM device to be started, or %NULL to stop the current device
227 *
228 * Call this function on a running isochronous stream to enable the actual
229 * transmission of PCM data. This function should be called from the PCM
230 * device's .trigger callback.
231 */
be4a2894
TS
232static inline void amdtp_stream_pcm_trigger(struct amdtp_stream *s,
233 struct snd_pcm_substream *pcm)
31ef9134
CL
234{
235 ACCESS_ONCE(s->pcm) = pcm;
236}
237
83d8d72d
TS
238/**
239 * amdtp_stream_midi_trigger - start/stop playback/capture with a MIDI device
240 * @s: the AMDTP stream
241 * @port: index of MIDI port
242 * @midi: the MIDI device to be started, or %NULL to stop the current device
243 *
244 * Call this function on a running isochronous stream to enable the actual
245 * transmission of MIDI data. This function should be called from the MIDI
246 * device's .trigger callback.
247 */
248static inline void amdtp_stream_midi_trigger(struct amdtp_stream *s,
249 unsigned int port,
250 struct snd_rawmidi_substream *midi)
251{
252 if (port < s->midi_ports)
253 ACCESS_ONCE(s->midi[port]) = midi;
254}
255
31ef9134
CL
256static inline bool cip_sfc_is_base_44100(enum cip_sfc sfc)
257{
258 return sfc & 1;
259}
260
7b3b0d85
TS
261static inline void amdtp_stream_set_sync(enum cip_flags sync_mode,
262 struct amdtp_stream *master,
263 struct amdtp_stream *slave)
264{
265 if (sync_mode == CIP_SYNC_TO_DEVICE) {
266 master->flags |= CIP_SYNC_TO_DEVICE;
267 slave->flags |= CIP_SYNC_TO_DEVICE;
268 master->sync_slave = slave;
269 } else {
270 master->flags &= ~CIP_SYNC_TO_DEVICE;
271 slave->flags &= ~CIP_SYNC_TO_DEVICE;
272 master->sync_slave = NULL;
273 }
274
275 slave->sync_slave = NULL;
276}
277
278/**
279 * amdtp_stream_wait_callback - sleep till callbacked or timeout
280 * @s: the AMDTP stream
281 * @timeout: msec till timeout
282 *
283 * If this function return false, the AMDTP stream should be stopped.
284 */
285static inline bool amdtp_stream_wait_callback(struct amdtp_stream *s,
286 unsigned int timeout)
287{
288 return wait_event_timeout(s->callback_wait,
289 s->callbacked == true,
290 msecs_to_jiffies(timeout)) > 0;
291}
292
31ef9134 293#endif
This page took 0.166744 seconds and 5 git commands to generate.