]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - sound/firewire/amdtp-stream.h
ALSA: fireface: use the same size of period for PCM substreams in AMDTP streams
[mirror_ubuntu-hirsute-kernel.git] / sound / firewire / amdtp-stream.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
31ef9134
CL
2#ifndef SOUND_FIREWIRE_AMDTP_H_INCLUDED
3#define SOUND_FIREWIRE_AMDTP_H_INCLUDED
4
20b65dd0 5#include <linux/err.h>
76fb8789 6#include <linux/interrupt.h>
31ef9134 7#include <linux/mutex.h>
5955815e 8#include <linux/sched.h>
777fb574 9#include <sound/asound.h>
31ef9134
CL
10#include "packets-buffer.h"
11
12/**
be4a2894 13 * enum cip_flags - describes details of the streaming protocol
31ef9134
CL
14 * @CIP_NONBLOCKING: In non-blocking mode, each packet contains
15 * sample_rate/8000 samples, with rounding up or down to adjust
16 * for clock skew and left-over fractional samples. This should
17 * be used if supported by the device.
e84d15f6
CL
18 * @CIP_BLOCKING: In blocking mode, each packet contains either zero or
19 * SYT_INTERVAL samples, with these two types alternating so that
20 * the overall sample rate comes out right.
7ab56645 21 * @CIP_EMPTY_WITH_TAG0: Only for in-stream. Empty in-packets have TAG0.
9dae017b
TS
22 * @CIP_DBC_IS_END_EVENT: The value of dbc in an packet corresponds to the end
23 * 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.
9d59124c
TS
28 * @CIP_EMPTY_HAS_WRONG_DBC: Only for in-stream. The value of dbc in empty
29 * packet is wrong but the others are correct.
a2064710
TS
30 * @CIP_JUMBO_PAYLOAD: Only for in-stream. The number of data blocks in an
31 * packet is larger than IEC 61883-6 defines. Current implementation
32 * allows 5 times as large as IEC 61883-6 defines.
2128f78f
TS
33 * @CIP_HEADER_WITHOUT_EOH: Only for in-stream. CIP Header doesn't include
34 * valid EOH.
3b196c39 35 * @CIP_NO_HEADERS: a lack of headers in packets
588f2e2c
TS
36 * @CIP_UNALIGHED_DBC: Only for in-stream. The value of dbc is not alighed to
37 * the value of current SYT_INTERVAL; e.g. initial value is not zero.
31ef9134 38 */
be4a2894 39enum cip_flags {
7b3b0d85
TS
40 CIP_NONBLOCKING = 0x00,
41 CIP_BLOCKING = 0x01,
dec63cc8
TS
42 CIP_EMPTY_WITH_TAG0 = 0x02,
43 CIP_DBC_IS_END_EVENT = 0x04,
44 CIP_WRONG_DBS = 0x08,
45 CIP_SKIP_DBC_ZERO_CHECK = 0x10,
62f00e40
TS
46 CIP_EMPTY_HAS_WRONG_DBC = 0x20,
47 CIP_JUMBO_PAYLOAD = 0x40,
2128f78f 48 CIP_HEADER_WITHOUT_EOH = 0x80,
3b196c39 49 CIP_NO_HEADER = 0x100,
588f2e2c 50 CIP_UNALIGHED_DBC = 0x200,
31ef9134
CL
51};
52
53/**
5f217f90
TS
54 * enum cip_sfc - supported Sampling Frequency Codes (SFCs)
55 * @CIP_SFC_32000: 32,000 data blocks
56 * @CIP_SFC_44100: 44,100 data blocks
57 * @CIP_SFC_48000: 48,000 data blocks
58 * @CIP_SFC_88200: 88,200 data blocks
59 * @CIP_SFC_96000: 96,000 data blocks
60 * @CIP_SFC_176400: 176,400 data blocks
61 * @CIP_SFC_192000: 192,000 data blocks
62 * @CIP_SFC_COUNT: the number of supported SFCs
63 *
64 * These values are used to show nominal Sampling Frequency Code in
65 * Format Dependent Field (FDF) of AMDTP packet header. In IEC 61883-6:2002,
66 * this code means the number of events per second. Actually the code
67 * represents the number of data blocks transferred per second in an AMDTP
68 * stream.
69 *
70 * In IEC 61883-6:2005, some extensions were added to support more types of
71 * data such as 'One Bit LInear Audio', therefore the meaning of SFC became
72 * different depending on the types.
73 *
74 * Currently our implementation is compatible with IEC 61883-6:2002.
31ef9134
CL
75 */
76enum cip_sfc {
77 CIP_SFC_32000 = 0,
78 CIP_SFC_44100 = 1,
79 CIP_SFC_48000 = 2,
80 CIP_SFC_88200 = 3,
81 CIP_SFC_96000 = 4,
82 CIP_SFC_176400 = 5,
83 CIP_SFC_192000 = 6,
a7304e3b 84 CIP_SFC_COUNT
31ef9134
CL
85};
86
31ef9134
CL
87struct fw_unit;
88struct fw_iso_context;
89struct snd_pcm_substream;
7b2d99fa 90struct snd_pcm_runtime;
31ef9134 91
3ff7e8f0
TS
92enum amdtp_stream_direction {
93 AMDTP_OUT_STREAM = 0,
94 AMDTP_IN_STREAM
95};
96
04130cf8
TS
97struct pkt_desc {
98 u32 cycle;
99 u32 syt;
100 unsigned int data_blocks;
101 unsigned int data_block_counter;
102 __be32 *ctx_payload;
103};
104
df075fee 105struct amdtp_stream;
9a738ad1 106typedef unsigned int (*amdtp_stream_process_ctx_payloads_t)(
df075fee 107 struct amdtp_stream *s,
d2c104a3 108 const struct pkt_desc *desc,
9a738ad1 109 unsigned int packets,
d2c104a3 110 struct snd_pcm_substream *pcm);
be4a2894 111struct amdtp_stream {
31ef9134 112 struct fw_unit *unit;
be4a2894 113 enum cip_flags flags;
3ff7e8f0 114 enum amdtp_stream_direction direction;
31ef9134
CL
115 struct mutex mutex;
116
10b2b6dc
TS
117 /* For packet processing. */
118 struct fw_iso_context *context;
31ef9134 119 struct iso_packets_buffer buffer;
ec00f5e4 120 int packet_index;
04130cf8 121 struct pkt_desc *pkt_descs;
3b196c39 122 int tag;
d3d10a4a
TS
123 union {
124 struct {
125 unsigned int ctx_header_size;
126
127 // limit for payload of iso packet.
f11453c7 128 unsigned int max_ctx_payload_length;
d3d10a4a
TS
129
130 // For quirks of CIP headers.
131 // Fixed interval of dbc between previos/current
132 // packets.
133 unsigned int dbc_interval;
d3d10a4a
TS
134 } tx;
135 struct {
136 // To calculate CIP data blocks and tstamp.
137 unsigned int transfer_delay;
138 unsigned int data_block_state;
139 unsigned int last_syt_offset;
140 unsigned int syt_offset_state;
141
142 // To generate CIP header.
143 unsigned int fdf;
3baf3053 144 int syt_override;
d3d10a4a
TS
145 } rx;
146 } ctx_data;
10b2b6dc
TS
147
148 /* For CIP headers. */
149 unsigned int source_node_id_field;
150 unsigned int data_block_quadlets;
31ef9134 151 unsigned int data_block_counter;
9863874f 152 unsigned int sph;
414ba022 153 unsigned int fmt;
31ef9134 154
10b2b6dc
TS
155 /* Internal flags. */
156 enum cip_sfc sfc;
157 unsigned int syt_interval;
31ef9134 158
10b2b6dc
TS
159 /* For a PCM substream processing. */
160 struct snd_pcm_substream *pcm;
161 struct tasklet_struct period_tasklet;
4a9bfafc 162 snd_pcm_uframes_t pcm_buffer_pointer;
31ef9134 163 unsigned int pcm_period_pointer;
83d8d72d 164
10b2b6dc
TS
165 /* To wait for first packet. */
166 bool callbacked;
167 wait_queue_head_t callback_wait;
a04513f8 168 u32 start_cycle;
10b2b6dc 169
df075fee
TS
170 /* For backends to process data blocks. */
171 void *protocol;
9a738ad1 172 amdtp_stream_process_ctx_payloads_t process_ctx_payloads;
6261f90b
TS
173
174 // For domain.
157a53ee
TS
175 int channel;
176 int speed;
6261f90b 177 struct list_head list;
31ef9134
CL
178};
179
be4a2894 180int amdtp_stream_init(struct amdtp_stream *s, struct fw_unit *unit,
df075fee
TS
181 enum amdtp_stream_direction dir, enum cip_flags flags,
182 unsigned int fmt,
9a738ad1 183 amdtp_stream_process_ctx_payloads_t process_ctx_payloads,
df075fee 184 unsigned int protocol_size);
be4a2894 185void amdtp_stream_destroy(struct amdtp_stream *s);
31ef9134 186
df075fee
TS
187int amdtp_stream_set_parameters(struct amdtp_stream *s, unsigned int rate,
188 unsigned int data_block_quadlets);
be4a2894 189unsigned int amdtp_stream_get_max_payload(struct amdtp_stream *s);
31ef9134 190
be4a2894 191void amdtp_stream_update(struct amdtp_stream *s);
31ef9134 192
7b2d99fa
TS
193int amdtp_stream_add_pcm_hw_constraints(struct amdtp_stream *s,
194 struct snd_pcm_runtime *runtime);
df075fee 195
be4a2894
TS
196void amdtp_stream_pcm_prepare(struct amdtp_stream *s);
197unsigned long amdtp_stream_pcm_pointer(struct amdtp_stream *s);
875becf8 198int amdtp_stream_pcm_ack(struct amdtp_stream *s);
be4a2894 199void amdtp_stream_pcm_abort(struct amdtp_stream *s);
31ef9134 200
c5280e99 201extern const unsigned int amdtp_syt_intervals[CIP_SFC_COUNT];
1017abed 202extern const unsigned int amdtp_rate_table[CIP_SFC_COUNT];
a7304e3b 203
be4a2894
TS
204/**
205 * amdtp_stream_running - check stream is running or not
206 * @s: the AMDTP stream
207 *
208 * If this function returns true, the stream is running.
209 */
210static inline bool amdtp_stream_running(struct amdtp_stream *s)
20b65dd0
CL
211{
212 return !IS_ERR(s->context);
213}
214
ec00f5e4 215/**
be4a2894
TS
216 * amdtp_streaming_error - check for streaming error
217 * @s: the AMDTP stream
ec00f5e4
CL
218 *
219 * If this function returns true, the stream's packet queue has stopped due to
220 * an asynchronous error.
221 */
be4a2894 222static inline bool amdtp_streaming_error(struct amdtp_stream *s)
ec00f5e4
CL
223{
224 return s->packet_index < 0;
225}
226
83d8d72d
TS
227/**
228 * amdtp_stream_pcm_running - check PCM substream is running or not
229 * @s: the AMDTP stream
230 *
231 * If this function returns true, PCM substream in the AMDTP stream is running.
232 */
233static inline bool amdtp_stream_pcm_running(struct amdtp_stream *s)
234{
235 return !!s->pcm;
236}
237
31ef9134 238/**
be4a2894
TS
239 * amdtp_stream_pcm_trigger - start/stop playback from a PCM device
240 * @s: the AMDTP stream
31ef9134
CL
241 * @pcm: the PCM 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 PCM data. This function should be called from the PCM
245 * device's .trigger callback.
246 */
be4a2894
TS
247static inline void amdtp_stream_pcm_trigger(struct amdtp_stream *s,
248 struct snd_pcm_substream *pcm)
31ef9134 249{
6aa7de05 250 WRITE_ONCE(s->pcm, pcm);
31ef9134
CL
251}
252
31ef9134
CL
253static inline bool cip_sfc_is_base_44100(enum cip_sfc sfc)
254{
255 return sfc & 1;
256}
257
7b3b0d85
TS
258/**
259 * amdtp_stream_wait_callback - sleep till callbacked or timeout
260 * @s: the AMDTP stream
261 * @timeout: msec till timeout
262 *
263 * If this function return false, the AMDTP stream should be stopped.
264 */
265static inline bool amdtp_stream_wait_callback(struct amdtp_stream *s,
266 unsigned int timeout)
267{
268 return wait_event_timeout(s->callback_wait,
269 s->callbacked == true,
270 msecs_to_jiffies(timeout)) > 0;
271}
272
3ec3d7a3
TS
273struct amdtp_domain {
274 struct list_head streams;
d68c3123
TS
275
276 unsigned int events_per_period;
3ec3d7a3
TS
277};
278
279int amdtp_domain_init(struct amdtp_domain *d);
280void amdtp_domain_destroy(struct amdtp_domain *d);
281
157a53ee
TS
282int amdtp_domain_add_stream(struct amdtp_domain *d, struct amdtp_stream *s,
283 int channel, int speed);
284
9b4702b0 285int amdtp_domain_start(struct amdtp_domain *d);
6261f90b
TS
286void amdtp_domain_stop(struct amdtp_domain *d);
287
d68c3123
TS
288static inline int amdtp_domain_set_events_per_period(struct amdtp_domain *d,
289 unsigned int events_per_period)
290{
291 d->events_per_period = events_per_period;
292
293 return 0;
294}
295
31ef9134 296#endif