1 #ifndef SOUND_FIREWIRE_AMDTP_H_INCLUDED
2 #define SOUND_FIREWIRE_AMDTP_H_INCLUDED
3
4 #include <linux/err.h>
5 #include <linux/interrupt.h>
6 #include <linux/mutex.h>
7 #include <sound/asound.h>
8 #include "packets-buffer.h"
9
10 /**
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 * @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 */
33 enum cip_flags {
34 CIP_NONBLOCKING = 0x00,
35 CIP_BLOCKING = 0x01,
36 CIP_SYNC_TO_DEVICE = 0x02,
37 CIP_EMPTY_WITH_TAG0 = 0x04,
38 CIP_DBC_IS_END_EVENT = 0x08,
39 CIP_WRONG_DBS = 0x10,
40 CIP_SKIP_DBC_ZERO_CHECK = 0x20,
41 CIP_SKIP_INIT_DBC_CHECK = 0x40,
42 CIP_EMPTY_HAS_WRONG_DBC = 0x80,
43 };
44
45 /**
46 * enum cip_sfc - a stream's sample rate
47 */
48 enum cip_sfc {
49 CIP_SFC_32000 = 0,
50 CIP_SFC_44100 = 1,
51 CIP_SFC_48000 = 2,
52 CIP_SFC_88200 = 3,
53 CIP_SFC_96000 = 4,
54 CIP_SFC_176400 = 5,
55 CIP_SFC_192000 = 6,
56 CIP_SFC_COUNT
57 };
58
59 #define AMDTP_IN_PCM_FORMAT_BITS SNDRV_PCM_FMTBIT_S32
60
61 #define AMDTP_OUT_PCM_FORMAT_BITS (SNDRV_PCM_FMTBIT_S16 | \
62 SNDRV_PCM_FMTBIT_S32)
63
64
65 /*
66 * This module supports maximum 64 PCM channels for one PCM stream
67 * This is for our convenience.
68 */
69 #define AMDTP_MAX_CHANNELS_FOR_PCM 64
70
71 /*
72 * AMDTP packet can include channels for MIDI conformant data.
73 * Each MIDI conformant data channel includes 8 MPX-MIDI data stream.
74 * Each MPX-MIDI data stream includes one data stream from/to MIDI ports.
75 *
76 * This module supports maximum 1 MIDI conformant data channels.
77 * Then this AMDTP packets can transfer maximum 8 MIDI data streams.
78 */
79 #define AMDTP_MAX_CHANNELS_FOR_MIDI 1
80
81 struct fw_unit;
82 struct fw_iso_context;
83 struct snd_pcm_substream;
84 struct snd_pcm_runtime;
85 struct snd_rawmidi_substream;
86
87 enum amdtp_stream_direction {
88 AMDTP_OUT_STREAM = 0,
89 AMDTP_IN_STREAM
90 };
91
92 struct amdtp_stream {
93 struct fw_unit *unit;
94 enum cip_flags flags;
95 enum amdtp_stream_direction direction;
96 struct fw_iso_context *context;
97 struct mutex mutex;
98
99 enum cip_sfc sfc;
100 unsigned int data_block_quadlets;
101 unsigned int pcm_channels;
102 unsigned int midi_ports;
103 void (*transfer_samples)(struct amdtp_stream *s,
104 struct snd_pcm_substream *pcm,
105 __be32 *buffer, unsigned int frames);
106 u8 pcm_positions[AMDTP_MAX_CHANNELS_FOR_PCM];
107 u8 midi_position;
108
109 unsigned int syt_interval;
110 unsigned int transfer_delay;
111 unsigned int source_node_id_field;
112 struct iso_packets_buffer buffer;
113
114 struct snd_pcm_substream *pcm;
115 struct tasklet_struct period_tasklet;
116
117 int packet_index;
118 unsigned int data_block_counter;
119
120 unsigned int data_block_state;
121
122 unsigned int last_syt_offset;
123 unsigned int syt_offset_state;
124
125 unsigned int pcm_buffer_pointer;
126 unsigned int pcm_period_pointer;
127 bool pointer_flush;
128 bool double_pcm_frames;
129
130 struct snd_rawmidi_substream *midi[AMDTP_MAX_CHANNELS_FOR_MIDI * 8];
131
132 /* quirk: fixed interval of dbc between previos/current packets. */
133 unsigned int tx_dbc_interval;
134 /* quirk: indicate the value of dbc field in a first packet. */
135 unsigned int tx_first_dbc;
136
137 /* quirk: the first count of data blocks in an rx packet for MIDI */
138 unsigned int rx_blocks_for_midi;
139
140 bool callbacked;
141 wait_queue_head_t callback_wait;
142 struct amdtp_stream *sync_slave;
143 };
144
145 int amdtp_stream_init(struct amdtp_stream *s, struct fw_unit *unit,
146 enum amdtp_stream_direction dir,
147 enum cip_flags flags);
148 void amdtp_stream_destroy(struct amdtp_stream *s);
149
150 void amdtp_stream_set_parameters(struct amdtp_stream *s,
151 unsigned int rate,
152 unsigned int pcm_channels,
153 unsigned int midi_ports);
154 unsigned int amdtp_stream_get_max_payload(struct amdtp_stream *s);
155
156 int amdtp_stream_start(struct amdtp_stream *s, int channel, int speed);
157 void amdtp_stream_update(struct amdtp_stream *s);
158 void amdtp_stream_stop(struct amdtp_stream *s);
159
160 int amdtp_stream_add_pcm_hw_constraints(struct amdtp_stream *s,
161 struct snd_pcm_runtime *runtime);
162 void amdtp_stream_set_pcm_format(struct amdtp_stream *s,
163 snd_pcm_format_t format);
164 void amdtp_stream_pcm_prepare(struct amdtp_stream *s);
165 unsigned long amdtp_stream_pcm_pointer(struct amdtp_stream *s);
166 void amdtp_stream_pcm_abort(struct amdtp_stream *s);
167
168 extern const unsigned int amdtp_syt_intervals[CIP_SFC_COUNT];
169 extern const unsigned int amdtp_rate_table[CIP_SFC_COUNT];
170
171 /**
172 * amdtp_stream_running - check stream is running or not
173 * @s: the AMDTP stream
174 *
175 * If this function returns true, the stream is running.
176 */
amdtp_stream_running(struct amdtp_stream * s)177 static inline bool amdtp_stream_running(struct amdtp_stream *s)
178 {
179 return !IS_ERR(s->context);
180 }
181
182 /**
183 * amdtp_streaming_error - check for streaming error
184 * @s: the AMDTP stream
185 *
186 * If this function returns true, the stream's packet queue has stopped due to
187 * an asynchronous error.
188 */
amdtp_streaming_error(struct amdtp_stream * s)189 static inline bool amdtp_streaming_error(struct amdtp_stream *s)
190 {
191 return s->packet_index < 0;
192 }
193
194 /**
195 * amdtp_stream_pcm_running - check PCM substream is running or not
196 * @s: the AMDTP stream
197 *
198 * If this function returns true, PCM substream in the AMDTP stream is running.
199 */
amdtp_stream_pcm_running(struct amdtp_stream * s)200 static inline bool amdtp_stream_pcm_running(struct amdtp_stream *s)
201 {
202 return !!s->pcm;
203 }
204
205 /**
206 * amdtp_stream_pcm_trigger - start/stop playback from a PCM device
207 * @s: the AMDTP stream
208 * @pcm: the PCM device to be started, or %NULL to stop the current device
209 *
210 * Call this function on a running isochronous stream to enable the actual
211 * transmission of PCM data. This function should be called from the PCM
212 * device's .trigger callback.
213 */
amdtp_stream_pcm_trigger(struct amdtp_stream * s,struct snd_pcm_substream * pcm)214 static inline void amdtp_stream_pcm_trigger(struct amdtp_stream *s,
215 struct snd_pcm_substream *pcm)
216 {
217 ACCESS_ONCE(s->pcm) = pcm;
218 }
219
220 /**
221 * amdtp_stream_midi_trigger - start/stop playback/capture with a MIDI device
222 * @s: the AMDTP stream
223 * @port: index of MIDI port
224 * @midi: the MIDI device to be started, or %NULL to stop the current device
225 *
226 * Call this function on a running isochronous stream to enable the actual
227 * transmission of MIDI data. This function should be called from the MIDI
228 * device's .trigger callback.
229 */
amdtp_stream_midi_trigger(struct amdtp_stream * s,unsigned int port,struct snd_rawmidi_substream * midi)230 static inline void amdtp_stream_midi_trigger(struct amdtp_stream *s,
231 unsigned int port,
232 struct snd_rawmidi_substream *midi)
233 {
234 if (port < s->midi_ports)
235 ACCESS_ONCE(s->midi[port]) = midi;
236 }
237
cip_sfc_is_base_44100(enum cip_sfc sfc)238 static inline bool cip_sfc_is_base_44100(enum cip_sfc sfc)
239 {
240 return sfc & 1;
241 }
242
amdtp_stream_set_sync(enum cip_flags sync_mode,struct amdtp_stream * master,struct amdtp_stream * slave)243 static inline void amdtp_stream_set_sync(enum cip_flags sync_mode,
244 struct amdtp_stream *master,
245 struct amdtp_stream *slave)
246 {
247 if (sync_mode == CIP_SYNC_TO_DEVICE) {
248 master->flags |= CIP_SYNC_TO_DEVICE;
249 slave->flags |= CIP_SYNC_TO_DEVICE;
250 master->sync_slave = slave;
251 } else {
252 master->flags &= ~CIP_SYNC_TO_DEVICE;
253 slave->flags &= ~CIP_SYNC_TO_DEVICE;
254 master->sync_slave = NULL;
255 }
256
257 slave->sync_slave = NULL;
258 }
259
260 /**
261 * amdtp_stream_wait_callback - sleep till callbacked or timeout
262 * @s: the AMDTP stream
263 * @timeout: msec till timeout
264 *
265 * If this function return false, the AMDTP stream should be stopped.
266 */
amdtp_stream_wait_callback(struct amdtp_stream * s,unsigned int timeout)267 static inline bool amdtp_stream_wait_callback(struct amdtp_stream *s,
268 unsigned int timeout)
269 {
270 return wait_event_timeout(s->callback_wait,
271 s->callbacked == true,
272 msecs_to_jiffies(timeout)) > 0;
273 }
274
275 #endif
276