// SPDX-License-Identifier: GPL-2.0-only /* * Audio and Music Data Transmission Protocol (IEC 61883-6) streams * with Common Isochronous Packet (IEC 61883-1) headers * * Copyright (c) Clemens Ladisch <[email protected]> */ #include <linux/device.h> #include <linux/err.h> #include <linux/firewire.h> #include <linux/firewire-constants.h> #include <linux/module.h> #include <linux/slab.h> #include <sound/pcm.h> #include <sound/pcm_params.h> #include "amdtp-stream.h" #define TICKS_PER_CYCLE … #define CYCLES_PER_SECOND … #define TICKS_PER_SECOND … #define OHCI_SECOND_MODULUS … /* Always support Linux tracing subsystem. */ #define CREATE_TRACE_POINTS #include "amdtp-stream-trace.h" #define TRANSFER_DELAY_TICKS … /* isochronous header parameters */ #define ISO_DATA_LENGTH_SHIFT … #define TAG_NO_CIP_HEADER … #define TAG_CIP … // Common Isochronous Packet (CIP) header parameters. Use two quadlets CIP header when supported. #define CIP_HEADER_QUADLETS … #define CIP_EOH_SHIFT … #define CIP_EOH … #define CIP_EOH_MASK … #define CIP_SID_SHIFT … #define CIP_SID_MASK … #define CIP_DBS_MASK … #define CIP_DBS_SHIFT … #define CIP_SPH_MASK … #define CIP_SPH_SHIFT … #define CIP_DBC_MASK … #define CIP_FMT_SHIFT … #define CIP_FMT_MASK … #define CIP_FDF_MASK … #define CIP_FDF_SHIFT … #define CIP_FDF_NO_DATA … #define CIP_SYT_MASK … #define CIP_SYT_NO_INFO … #define CIP_SYT_CYCLE_MODULUS … #define CIP_NO_DATA … #define CIP_HEADER_SIZE … /* Audio and Music transfer protocol specific parameters */ #define CIP_FMT_AM … #define AMDTP_FDF_NO_DATA … // For iso header and tstamp. #define IR_CTX_HEADER_DEFAULT_QUADLETS … // Add nothing. #define IR_CTX_HEADER_SIZE_NO_CIP … // Add two quadlets CIP header. #define IR_CTX_HEADER_SIZE_CIP … #define HEADER_TSTAMP_MASK … #define IT_PKT_HEADER_SIZE_CIP … #define IT_PKT_HEADER_SIZE_NO_CIP … // The initial firmware of OXFW970 can postpone transmission of packet during finishing // asynchronous transaction. This module accepts 5 cycles to skip as maximum to avoid buffer // overrun. Actual device can skip more, then this module stops the packet streaming. #define IR_JUMBO_PAYLOAD_MAX_SKIP_CYCLES … static void pcm_period_work(struct work_struct *work); /** * amdtp_stream_init - initialize an AMDTP stream structure * @s: the AMDTP stream to initialize * @unit: the target of the stream * @dir: the direction of stream * @flags: the details of the streaming protocol consist of cip_flags enumeration-constants. * @fmt: the value of fmt field in CIP header * @process_ctx_payloads: callback handler to process payloads of isoc context * @protocol_size: the size to allocate newly for protocol */ 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) { … } EXPORT_SYMBOL(…); /** * amdtp_stream_destroy - free stream resources * @s: the AMDTP stream to destroy */ void amdtp_stream_destroy(struct amdtp_stream *s) { … } EXPORT_SYMBOL(…); const unsigned int amdtp_syt_intervals[CIP_SFC_COUNT] = …; EXPORT_SYMBOL(…); const unsigned int amdtp_rate_table[CIP_SFC_COUNT] = …; EXPORT_SYMBOL(…); static int apply_constraint_to_size(struct snd_pcm_hw_params *params, struct snd_pcm_hw_rule *rule) { … } /** * amdtp_stream_add_pcm_hw_constraints - add hw constraints for PCM substream * @s: the AMDTP stream, which must be initialized. * @runtime: the PCM substream runtime */ int amdtp_stream_add_pcm_hw_constraints(struct amdtp_stream *s, struct snd_pcm_runtime *runtime) { … } EXPORT_SYMBOL(…); /** * amdtp_stream_set_parameters - set stream parameters * @s: the AMDTP stream to configure * @rate: the sample rate * @data_block_quadlets: the size of a data block in quadlet unit * @pcm_frame_multiplier: the multiplier to compute the number of PCM frames by the number of AMDTP * events. * * The parameters must be set before the stream is started, and must not be * changed while the stream is running. */ int amdtp_stream_set_parameters(struct amdtp_stream *s, unsigned int rate, unsigned int data_block_quadlets, unsigned int pcm_frame_multiplier) { … } EXPORT_SYMBOL(…); // The CIP header is processed in context header apart from context payload. static int amdtp_stream_get_max_ctx_payload_size(struct amdtp_stream *s) { … } /** * amdtp_stream_get_max_payload - get the stream's packet size * @s: the AMDTP stream * * This function must not be called before the stream has been configured * with amdtp_stream_set_parameters(). */ unsigned int amdtp_stream_get_max_payload(struct amdtp_stream *s) { … } EXPORT_SYMBOL(…); /** * amdtp_stream_pcm_prepare - prepare PCM device for running * @s: the AMDTP stream * * This function should be called from the PCM device's .prepare callback. */ void amdtp_stream_pcm_prepare(struct amdtp_stream *s) { … } EXPORT_SYMBOL(…); #define prev_packet_desc(s, desc) … static void pool_blocking_data_blocks(struct amdtp_stream *s, struct seq_desc *descs, unsigned int size, unsigned int pos, unsigned int count) { … } static void pool_ideal_nonblocking_data_blocks(struct amdtp_stream *s, struct seq_desc *descs, unsigned int size, unsigned int pos, unsigned int count) { … } static unsigned int calculate_syt_offset(unsigned int *last_syt_offset, unsigned int *syt_offset_state, enum cip_sfc sfc) { … } static void pool_ideal_syt_offsets(struct amdtp_stream *s, struct seq_desc *descs, unsigned int size, unsigned int pos, unsigned int count) { … } static unsigned int compute_syt_offset(unsigned int syt, unsigned int cycle, unsigned int transfer_delay) { … } // Both of the producer and consumer of the queue runs in the same clock of IEEE 1394 bus. // Additionally, the sequence of tx packets is severely checked against any discontinuity // before filling entries in the queue. The calculation is safe even if it looks fragile by // overrun. static unsigned int calculate_cached_cycle_count(struct amdtp_stream *s, unsigned int head) { … } static void cache_seq(struct amdtp_stream *s, const struct pkt_desc *src, unsigned int desc_count) { … } static void pool_ideal_seq_descs(struct amdtp_stream *s, struct seq_desc *descs, unsigned int size, unsigned int pos, unsigned int count) { … } static void pool_replayed_seq(struct amdtp_stream *s, struct seq_desc *descs, unsigned int size, unsigned int pos, unsigned int count) { … } static void pool_seq_descs(struct amdtp_stream *s, struct seq_desc *descs, unsigned int size, unsigned int pos, unsigned int count) { … } static void update_pcm_pointers(struct amdtp_stream *s, struct snd_pcm_substream *pcm, unsigned int frames) { … } static void pcm_period_work(struct work_struct *work) { … } static int queue_packet(struct amdtp_stream *s, struct fw_iso_packet *params, bool sched_irq) { … } static inline int queue_out_packet(struct amdtp_stream *s, struct fw_iso_packet *params, bool sched_irq) { … } static inline int queue_in_packet(struct amdtp_stream *s, struct fw_iso_packet *params) { … } static void generate_cip_header(struct amdtp_stream *s, __be32 cip_header[2], unsigned int data_block_counter, unsigned int syt) { … } static void build_it_pkt_header(struct amdtp_stream *s, unsigned int cycle, struct fw_iso_packet *params, unsigned int header_length, unsigned int data_blocks, unsigned int data_block_counter, unsigned int syt, unsigned int index, u32 curr_cycle_time) { … } static int check_cip_header(struct amdtp_stream *s, const __be32 *buf, unsigned int payload_length, unsigned int *data_blocks, unsigned int *data_block_counter, unsigned int *syt) { … } static int parse_ir_ctx_header(struct amdtp_stream *s, unsigned int cycle, const __be32 *ctx_header, unsigned int *data_blocks, unsigned int *data_block_counter, unsigned int *syt, unsigned int packet_index, unsigned int index, u32 curr_cycle_time) { … } // In CYCLE_TIMER register of IEEE 1394, 7 bits are used to represent second. On // the other hand, in DMA descriptors of 1394 OHCI, 3 bits are used to represent // it. Thus, via Linux firewire subsystem, we can get the 3 bits for second. static inline u32 compute_ohci_iso_ctx_cycle_count(u32 tstamp) { … } static inline u32 compute_ohci_cycle_count(__be32 ctx_header_tstamp) { … } static inline u32 increment_ohci_cycle_count(u32 cycle, unsigned int addend) { … } static inline u32 decrement_ohci_cycle_count(u32 minuend, u32 subtrahend) { … } static int compare_ohci_cycle_count(u32 lval, u32 rval) { … } // Align to actual cycle count for the packet which is going to be scheduled. // This module queued the same number of isochronous cycle as the size of queue // to kip isochronous cycle, therefore it's OK to just increment the cycle by // the size of queue for scheduled cycle. static inline u32 compute_ohci_it_cycle(const __be32 ctx_header_tstamp, unsigned int queue_size) { … } static int generate_tx_packet_descs(struct amdtp_stream *s, struct pkt_desc *desc, const __be32 *ctx_header, unsigned int packet_count, unsigned int *desc_count) { … } static unsigned int compute_syt(unsigned int syt_offset, unsigned int cycle, unsigned int transfer_delay) { … } static void generate_rx_packet_descs(struct amdtp_stream *s, struct pkt_desc *desc, const __be32 *ctx_header, unsigned int packet_count) { … } static inline void cancel_stream(struct amdtp_stream *s) { … } static snd_pcm_sframes_t compute_pcm_extra_delay(struct amdtp_stream *s, const struct pkt_desc *desc, unsigned int count) { … } static void process_ctx_payloads(struct amdtp_stream *s, const struct pkt_desc *desc, unsigned int count) { … } static void process_rx_packets(struct fw_iso_context *context, u32 tstamp, size_t header_length, void *header, void *private_data) { … } static void skip_rx_packets(struct fw_iso_context *context, u32 tstamp, size_t header_length, void *header, void *private_data) { … } static void irq_target_callback(struct fw_iso_context *context, u32 tstamp, size_t header_length, void *header, void *private_data); static void process_rx_packets_intermediately(struct fw_iso_context *context, u32 tstamp, size_t header_length, void *header, void *private_data) { … } static void process_tx_packets(struct fw_iso_context *context, u32 tstamp, size_t header_length, void *header, void *private_data) { … } static void drop_tx_packets(struct fw_iso_context *context, u32 tstamp, size_t header_length, void *header, void *private_data) { … } static void process_tx_packets_intermediately(struct fw_iso_context *context, u32 tstamp, size_t header_length, void *header, void *private_data) { … } static void drop_tx_packets_initially(struct fw_iso_context *context, u32 tstamp, size_t header_length, void *header, void *private_data) { … } static void process_ctxs_in_domain(struct amdtp_domain *d) { … } static void irq_target_callback(struct fw_iso_context *context, u32 tstamp, size_t header_length, void *header, void *private_data) { … } static void irq_target_callback_intermediately(struct fw_iso_context *context, u32 tstamp, size_t header_length, void *header, void *private_data) { … } static void irq_target_callback_skip(struct fw_iso_context *context, u32 tstamp, size_t header_length, void *header, void *private_data) { … } // This is executed one time. For in-stream, first packet has come. For out-stream, prepared to // transmit first packet. static void amdtp_stream_first_callback(struct fw_iso_context *context, u32 tstamp, size_t header_length, void *header, void *private_data) { … } /** * amdtp_stream_start - start transferring packets * @s: the AMDTP stream to start * @channel: the isochronous channel on the bus * @speed: firewire speed code * @queue_size: The number of packets in the queue. * @idle_irq_interval: the interval to queue packet during initial state. * * The stream cannot be started until it has been configured with * amdtp_stream_set_parameters() and it must be started before any PCM or MIDI * device can be started. */ static int amdtp_stream_start(struct amdtp_stream *s, int channel, int speed, unsigned int queue_size, unsigned int idle_irq_interval) { … } /** * amdtp_domain_stream_pcm_pointer - get the PCM buffer position * @d: the AMDTP domain. * @s: the AMDTP stream that transports the PCM data * * Returns the current buffer position, in frames. */ unsigned long amdtp_domain_stream_pcm_pointer(struct amdtp_domain *d, struct amdtp_stream *s) { … } EXPORT_SYMBOL_GPL(…); /** * amdtp_domain_stream_pcm_ack - acknowledge queued PCM frames * @d: the AMDTP domain. * @s: the AMDTP stream that transfers the PCM frames * * Returns zero always. */ int amdtp_domain_stream_pcm_ack(struct amdtp_domain *d, struct amdtp_stream *s) { … } EXPORT_SYMBOL_GPL(…); /** * amdtp_stream_update - update the stream after a bus reset * @s: the AMDTP stream */ void amdtp_stream_update(struct amdtp_stream *s) { … } EXPORT_SYMBOL(…); /** * amdtp_stream_stop - stop sending packets * @s: the AMDTP stream to stop * * All PCM and MIDI devices of the stream must be stopped before the stream * itself can be stopped. */ static void amdtp_stream_stop(struct amdtp_stream *s) { … } /** * amdtp_stream_pcm_abort - abort the running PCM device * @s: the AMDTP stream about to be stopped * * If the isochronous stream needs to be stopped asynchronously, call this * function first to stop the PCM device. */ void amdtp_stream_pcm_abort(struct amdtp_stream *s) { … } EXPORT_SYMBOL(…); /** * amdtp_domain_init - initialize an AMDTP domain structure * @d: the AMDTP domain to initialize. */ int amdtp_domain_init(struct amdtp_domain *d) { … } EXPORT_SYMBOL_GPL(…); /** * amdtp_domain_destroy - destroy an AMDTP domain structure * @d: the AMDTP domain to destroy. */ void amdtp_domain_destroy(struct amdtp_domain *d) { … } EXPORT_SYMBOL_GPL(…); /** * amdtp_domain_add_stream - register isoc context into the domain. * @d: the AMDTP domain. * @s: the AMDTP stream. * @channel: the isochronous channel on the bus. * @speed: firewire speed code. */ int amdtp_domain_add_stream(struct amdtp_domain *d, struct amdtp_stream *s, int channel, int speed) { … } EXPORT_SYMBOL_GPL(…); // Make the reference from rx stream to tx stream for sequence replay. When the number of tx streams // is less than the number of rx streams, the first tx stream is selected. static int make_association(struct amdtp_domain *d) { … } /** * amdtp_domain_start - start sending packets for isoc context in the domain. * @d: the AMDTP domain. * @tx_init_skip_cycles: the number of cycles to skip processing packets at initial stage of IR * contexts. * @replay_seq: whether to replay the sequence of packet in IR context for the sequence of packet in * IT context. * @replay_on_the_fly: transfer rx packets according to nominal frequency, then begin to replay * according to arrival of events in tx packets. */ int amdtp_domain_start(struct amdtp_domain *d, unsigned int tx_init_skip_cycles, bool replay_seq, bool replay_on_the_fly) { … } EXPORT_SYMBOL_GPL(…); /** * amdtp_domain_stop - stop sending packets for isoc context in the same domain. * @d: the AMDTP domain to which the isoc contexts belong. */ void amdtp_domain_stop(struct amdtp_domain *d) { … } EXPORT_SYMBOL_GPL(…);
Codebase Browser
linux