Commit | Line | Data |
---|---|---|
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 |
31ef9134 | 36 | */ |
be4a2894 | 37 | enum cip_flags { |
7b3b0d85 TS |
38 | CIP_NONBLOCKING = 0x00, |
39 | CIP_BLOCKING = 0x01, | |
dec63cc8 TS |
40 | CIP_EMPTY_WITH_TAG0 = 0x02, |
41 | CIP_DBC_IS_END_EVENT = 0x04, | |
42 | CIP_WRONG_DBS = 0x08, | |
43 | CIP_SKIP_DBC_ZERO_CHECK = 0x10, | |
62f00e40 TS |
44 | CIP_EMPTY_HAS_WRONG_DBC = 0x20, |
45 | CIP_JUMBO_PAYLOAD = 0x40, | |
2128f78f | 46 | CIP_HEADER_WITHOUT_EOH = 0x80, |
3b196c39 | 47 | CIP_NO_HEADER = 0x100, |
31ef9134 CL |
48 | }; |
49 | ||
50 | /** | |
5f217f90 TS |
51 | * enum cip_sfc - supported Sampling Frequency Codes (SFCs) |
52 | * @CIP_SFC_32000: 32,000 data blocks | |
53 | * @CIP_SFC_44100: 44,100 data blocks | |
54 | * @CIP_SFC_48000: 48,000 data blocks | |
55 | * @CIP_SFC_88200: 88,200 data blocks | |
56 | * @CIP_SFC_96000: 96,000 data blocks | |
57 | * @CIP_SFC_176400: 176,400 data blocks | |
58 | * @CIP_SFC_192000: 192,000 data blocks | |
59 | * @CIP_SFC_COUNT: the number of supported SFCs | |
60 | * | |
61 | * These values are used to show nominal Sampling Frequency Code in | |
62 | * Format Dependent Field (FDF) of AMDTP packet header. In IEC 61883-6:2002, | |
63 | * this code means the number of events per second. Actually the code | |
64 | * represents the number of data blocks transferred per second in an AMDTP | |
65 | * stream. | |
66 | * | |
67 | * In IEC 61883-6:2005, some extensions were added to support more types of | |
68 | * data such as 'One Bit LInear Audio', therefore the meaning of SFC became | |
69 | * different depending on the types. | |
70 | * | |
71 | * Currently our implementation is compatible with IEC 61883-6:2002. | |
31ef9134 CL |
72 | */ |
73 | enum cip_sfc { | |
74 | CIP_SFC_32000 = 0, | |
75 | CIP_SFC_44100 = 1, | |
76 | CIP_SFC_48000 = 2, | |
77 | CIP_SFC_88200 = 3, | |
78 | CIP_SFC_96000 = 4, | |
79 | CIP_SFC_176400 = 5, | |
80 | CIP_SFC_192000 = 6, | |
a7304e3b | 81 | CIP_SFC_COUNT |
31ef9134 CL |
82 | }; |
83 | ||
31ef9134 CL |
84 | struct fw_unit; |
85 | struct fw_iso_context; | |
86 | struct snd_pcm_substream; | |
7b2d99fa | 87 | struct snd_pcm_runtime; |
31ef9134 | 88 | |
3ff7e8f0 TS |
89 | enum amdtp_stream_direction { |
90 | AMDTP_OUT_STREAM = 0, | |
91 | AMDTP_IN_STREAM | |
92 | }; | |
93 | ||
df075fee TS |
94 | struct amdtp_stream; |
95 | typedef unsigned int (*amdtp_stream_process_data_blocks_t)( | |
96 | struct amdtp_stream *s, | |
97 | __be32 *buffer, | |
98 | unsigned int data_blocks, | |
99 | unsigned int *syt); | |
be4a2894 | 100 | struct amdtp_stream { |
31ef9134 | 101 | struct fw_unit *unit; |
be4a2894 | 102 | enum cip_flags flags; |
3ff7e8f0 | 103 | enum amdtp_stream_direction direction; |
31ef9134 CL |
104 | struct mutex mutex; |
105 | ||
10b2b6dc TS |
106 | /* For packet processing. */ |
107 | struct fw_iso_context *context; | |
31ef9134 | 108 | struct iso_packets_buffer buffer; |
ec00f5e4 | 109 | int packet_index; |
3b196c39 | 110 | int tag; |
6f3c07d0 | 111 | int (*handle_packet)(struct amdtp_stream *s, unsigned int cycle, |
8a400b99 TS |
112 | const __be32 *ctx_header, __be32 *buffer, |
113 | unsigned int index); | |
d3d10a4a TS |
114 | union { |
115 | struct { | |
116 | unsigned int ctx_header_size; | |
117 | ||
118 | // limit for payload of iso packet. | |
f11453c7 | 119 | unsigned int max_ctx_payload_length; |
d3d10a4a TS |
120 | |
121 | // For quirks of CIP headers. | |
122 | // Fixed interval of dbc between previos/current | |
123 | // packets. | |
124 | unsigned int dbc_interval; | |
125 | // Indicate the value of dbc field in a first packet. | |
126 | unsigned int first_dbc; | |
127 | } tx; | |
128 | struct { | |
129 | // To calculate CIP data blocks and tstamp. | |
130 | unsigned int transfer_delay; | |
131 | unsigned int data_block_state; | |
132 | unsigned int last_syt_offset; | |
133 | unsigned int syt_offset_state; | |
134 | ||
135 | // To generate CIP header. | |
136 | unsigned int fdf; | |
137 | } rx; | |
138 | } ctx_data; | |
10b2b6dc TS |
139 | |
140 | /* For CIP headers. */ | |
141 | unsigned int source_node_id_field; | |
142 | unsigned int data_block_quadlets; | |
31ef9134 | 143 | unsigned int data_block_counter; |
9863874f | 144 | unsigned int sph; |
414ba022 | 145 | unsigned int fmt; |
31ef9134 | 146 | |
10b2b6dc TS |
147 | /* Internal flags. */ |
148 | enum cip_sfc sfc; | |
149 | unsigned int syt_interval; | |
31ef9134 | 150 | |
10b2b6dc TS |
151 | /* For a PCM substream processing. */ |
152 | struct snd_pcm_substream *pcm; | |
153 | struct tasklet_struct period_tasklet; | |
4a9bfafc | 154 | snd_pcm_uframes_t pcm_buffer_pointer; |
31ef9134 | 155 | unsigned int pcm_period_pointer; |
83d8d72d | 156 | |
10b2b6dc TS |
157 | /* To wait for first packet. */ |
158 | bool callbacked; | |
159 | wait_queue_head_t callback_wait; | |
a04513f8 | 160 | u32 start_cycle; |
10b2b6dc | 161 | |
df075fee TS |
162 | /* For backends to process data blocks. */ |
163 | void *protocol; | |
164 | amdtp_stream_process_data_blocks_t process_data_blocks; | |
31ef9134 CL |
165 | }; |
166 | ||
be4a2894 | 167 | int amdtp_stream_init(struct amdtp_stream *s, struct fw_unit *unit, |
df075fee TS |
168 | enum amdtp_stream_direction dir, enum cip_flags flags, |
169 | unsigned int fmt, | |
170 | amdtp_stream_process_data_blocks_t process_data_blocks, | |
171 | unsigned int protocol_size); | |
be4a2894 | 172 | void amdtp_stream_destroy(struct amdtp_stream *s); |
31ef9134 | 173 | |
df075fee TS |
174 | int amdtp_stream_set_parameters(struct amdtp_stream *s, unsigned int rate, |
175 | unsigned int data_block_quadlets); | |
be4a2894 | 176 | unsigned int amdtp_stream_get_max_payload(struct amdtp_stream *s); |
31ef9134 | 177 | |
be4a2894 TS |
178 | int amdtp_stream_start(struct amdtp_stream *s, int channel, int speed); |
179 | void amdtp_stream_update(struct amdtp_stream *s); | |
180 | void amdtp_stream_stop(struct amdtp_stream *s); | |
31ef9134 | 181 | |
7b2d99fa TS |
182 | int amdtp_stream_add_pcm_hw_constraints(struct amdtp_stream *s, |
183 | struct snd_pcm_runtime *runtime); | |
df075fee | 184 | |
be4a2894 TS |
185 | void amdtp_stream_pcm_prepare(struct amdtp_stream *s); |
186 | unsigned long amdtp_stream_pcm_pointer(struct amdtp_stream *s); | |
875becf8 | 187 | int amdtp_stream_pcm_ack(struct amdtp_stream *s); |
be4a2894 | 188 | void amdtp_stream_pcm_abort(struct amdtp_stream *s); |
31ef9134 | 189 | |
c5280e99 | 190 | extern const unsigned int amdtp_syt_intervals[CIP_SFC_COUNT]; |
1017abed | 191 | extern const unsigned int amdtp_rate_table[CIP_SFC_COUNT]; |
a7304e3b | 192 | |
be4a2894 TS |
193 | /** |
194 | * amdtp_stream_running - check stream is running or not | |
195 | * @s: the AMDTP stream | |
196 | * | |
197 | * If this function returns true, the stream is running. | |
198 | */ | |
199 | static inline bool amdtp_stream_running(struct amdtp_stream *s) | |
20b65dd0 CL |
200 | { |
201 | return !IS_ERR(s->context); | |
202 | } | |
203 | ||
ec00f5e4 | 204 | /** |
be4a2894 TS |
205 | * amdtp_streaming_error - check for streaming error |
206 | * @s: the AMDTP stream | |
ec00f5e4 CL |
207 | * |
208 | * If this function returns true, the stream's packet queue has stopped due to | |
209 | * an asynchronous error. | |
210 | */ | |
be4a2894 | 211 | static inline bool amdtp_streaming_error(struct amdtp_stream *s) |
ec00f5e4 CL |
212 | { |
213 | return s->packet_index < 0; | |
214 | } | |
215 | ||
83d8d72d TS |
216 | /** |
217 | * amdtp_stream_pcm_running - check PCM substream is running or not | |
218 | * @s: the AMDTP stream | |
219 | * | |
220 | * If this function returns true, PCM substream in the AMDTP stream is running. | |
221 | */ | |
222 | static inline bool amdtp_stream_pcm_running(struct amdtp_stream *s) | |
223 | { | |
224 | return !!s->pcm; | |
225 | } | |
226 | ||
31ef9134 | 227 | /** |
be4a2894 TS |
228 | * amdtp_stream_pcm_trigger - start/stop playback from a PCM device |
229 | * @s: the AMDTP stream | |
31ef9134 CL |
230 | * @pcm: the PCM device to be started, or %NULL to stop the current device |
231 | * | |
232 | * Call this function on a running isochronous stream to enable the actual | |
233 | * transmission of PCM data. This function should be called from the PCM | |
234 | * device's .trigger callback. | |
235 | */ | |
be4a2894 TS |
236 | static inline void amdtp_stream_pcm_trigger(struct amdtp_stream *s, |
237 | struct snd_pcm_substream *pcm) | |
31ef9134 | 238 | { |
6aa7de05 | 239 | WRITE_ONCE(s->pcm, pcm); |
31ef9134 CL |
240 | } |
241 | ||
31ef9134 CL |
242 | static inline bool cip_sfc_is_base_44100(enum cip_sfc sfc) |
243 | { | |
244 | return sfc & 1; | |
245 | } | |
246 | ||
7b3b0d85 TS |
247 | /** |
248 | * amdtp_stream_wait_callback - sleep till callbacked or timeout | |
249 | * @s: the AMDTP stream | |
250 | * @timeout: msec till timeout | |
251 | * | |
252 | * If this function return false, the AMDTP stream should be stopped. | |
253 | */ | |
254 | static inline bool amdtp_stream_wait_callback(struct amdtp_stream *s, | |
255 | unsigned int timeout) | |
256 | { | |
257 | return wait_event_timeout(s->callback_wait, | |
258 | s->callbacked == true, | |
259 | msecs_to_jiffies(timeout)) > 0; | |
260 | } | |
261 | ||
31ef9134 | 262 | #endif |