1b2441318SGreg Kroah-Hartman /* SPDX-License-Identifier: GPL-2.0 */ 2d67c46b9STakashi Sakamoto #ifndef SOUND_FIREWIRE_AMDTP_H_INCLUDED 3d67c46b9STakashi Sakamoto #define SOUND_FIREWIRE_AMDTP_H_INCLUDED 4d67c46b9STakashi Sakamoto 5d67c46b9STakashi Sakamoto #include <linux/err.h> 6d67c46b9STakashi Sakamoto #include <linux/interrupt.h> 7d67c46b9STakashi Sakamoto #include <linux/mutex.h> 85955815eSTakashi Sakamoto #include <linux/sched.h> 9d67c46b9STakashi Sakamoto #include <sound/asound.h> 10d67c46b9STakashi Sakamoto #include "packets-buffer.h" 11d67c46b9STakashi Sakamoto 12d67c46b9STakashi Sakamoto /** 13d67c46b9STakashi Sakamoto * enum cip_flags - describes details of the streaming protocol 14d67c46b9STakashi Sakamoto * @CIP_NONBLOCKING: In non-blocking mode, each packet contains 15d67c46b9STakashi Sakamoto * sample_rate/8000 samples, with rounding up or down to adjust 16d67c46b9STakashi Sakamoto * for clock skew and left-over fractional samples. This should 17d67c46b9STakashi Sakamoto * be used if supported by the device. 18d67c46b9STakashi Sakamoto * @CIP_BLOCKING: In blocking mode, each packet contains either zero or 19d67c46b9STakashi Sakamoto * SYT_INTERVAL samples, with these two types alternating so that 20d67c46b9STakashi Sakamoto * the overall sample rate comes out right. 21d67c46b9STakashi Sakamoto * @CIP_EMPTY_WITH_TAG0: Only for in-stream. Empty in-packets have TAG0. 229dae017bSTakashi Sakamoto * @CIP_DBC_IS_END_EVENT: The value of dbc in an packet corresponds to the end 239dae017bSTakashi Sakamoto * of event in the packet. Out of IEC 61883. 24d67c46b9STakashi Sakamoto * @CIP_WRONG_DBS: Only for in-stream. The value of dbs is wrong in in-packets. 25d67c46b9STakashi Sakamoto * The value of data_block_quadlets is used instead of reported value. 26d67c46b9STakashi Sakamoto * @CIP_SKIP_DBC_ZERO_CHECK: Only for in-stream. Packets with zero in dbc is 27d67c46b9STakashi Sakamoto * skipped for detecting discontinuity. 28d67c46b9STakashi Sakamoto * @CIP_EMPTY_HAS_WRONG_DBC: Only for in-stream. The value of dbc in empty 29d67c46b9STakashi Sakamoto * packet is wrong but the others are correct. 30d67c46b9STakashi Sakamoto * @CIP_JUMBO_PAYLOAD: Only for in-stream. The number of data blocks in an 31d67c46b9STakashi Sakamoto * packet is larger than IEC 61883-6 defines. Current implementation 32d67c46b9STakashi Sakamoto * allows 5 times as large as IEC 61883-6 defines. 332128f78fSTakashi Sakamoto * @CIP_HEADER_WITHOUT_EOH: Only for in-stream. CIP Header doesn't include 342128f78fSTakashi Sakamoto * valid EOH. 353b196c39STakashi Sakamoto * @CIP_NO_HEADERS: a lack of headers in packets 36d67c46b9STakashi Sakamoto */ 37d67c46b9STakashi Sakamoto enum cip_flags { 38d67c46b9STakashi Sakamoto CIP_NONBLOCKING = 0x00, 39d67c46b9STakashi Sakamoto CIP_BLOCKING = 0x01, 40dec63cc8STakashi Sakamoto CIP_EMPTY_WITH_TAG0 = 0x02, 41dec63cc8STakashi Sakamoto CIP_DBC_IS_END_EVENT = 0x04, 42dec63cc8STakashi Sakamoto CIP_WRONG_DBS = 0x08, 43dec63cc8STakashi Sakamoto CIP_SKIP_DBC_ZERO_CHECK = 0x10, 4462f00e40STakashi Sakamoto CIP_EMPTY_HAS_WRONG_DBC = 0x20, 4562f00e40STakashi Sakamoto CIP_JUMBO_PAYLOAD = 0x40, 462128f78fSTakashi Sakamoto CIP_HEADER_WITHOUT_EOH = 0x80, 473b196c39STakashi Sakamoto CIP_NO_HEADER = 0x100, 48d67c46b9STakashi Sakamoto }; 49d67c46b9STakashi Sakamoto 50d67c46b9STakashi Sakamoto /** 51d67c46b9STakashi Sakamoto * enum cip_sfc - supported Sampling Frequency Codes (SFCs) 52d67c46b9STakashi Sakamoto * @CIP_SFC_32000: 32,000 data blocks 53d67c46b9STakashi Sakamoto * @CIP_SFC_44100: 44,100 data blocks 54d67c46b9STakashi Sakamoto * @CIP_SFC_48000: 48,000 data blocks 55d67c46b9STakashi Sakamoto * @CIP_SFC_88200: 88,200 data blocks 56d67c46b9STakashi Sakamoto * @CIP_SFC_96000: 96,000 data blocks 57d67c46b9STakashi Sakamoto * @CIP_SFC_176400: 176,400 data blocks 58d67c46b9STakashi Sakamoto * @CIP_SFC_192000: 192,000 data blocks 59d67c46b9STakashi Sakamoto * @CIP_SFC_COUNT: the number of supported SFCs 60d67c46b9STakashi Sakamoto * 61d67c46b9STakashi Sakamoto * These values are used to show nominal Sampling Frequency Code in 62d67c46b9STakashi Sakamoto * Format Dependent Field (FDF) of AMDTP packet header. In IEC 61883-6:2002, 63d67c46b9STakashi Sakamoto * this code means the number of events per second. Actually the code 64d67c46b9STakashi Sakamoto * represents the number of data blocks transferred per second in an AMDTP 65d67c46b9STakashi Sakamoto * stream. 66d67c46b9STakashi Sakamoto * 67d67c46b9STakashi Sakamoto * In IEC 61883-6:2005, some extensions were added to support more types of 68d67c46b9STakashi Sakamoto * data such as 'One Bit LInear Audio', therefore the meaning of SFC became 69d67c46b9STakashi Sakamoto * different depending on the types. 70d67c46b9STakashi Sakamoto * 71d67c46b9STakashi Sakamoto * Currently our implementation is compatible with IEC 61883-6:2002. 72d67c46b9STakashi Sakamoto */ 73d67c46b9STakashi Sakamoto enum cip_sfc { 74d67c46b9STakashi Sakamoto CIP_SFC_32000 = 0, 75d67c46b9STakashi Sakamoto CIP_SFC_44100 = 1, 76d67c46b9STakashi Sakamoto CIP_SFC_48000 = 2, 77d67c46b9STakashi Sakamoto CIP_SFC_88200 = 3, 78d67c46b9STakashi Sakamoto CIP_SFC_96000 = 4, 79d67c46b9STakashi Sakamoto CIP_SFC_176400 = 5, 80d67c46b9STakashi Sakamoto CIP_SFC_192000 = 6, 81d67c46b9STakashi Sakamoto CIP_SFC_COUNT 82d67c46b9STakashi Sakamoto }; 83d67c46b9STakashi Sakamoto 84d67c46b9STakashi Sakamoto struct fw_unit; 85d67c46b9STakashi Sakamoto struct fw_iso_context; 86d67c46b9STakashi Sakamoto struct snd_pcm_substream; 87d67c46b9STakashi Sakamoto struct snd_pcm_runtime; 88d67c46b9STakashi Sakamoto 89d67c46b9STakashi Sakamoto enum amdtp_stream_direction { 90d67c46b9STakashi Sakamoto AMDTP_OUT_STREAM = 0, 91d67c46b9STakashi Sakamoto AMDTP_IN_STREAM 92d67c46b9STakashi Sakamoto }; 93d67c46b9STakashi Sakamoto 94df075feeSTakashi Sakamoto struct amdtp_stream; 95df075feeSTakashi Sakamoto typedef unsigned int (*amdtp_stream_process_data_blocks_t)( 96df075feeSTakashi Sakamoto struct amdtp_stream *s, 97df075feeSTakashi Sakamoto __be32 *buffer, 98df075feeSTakashi Sakamoto unsigned int data_blocks, 99df075feeSTakashi Sakamoto unsigned int *syt); 100d67c46b9STakashi Sakamoto struct amdtp_stream { 101d67c46b9STakashi Sakamoto struct fw_unit *unit; 102d67c46b9STakashi Sakamoto enum cip_flags flags; 103d67c46b9STakashi Sakamoto enum amdtp_stream_direction direction; 104d67c46b9STakashi Sakamoto struct mutex mutex; 105d67c46b9STakashi Sakamoto 106d67c46b9STakashi Sakamoto /* For packet processing. */ 107d67c46b9STakashi Sakamoto struct fw_iso_context *context; 108d67c46b9STakashi Sakamoto struct iso_packets_buffer buffer; 109d67c46b9STakashi Sakamoto int packet_index; 1103b196c39STakashi Sakamoto int tag; 1113b196c39STakashi Sakamoto int (*handle_packet)(struct amdtp_stream *s, 1123b196c39STakashi Sakamoto unsigned int payload_quadlets, unsigned int cycle, 1133b196c39STakashi Sakamoto unsigned int index); 114d3d10a4aSTakashi Sakamoto union { 115d3d10a4aSTakashi Sakamoto struct { 116d3d10a4aSTakashi Sakamoto unsigned int ctx_header_size; 117d3d10a4aSTakashi Sakamoto 118d3d10a4aSTakashi Sakamoto // limit for payload of iso packet. 119f91c9d76STakashi Sakamoto unsigned int max_payload_length; 120d67c46b9STakashi Sakamoto 121d3d10a4aSTakashi Sakamoto // For quirks of CIP headers. 122d3d10a4aSTakashi Sakamoto // Fixed interval of dbc between previos/current 123d3d10a4aSTakashi Sakamoto // packets. 124d3d10a4aSTakashi Sakamoto unsigned int dbc_interval; 125d3d10a4aSTakashi Sakamoto // Indicate the value of dbc field in a first packet. 126d3d10a4aSTakashi Sakamoto unsigned int first_dbc; 127d3d10a4aSTakashi Sakamoto } tx; 128d3d10a4aSTakashi Sakamoto struct { 129d3d10a4aSTakashi Sakamoto // To calculate CIP data blocks and tstamp. 130d3d10a4aSTakashi Sakamoto unsigned int transfer_delay; 131d3d10a4aSTakashi Sakamoto unsigned int data_block_state; 132d3d10a4aSTakashi Sakamoto unsigned int last_syt_offset; 133d3d10a4aSTakashi Sakamoto unsigned int syt_offset_state; 134d3d10a4aSTakashi Sakamoto 135d3d10a4aSTakashi Sakamoto // To generate CIP header. 136d3d10a4aSTakashi Sakamoto unsigned int fdf; 137d3d10a4aSTakashi Sakamoto } rx; 138d3d10a4aSTakashi Sakamoto } ctx_data; 139d3d10a4aSTakashi Sakamoto 140d67c46b9STakashi Sakamoto /* For CIP headers. */ 141d67c46b9STakashi Sakamoto unsigned int source_node_id_field; 142d67c46b9STakashi Sakamoto unsigned int data_block_quadlets; 143d67c46b9STakashi Sakamoto unsigned int data_block_counter; 1449863874fSTakashi Sakamoto unsigned int sph; 145d67c46b9STakashi Sakamoto unsigned int fmt; 146d67c46b9STakashi Sakamoto 147d67c46b9STakashi Sakamoto /* Internal flags. */ 148d67c46b9STakashi Sakamoto enum cip_sfc sfc; 149d67c46b9STakashi Sakamoto unsigned int syt_interval; 150d67c46b9STakashi Sakamoto 151d67c46b9STakashi Sakamoto /* For a PCM substream processing. */ 152d67c46b9STakashi Sakamoto struct snd_pcm_substream *pcm; 153d67c46b9STakashi Sakamoto struct tasklet_struct period_tasklet; 1544a9bfafcSTakashi Sakamoto snd_pcm_uframes_t pcm_buffer_pointer; 155d67c46b9STakashi Sakamoto unsigned int pcm_period_pointer; 156d67c46b9STakashi Sakamoto 157d67c46b9STakashi Sakamoto /* To wait for first packet. */ 158d67c46b9STakashi Sakamoto bool callbacked; 159d67c46b9STakashi Sakamoto wait_queue_head_t callback_wait; 160a04513f8STakashi Sakamoto u32 start_cycle; 161d67c46b9STakashi Sakamoto 162df075feeSTakashi Sakamoto /* For backends to process data blocks. */ 163df075feeSTakashi Sakamoto void *protocol; 164df075feeSTakashi Sakamoto amdtp_stream_process_data_blocks_t process_data_blocks; 165d67c46b9STakashi Sakamoto }; 166d67c46b9STakashi Sakamoto 167d67c46b9STakashi Sakamoto int amdtp_stream_init(struct amdtp_stream *s, struct fw_unit *unit, 168df075feeSTakashi Sakamoto enum amdtp_stream_direction dir, enum cip_flags flags, 169df075feeSTakashi Sakamoto unsigned int fmt, 170df075feeSTakashi Sakamoto amdtp_stream_process_data_blocks_t process_data_blocks, 171df075feeSTakashi Sakamoto unsigned int protocol_size); 172d67c46b9STakashi Sakamoto void amdtp_stream_destroy(struct amdtp_stream *s); 173d67c46b9STakashi Sakamoto 174df075feeSTakashi Sakamoto int amdtp_stream_set_parameters(struct amdtp_stream *s, unsigned int rate, 175df075feeSTakashi Sakamoto unsigned int data_block_quadlets); 176d67c46b9STakashi Sakamoto unsigned int amdtp_stream_get_max_payload(struct amdtp_stream *s); 177d67c46b9STakashi Sakamoto 178d67c46b9STakashi Sakamoto int amdtp_stream_start(struct amdtp_stream *s, int channel, int speed); 179d67c46b9STakashi Sakamoto void amdtp_stream_update(struct amdtp_stream *s); 180d67c46b9STakashi Sakamoto void amdtp_stream_stop(struct amdtp_stream *s); 181d67c46b9STakashi Sakamoto 182d67c46b9STakashi Sakamoto int amdtp_stream_add_pcm_hw_constraints(struct amdtp_stream *s, 183d67c46b9STakashi Sakamoto struct snd_pcm_runtime *runtime); 184df075feeSTakashi Sakamoto 185d67c46b9STakashi Sakamoto void amdtp_stream_pcm_prepare(struct amdtp_stream *s); 186d67c46b9STakashi Sakamoto unsigned long amdtp_stream_pcm_pointer(struct amdtp_stream *s); 187875becf8STakashi Sakamoto int amdtp_stream_pcm_ack(struct amdtp_stream *s); 188d67c46b9STakashi Sakamoto void amdtp_stream_pcm_abort(struct amdtp_stream *s); 189d67c46b9STakashi Sakamoto 190d67c46b9STakashi Sakamoto extern const unsigned int amdtp_syt_intervals[CIP_SFC_COUNT]; 191d67c46b9STakashi Sakamoto extern const unsigned int amdtp_rate_table[CIP_SFC_COUNT]; 192d67c46b9STakashi Sakamoto 193d67c46b9STakashi Sakamoto /** 194d67c46b9STakashi Sakamoto * amdtp_stream_running - check stream is running or not 195d67c46b9STakashi Sakamoto * @s: the AMDTP stream 196d67c46b9STakashi Sakamoto * 197d67c46b9STakashi Sakamoto * If this function returns true, the stream is running. 198d67c46b9STakashi Sakamoto */ 199d67c46b9STakashi Sakamoto static inline bool amdtp_stream_running(struct amdtp_stream *s) 200d67c46b9STakashi Sakamoto { 201d67c46b9STakashi Sakamoto return !IS_ERR(s->context); 202d67c46b9STakashi Sakamoto } 203d67c46b9STakashi Sakamoto 204d67c46b9STakashi Sakamoto /** 205d67c46b9STakashi Sakamoto * amdtp_streaming_error - check for streaming error 206d67c46b9STakashi Sakamoto * @s: the AMDTP stream 207d67c46b9STakashi Sakamoto * 208d67c46b9STakashi Sakamoto * If this function returns true, the stream's packet queue has stopped due to 209d67c46b9STakashi Sakamoto * an asynchronous error. 210d67c46b9STakashi Sakamoto */ 211d67c46b9STakashi Sakamoto static inline bool amdtp_streaming_error(struct amdtp_stream *s) 212d67c46b9STakashi Sakamoto { 213d67c46b9STakashi Sakamoto return s->packet_index < 0; 214d67c46b9STakashi Sakamoto } 215d67c46b9STakashi Sakamoto 216d67c46b9STakashi Sakamoto /** 217d67c46b9STakashi Sakamoto * amdtp_stream_pcm_running - check PCM substream is running or not 218d67c46b9STakashi Sakamoto * @s: the AMDTP stream 219d67c46b9STakashi Sakamoto * 220d67c46b9STakashi Sakamoto * If this function returns true, PCM substream in the AMDTP stream is running. 221d67c46b9STakashi Sakamoto */ 222d67c46b9STakashi Sakamoto static inline bool amdtp_stream_pcm_running(struct amdtp_stream *s) 223d67c46b9STakashi Sakamoto { 224d67c46b9STakashi Sakamoto return !!s->pcm; 225d67c46b9STakashi Sakamoto } 226d67c46b9STakashi Sakamoto 227d67c46b9STakashi Sakamoto /** 228d67c46b9STakashi Sakamoto * amdtp_stream_pcm_trigger - start/stop playback from a PCM device 229d67c46b9STakashi Sakamoto * @s: the AMDTP stream 230d67c46b9STakashi Sakamoto * @pcm: the PCM device to be started, or %NULL to stop the current device 231d67c46b9STakashi Sakamoto * 232d67c46b9STakashi Sakamoto * Call this function on a running isochronous stream to enable the actual 233d67c46b9STakashi Sakamoto * transmission of PCM data. This function should be called from the PCM 234d67c46b9STakashi Sakamoto * device's .trigger callback. 235d67c46b9STakashi Sakamoto */ 236d67c46b9STakashi Sakamoto static inline void amdtp_stream_pcm_trigger(struct amdtp_stream *s, 237d67c46b9STakashi Sakamoto struct snd_pcm_substream *pcm) 238d67c46b9STakashi Sakamoto { 2396aa7de05SMark Rutland WRITE_ONCE(s->pcm, pcm); 240d67c46b9STakashi Sakamoto } 241d67c46b9STakashi Sakamoto 242d67c46b9STakashi Sakamoto static inline bool cip_sfc_is_base_44100(enum cip_sfc sfc) 243d67c46b9STakashi Sakamoto { 244d67c46b9STakashi Sakamoto return sfc & 1; 245d67c46b9STakashi Sakamoto } 246d67c46b9STakashi Sakamoto 247d67c46b9STakashi Sakamoto /** 248d67c46b9STakashi Sakamoto * amdtp_stream_wait_callback - sleep till callbacked or timeout 249d67c46b9STakashi Sakamoto * @s: the AMDTP stream 250d67c46b9STakashi Sakamoto * @timeout: msec till timeout 251d67c46b9STakashi Sakamoto * 252d67c46b9STakashi Sakamoto * If this function return false, the AMDTP stream should be stopped. 253d67c46b9STakashi Sakamoto */ 254d67c46b9STakashi Sakamoto static inline bool amdtp_stream_wait_callback(struct amdtp_stream *s, 255d67c46b9STakashi Sakamoto unsigned int timeout) 256d67c46b9STakashi Sakamoto { 257d67c46b9STakashi Sakamoto return wait_event_timeout(s->callback_wait, 258d67c46b9STakashi Sakamoto s->callbacked == true, 259d67c46b9STakashi Sakamoto msecs_to_jiffies(timeout)) > 0; 260d67c46b9STakashi Sakamoto } 261d67c46b9STakashi Sakamoto 262d67c46b9STakashi Sakamoto #endif 263