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 * @CIP_UNAWARE_SYT: For outgoing packet, the value in SYT field of CIP is 0xffff. 39 * For incoming packet, the value in SYT field of CIP is not handled. 40 */ 41 enum cip_flags { 42 CIP_NONBLOCKING = 0x00, 43 CIP_BLOCKING = 0x01, 44 CIP_EMPTY_WITH_TAG0 = 0x02, 45 CIP_DBC_IS_END_EVENT = 0x04, 46 CIP_WRONG_DBS = 0x08, 47 CIP_SKIP_DBC_ZERO_CHECK = 0x10, 48 CIP_EMPTY_HAS_WRONG_DBC = 0x20, 49 CIP_JUMBO_PAYLOAD = 0x40, 50 CIP_HEADER_WITHOUT_EOH = 0x80, 51 CIP_NO_HEADER = 0x100, 52 CIP_UNALIGHED_DBC = 0x200, 53 CIP_UNAWARE_SYT = 0x400, 54 }; 55 56 /** 57 * enum cip_sfc - supported Sampling Frequency Codes (SFCs) 58 * @CIP_SFC_32000: 32,000 data blocks 59 * @CIP_SFC_44100: 44,100 data blocks 60 * @CIP_SFC_48000: 48,000 data blocks 61 * @CIP_SFC_88200: 88,200 data blocks 62 * @CIP_SFC_96000: 96,000 data blocks 63 * @CIP_SFC_176400: 176,400 data blocks 64 * @CIP_SFC_192000: 192,000 data blocks 65 * @CIP_SFC_COUNT: the number of supported SFCs 66 * 67 * These values are used to show nominal Sampling Frequency Code in 68 * Format Dependent Field (FDF) of AMDTP packet header. In IEC 61883-6:2002, 69 * this code means the number of events per second. Actually the code 70 * represents the number of data blocks transferred per second in an AMDTP 71 * stream. 72 * 73 * In IEC 61883-6:2005, some extensions were added to support more types of 74 * data such as 'One Bit LInear Audio', therefore the meaning of SFC became 75 * different depending on the types. 76 * 77 * Currently our implementation is compatible with IEC 61883-6:2002. 78 */ 79 enum cip_sfc { 80 CIP_SFC_32000 = 0, 81 CIP_SFC_44100 = 1, 82 CIP_SFC_48000 = 2, 83 CIP_SFC_88200 = 3, 84 CIP_SFC_96000 = 4, 85 CIP_SFC_176400 = 5, 86 CIP_SFC_192000 = 6, 87 CIP_SFC_COUNT 88 }; 89 90 struct fw_unit; 91 struct fw_iso_context; 92 struct snd_pcm_substream; 93 struct snd_pcm_runtime; 94 95 enum amdtp_stream_direction { 96 AMDTP_OUT_STREAM = 0, 97 AMDTP_IN_STREAM 98 }; 99 100 struct pkt_desc { 101 u32 cycle; 102 u32 syt; 103 unsigned int data_blocks; 104 unsigned int data_block_counter; 105 __be32 *ctx_payload; 106 }; 107 108 struct amdtp_stream; 109 typedef unsigned int (*amdtp_stream_process_ctx_payloads_t)( 110 struct amdtp_stream *s, 111 const struct pkt_desc *desc, 112 unsigned int packets, 113 struct snd_pcm_substream *pcm); 114 115 struct amdtp_domain; 116 struct amdtp_stream { 117 struct fw_unit *unit; 118 // The combination of cip_flags enumeration-constants. 119 unsigned int flags; 120 enum amdtp_stream_direction direction; 121 struct mutex mutex; 122 123 /* For packet processing. */ 124 struct fw_iso_context *context; 125 struct iso_packets_buffer buffer; 126 unsigned int queue_size; 127 int packet_index; 128 struct pkt_desc *pkt_descs; 129 int tag; 130 union { 131 struct { 132 unsigned int ctx_header_size; 133 134 // limit for payload of iso packet. 135 unsigned int max_ctx_payload_length; 136 137 // For quirks of CIP headers. 138 // Fixed interval of dbc between previos/current 139 // packets. 140 unsigned int dbc_interval; 141 142 // The device starts multiplexing events to the packet. 143 bool event_starts; 144 145 struct { 146 struct seq_desc *descs; 147 unsigned int size; 148 unsigned int tail; 149 } cache; 150 } tx; 151 struct { 152 // To generate CIP header. 153 unsigned int fdf; 154 155 // To generate constant hardware IRQ. 156 unsigned int event_count; 157 158 // To calculate CIP data blocks and tstamp. 159 struct { 160 struct seq_desc *descs; 161 unsigned int size; 162 unsigned int tail; 163 unsigned int head; 164 } seq; 165 166 unsigned int data_block_state; 167 unsigned int syt_offset_state; 168 unsigned int last_syt_offset; 169 } rx; 170 } ctx_data; 171 172 /* For CIP headers. */ 173 unsigned int source_node_id_field; 174 unsigned int data_block_quadlets; 175 unsigned int data_block_counter; 176 unsigned int sph; 177 unsigned int fmt; 178 179 // Internal flags. 180 unsigned int transfer_delay; 181 enum cip_sfc sfc; 182 unsigned int syt_interval; 183 184 /* For a PCM substream processing. */ 185 struct snd_pcm_substream *pcm; 186 struct work_struct period_work; 187 snd_pcm_uframes_t pcm_buffer_pointer; 188 unsigned int pcm_period_pointer; 189 190 // To start processing content of packets at the same cycle in several contexts for 191 // each direction. 192 bool ready_processing; 193 wait_queue_head_t ready_wait; 194 unsigned int next_cycle; 195 196 /* For backends to process data blocks. */ 197 void *protocol; 198 amdtp_stream_process_ctx_payloads_t process_ctx_payloads; 199 200 // For domain. 201 int channel; 202 int speed; 203 struct list_head list; 204 struct amdtp_domain *domain; 205 }; 206 207 int amdtp_stream_init(struct amdtp_stream *s, struct fw_unit *unit, 208 enum amdtp_stream_direction dir, unsigned int flags, 209 unsigned int fmt, 210 amdtp_stream_process_ctx_payloads_t process_ctx_payloads, 211 unsigned int protocol_size); 212 void amdtp_stream_destroy(struct amdtp_stream *s); 213 214 int amdtp_stream_set_parameters(struct amdtp_stream *s, unsigned int rate, 215 unsigned int data_block_quadlets); 216 unsigned int amdtp_stream_get_max_payload(struct amdtp_stream *s); 217 218 void amdtp_stream_update(struct amdtp_stream *s); 219 220 int amdtp_stream_add_pcm_hw_constraints(struct amdtp_stream *s, 221 struct snd_pcm_runtime *runtime); 222 223 void amdtp_stream_pcm_prepare(struct amdtp_stream *s); 224 void amdtp_stream_pcm_abort(struct amdtp_stream *s); 225 226 extern const unsigned int amdtp_syt_intervals[CIP_SFC_COUNT]; 227 extern const unsigned int amdtp_rate_table[CIP_SFC_COUNT]; 228 229 /** 230 * amdtp_stream_running - check stream is running or not 231 * @s: the AMDTP stream 232 * 233 * If this function returns true, the stream is running. 234 */ 235 static inline bool amdtp_stream_running(struct amdtp_stream *s) 236 { 237 return !IS_ERR(s->context); 238 } 239 240 /** 241 * amdtp_streaming_error - check for streaming error 242 * @s: the AMDTP stream 243 * 244 * If this function returns true, the stream's packet queue has stopped due to 245 * an asynchronous error. 246 */ 247 static inline bool amdtp_streaming_error(struct amdtp_stream *s) 248 { 249 return s->packet_index < 0; 250 } 251 252 /** 253 * amdtp_stream_pcm_running - check PCM substream is running or not 254 * @s: the AMDTP stream 255 * 256 * If this function returns true, PCM substream in the AMDTP stream is running. 257 */ 258 static inline bool amdtp_stream_pcm_running(struct amdtp_stream *s) 259 { 260 return !!s->pcm; 261 } 262 263 /** 264 * amdtp_stream_pcm_trigger - start/stop playback from a PCM device 265 * @s: the AMDTP stream 266 * @pcm: the PCM device to be started, or %NULL to stop the current device 267 * 268 * Call this function on a running isochronous stream to enable the actual 269 * transmission of PCM data. This function should be called from the PCM 270 * device's .trigger callback. 271 */ 272 static inline void amdtp_stream_pcm_trigger(struct amdtp_stream *s, 273 struct snd_pcm_substream *pcm) 274 { 275 WRITE_ONCE(s->pcm, pcm); 276 } 277 278 static inline bool cip_sfc_is_base_44100(enum cip_sfc sfc) 279 { 280 return sfc & 1; 281 } 282 283 struct seq_desc { 284 unsigned int syt_offset; 285 unsigned int data_blocks; 286 }; 287 288 struct amdtp_domain { 289 struct list_head streams; 290 291 unsigned int events_per_period; 292 unsigned int events_per_buffer; 293 294 struct amdtp_stream *irq_target; 295 296 struct { 297 unsigned int tx_init_skip; 298 unsigned int tx_start; 299 unsigned int rx_start; 300 } processing_cycle; 301 302 struct { 303 bool enable; 304 } replay; 305 }; 306 307 int amdtp_domain_init(struct amdtp_domain *d); 308 void amdtp_domain_destroy(struct amdtp_domain *d); 309 310 int amdtp_domain_add_stream(struct amdtp_domain *d, struct amdtp_stream *s, 311 int channel, int speed); 312 313 int amdtp_domain_start(struct amdtp_domain *d, unsigned int tx_init_skip_cycles, bool replay_seq); 314 void amdtp_domain_stop(struct amdtp_domain *d); 315 316 static inline int amdtp_domain_set_events_per_period(struct amdtp_domain *d, 317 unsigned int events_per_period, 318 unsigned int events_per_buffer) 319 { 320 d->events_per_period = events_per_period; 321 d->events_per_buffer = events_per_buffer; 322 323 return 0; 324 } 325 326 unsigned long amdtp_domain_stream_pcm_pointer(struct amdtp_domain *d, 327 struct amdtp_stream *s); 328 int amdtp_domain_stream_pcm_ack(struct amdtp_domain *d, struct amdtp_stream *s); 329 330 /** 331 * amdtp_domain_wait_ready - sleep till being ready to process packets or timeout 332 * @d: the AMDTP domain 333 * @timeout_ms: msec till timeout 334 * 335 * If this function return false, the AMDTP domain should be stopped. 336 */ 337 static inline bool amdtp_domain_wait_ready(struct amdtp_domain *d, unsigned int timeout_ms) 338 { 339 struct amdtp_stream *s; 340 341 list_for_each_entry(s, &d->streams, list) { 342 unsigned int j = msecs_to_jiffies(timeout_ms); 343 344 if (wait_event_interruptible_timeout(s->ready_wait, s->ready_processing, j) <= 0) 345 return false; 346 } 347 348 return true; 349 } 350 351 #endif 352