/* SPDX-License-Identifier: GPL-2.0 */ #ifndef SOUND_FIREWIRE_AMDTP_H_INCLUDED #define SOUND_FIREWIRE_AMDTP_H_INCLUDED #include <linux/err.h> #include <linux/interrupt.h> #include <linux/mutex.h> #include <linux/sched.h> #include <sound/asound.h> #include "packets-buffer.h" /** * enum cip_flags - describes details of the streaming protocol * @CIP_NONBLOCKING: In non-blocking mode, each packet contains * sample_rate/8000 samples, with rounding up or down to adjust * for clock skew and left-over fractional samples. This should * be used if supported by the device. * @CIP_BLOCKING: In blocking mode, each packet contains either zero or * SYT_INTERVAL samples, with these two types alternating so that * the overall sample rate comes out right. * @CIP_EMPTY_WITH_TAG0: Only for in-stream. Empty in-packets have TAG0. * @CIP_DBC_IS_END_EVENT: The value of dbc in an packet corresponds to the end * of event in the packet. Out of IEC 61883. * @CIP_WRONG_DBS: Only for in-stream. The value of dbs is wrong in in-packets. * The value of data_block_quadlets is used instead of reported value. * @CIP_SKIP_DBC_ZERO_CHECK: Only for in-stream. Packets with zero in dbc is * skipped for detecting discontinuity. * @CIP_EMPTY_HAS_WRONG_DBC: Only for in-stream. The value of dbc in empty * packet is wrong but the others are correct. * @CIP_JUMBO_PAYLOAD: Only for in-stream. The number of data blocks in an * packet is larger than IEC 61883-6 defines. Current implementation * allows 5 times as large as IEC 61883-6 defines. * @CIP_HEADER_WITHOUT_EOH: Only for in-stream. CIP Header doesn't include * valid EOH. * @CIP_NO_HEADERS: a lack of headers in packets * @CIP_UNALIGHED_DBC: Only for in-stream. The value of dbc is not alighed to * the value of current SYT_INTERVAL; e.g. initial value is not zero. * @CIP_UNAWARE_SYT: For outgoing packet, the value in SYT field of CIP is 0xffff. * For incoming packet, the value in SYT field of CIP is not handled. * @CIP_DBC_IS_PAYLOAD_QUADLETS: Available for incoming packet, and only effective with * CIP_DBC_IS_END_EVENT flag. The value of dbc field is the number of accumulated quadlets * in CIP payload, instead of the number of accumulated data blocks. */ enum cip_flags { … }; /** * enum cip_sfc - supported Sampling Frequency Codes (SFCs) * @CIP_SFC_32000: 32,000 data blocks * @CIP_SFC_44100: 44,100 data blocks * @CIP_SFC_48000: 48,000 data blocks * @CIP_SFC_88200: 88,200 data blocks * @CIP_SFC_96000: 96,000 data blocks * @CIP_SFC_176400: 176,400 data blocks * @CIP_SFC_192000: 192,000 data blocks * @CIP_SFC_COUNT: the number of supported SFCs * * These values are used to show nominal Sampling Frequency Code in * Format Dependent Field (FDF) of AMDTP packet header. In IEC 61883-6:2002, * this code means the number of events per second. Actually the code * represents the number of data blocks transferred per second in an AMDTP * stream. * * In IEC 61883-6:2005, some extensions were added to support more types of * data such as 'One Bit LInear Audio', therefore the meaning of SFC became * different depending on the types. * * Currently our implementation is compatible with IEC 61883-6:2002. */ enum cip_sfc { … }; struct fw_unit; struct fw_iso_context; struct snd_pcm_substream; struct snd_pcm_runtime; enum amdtp_stream_direction { … }; struct pkt_desc { … }; struct amdtp_stream; amdtp_stream_process_ctx_payloads_t; struct amdtp_domain; struct amdtp_stream { … }; int amdtp_stream_init(struct amdtp_stream *s, struct fw_unit *unit, enum amdtp_stream_direction dir, unsigned int flags, unsigned int fmt, amdtp_stream_process_ctx_payloads_t process_ctx_payloads, unsigned int protocol_size); void amdtp_stream_destroy(struct amdtp_stream *s); int amdtp_stream_set_parameters(struct amdtp_stream *s, unsigned int rate, unsigned int data_block_quadlets, unsigned int pcm_frame_multiplier); unsigned int amdtp_stream_get_max_payload(struct amdtp_stream *s); void amdtp_stream_update(struct amdtp_stream *s); int amdtp_stream_add_pcm_hw_constraints(struct amdtp_stream *s, struct snd_pcm_runtime *runtime); void amdtp_stream_pcm_prepare(struct amdtp_stream *s); void amdtp_stream_pcm_abort(struct amdtp_stream *s); extern const unsigned int amdtp_syt_intervals[CIP_SFC_COUNT]; extern const unsigned int amdtp_rate_table[CIP_SFC_COUNT]; /** * amdtp_stream_running - check stream is running or not * @s: the AMDTP stream * * If this function returns true, the stream is running. */ static inline bool amdtp_stream_running(struct amdtp_stream *s) { … } /** * amdtp_streaming_error - check for streaming error * @s: the AMDTP stream * * If this function returns true, the stream's packet queue has stopped due to * an asynchronous error. */ static inline bool amdtp_streaming_error(struct amdtp_stream *s) { … } /** * amdtp_stream_pcm_running - check PCM substream is running or not * @s: the AMDTP stream * * If this function returns true, PCM substream in the AMDTP stream is running. */ static inline bool amdtp_stream_pcm_running(struct amdtp_stream *s) { … } /** * amdtp_stream_pcm_trigger - start/stop playback from a PCM device * @s: the AMDTP stream * @pcm: the PCM device to be started, or %NULL to stop the current device * * Call this function on a running isochronous stream to enable the actual * transmission of PCM data. This function should be called from the PCM * device's .trigger callback. */ static inline void amdtp_stream_pcm_trigger(struct amdtp_stream *s, struct snd_pcm_substream *pcm) { … } /** * amdtp_stream_next_packet_desc - retrieve next descriptor for amdtp packet. * @s: the AMDTP stream * @desc: the descriptor of packet * * This macro computes next descriptor so that the list of descriptors behaves circular queue. */ #define amdtp_stream_next_packet_desc(s, desc) … static inline bool cip_sfc_is_base_44100(enum cip_sfc sfc) { … } struct seq_desc { … }; struct amdtp_domain { … }; int amdtp_domain_init(struct amdtp_domain *d); void amdtp_domain_destroy(struct amdtp_domain *d); int amdtp_domain_add_stream(struct amdtp_domain *d, struct amdtp_stream *s, int channel, int speed); int amdtp_domain_start(struct amdtp_domain *d, unsigned int tx_init_skip_cycles, bool replay_seq, bool replay_on_the_fly); void amdtp_domain_stop(struct amdtp_domain *d); static inline int amdtp_domain_set_events_per_period(struct amdtp_domain *d, unsigned int events_per_period, unsigned int events_per_buffer) { … } unsigned long amdtp_domain_stream_pcm_pointer(struct amdtp_domain *d, struct amdtp_stream *s); int amdtp_domain_stream_pcm_ack(struct amdtp_domain *d, struct amdtp_stream *s); /** * amdtp_domain_wait_ready - sleep till being ready to process packets or timeout * @d: the AMDTP domain * @timeout_ms: msec till timeout * * If this function return false, the AMDTP domain should be stopped. */ static inline bool amdtp_domain_wait_ready(struct amdtp_domain *d, unsigned int timeout_ms) { … } #endif
Codebase Browser
linux