1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef SOUND_FIREWIRE_AMDTP_H_INCLUDED 3 #define SOUND_FIREWIRE_AMDTP_H_INCLUDED 4 5 #include <linux/err.h> 6 #include <linux/interrupt.h> 7 #include <linux/mutex.h> 8 #include <linux/sched.h> 9 #include <sound/asound.h> 10 #include "packets-buffer.h" 11 12 /** 13 * enum cip_flags - describes details of the streaming protocol 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. 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. 21 * @CIP_EMPTY_WITH_TAG0: Only for in-stream. Empty in-packets have TAG0. 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. 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 * @CIP_SKIP_DBC_ZERO_CHECK: Only for in-stream. Packets with zero in dbc is 27 * skipped for detecting discontinuity. 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. 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. 33 * @CIP_HEADER_WITHOUT_EOH: Only for in-stream. CIP Header doesn't include 34 * valid EOH. 35 * @CIP_NO_HEADERS: a lack of headers in packets 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. 38 */ 39 enum cip_flags { 40 CIP_NONBLOCKING = 0x00, 41 CIP_BLOCKING = 0x01, 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, 46 CIP_EMPTY_HAS_WRONG_DBC = 0x20, 47 CIP_JUMBO_PAYLOAD = 0x40, 48 CIP_HEADER_WITHOUT_EOH = 0x80, 49 CIP_NO_HEADER = 0x100, 50 CIP_UNALIGHED_DBC = 0x200, 51 }; 52 53 /** 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. 75 */ 76 enum 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, 84 CIP_SFC_COUNT 85 }; 86 87 struct fw_unit; 88 struct fw_iso_context; 89 struct snd_pcm_substream; 90 struct snd_pcm_runtime; 91 92 enum amdtp_stream_direction { 93 AMDTP_OUT_STREAM = 0, 94 AMDTP_IN_STREAM 95 }; 96 97 struct 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 105 struct amdtp_stream; 106 typedef unsigned int (*amdtp_stream_process_ctx_payloads_t)( 107 struct amdtp_stream *s, 108 const struct pkt_desc *desc, 109 unsigned int packets, 110 struct snd_pcm_substream *pcm); 111 struct amdtp_stream { 112 struct fw_unit *unit; 113 enum cip_flags flags; 114 enum amdtp_stream_direction direction; 115 struct mutex mutex; 116 117 /* For packet processing. */ 118 struct fw_iso_context *context; 119 struct iso_packets_buffer buffer; 120 int packet_index; 121 struct pkt_desc *pkt_descs; 122 int tag; 123 union { 124 struct { 125 unsigned int ctx_header_size; 126 127 // limit for payload of iso packet. 128 unsigned int max_ctx_payload_length; 129 130 // For quirks of CIP headers. 131 // Fixed interval of dbc between previos/current 132 // packets. 133 unsigned int dbc_interval; 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; 144 int syt_override; 145 } rx; 146 } ctx_data; 147 148 /* For CIP headers. */ 149 unsigned int source_node_id_field; 150 unsigned int data_block_quadlets; 151 unsigned int data_block_counter; 152 unsigned int sph; 153 unsigned int fmt; 154 155 /* Internal flags. */ 156 enum cip_sfc sfc; 157 unsigned int syt_interval; 158 159 /* For a PCM substream processing. */ 160 struct snd_pcm_substream *pcm; 161 struct tasklet_struct period_tasklet; 162 snd_pcm_uframes_t pcm_buffer_pointer; 163 unsigned int pcm_period_pointer; 164 165 /* To wait for first packet. */ 166 bool callbacked; 167 wait_queue_head_t callback_wait; 168 u32 start_cycle; 169 170 /* For backends to process data blocks. */ 171 void *protocol; 172 amdtp_stream_process_ctx_payloads_t process_ctx_payloads; 173 }; 174 175 int amdtp_stream_init(struct amdtp_stream *s, struct fw_unit *unit, 176 enum amdtp_stream_direction dir, enum cip_flags flags, 177 unsigned int fmt, 178 amdtp_stream_process_ctx_payloads_t process_ctx_payloads, 179 unsigned int protocol_size); 180 void amdtp_stream_destroy(struct amdtp_stream *s); 181 182 int amdtp_stream_set_parameters(struct amdtp_stream *s, unsigned int rate, 183 unsigned int data_block_quadlets); 184 unsigned int amdtp_stream_get_max_payload(struct amdtp_stream *s); 185 186 int amdtp_stream_start(struct amdtp_stream *s, int channel, int speed); 187 void amdtp_stream_update(struct amdtp_stream *s); 188 void amdtp_stream_stop(struct amdtp_stream *s); 189 190 int amdtp_stream_add_pcm_hw_constraints(struct amdtp_stream *s, 191 struct snd_pcm_runtime *runtime); 192 193 void amdtp_stream_pcm_prepare(struct amdtp_stream *s); 194 unsigned long amdtp_stream_pcm_pointer(struct amdtp_stream *s); 195 int amdtp_stream_pcm_ack(struct amdtp_stream *s); 196 void amdtp_stream_pcm_abort(struct amdtp_stream *s); 197 198 extern const unsigned int amdtp_syt_intervals[CIP_SFC_COUNT]; 199 extern const unsigned int amdtp_rate_table[CIP_SFC_COUNT]; 200 201 /** 202 * amdtp_stream_running - check stream is running or not 203 * @s: the AMDTP stream 204 * 205 * If this function returns true, the stream is running. 206 */ 207 static inline bool amdtp_stream_running(struct amdtp_stream *s) 208 { 209 return !IS_ERR(s->context); 210 } 211 212 /** 213 * amdtp_streaming_error - check for streaming error 214 * @s: the AMDTP stream 215 * 216 * If this function returns true, the stream's packet queue has stopped due to 217 * an asynchronous error. 218 */ 219 static inline bool amdtp_streaming_error(struct amdtp_stream *s) 220 { 221 return s->packet_index < 0; 222 } 223 224 /** 225 * amdtp_stream_pcm_running - check PCM substream is running or not 226 * @s: the AMDTP stream 227 * 228 * If this function returns true, PCM substream in the AMDTP stream is running. 229 */ 230 static inline bool amdtp_stream_pcm_running(struct amdtp_stream *s) 231 { 232 return !!s->pcm; 233 } 234 235 /** 236 * amdtp_stream_pcm_trigger - start/stop playback from a PCM device 237 * @s: the AMDTP stream 238 * @pcm: the PCM device to be started, or %NULL to stop the current device 239 * 240 * Call this function on a running isochronous stream to enable the actual 241 * transmission of PCM data. This function should be called from the PCM 242 * device's .trigger callback. 243 */ 244 static inline void amdtp_stream_pcm_trigger(struct amdtp_stream *s, 245 struct snd_pcm_substream *pcm) 246 { 247 WRITE_ONCE(s->pcm, pcm); 248 } 249 250 static inline bool cip_sfc_is_base_44100(enum cip_sfc sfc) 251 { 252 return sfc & 1; 253 } 254 255 /** 256 * amdtp_stream_wait_callback - sleep till callbacked or timeout 257 * @s: the AMDTP stream 258 * @timeout: msec till timeout 259 * 260 * If this function return false, the AMDTP stream should be stopped. 261 */ 262 static inline bool amdtp_stream_wait_callback(struct amdtp_stream *s, 263 unsigned int timeout) 264 { 265 return wait_event_timeout(s->callback_wait, 266 s->callbacked == true, 267 msecs_to_jiffies(timeout)) > 0; 268 } 269 270 #endif 271