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