1#ifndef SOUND_FIREWIRE_AMDTP_H_INCLUDED 2#define SOUND_FIREWIRE_AMDTP_H_INCLUDED 3 4#include <linux/err.h> 5#include <linux/interrupt.h> 6#include <linux/mutex.h> 7#include <sound/asound.h> 8#include "packets-buffer.h" 9 10/** 11 * enum cip_flags - describes details of the streaming protocol 12 * @CIP_NONBLOCKING: In non-blocking mode, each packet contains 13 * sample_rate/8000 samples, with rounding up or down to adjust 14 * for clock skew and left-over fractional samples. This should 15 * be used if supported by the device. 16 * @CIP_BLOCKING: In blocking mode, each packet contains either zero or 17 * SYT_INTERVAL samples, with these two types alternating so that 18 * the overall sample rate comes out right. 19 * @CIP_SYNC_TO_DEVICE: In sync to device mode, time stamp in out packets is 20 * generated by in packets. Defaultly this driver generates timestamp. 21 * @CIP_EMPTY_WITH_TAG0: Only for in-stream. Empty in-packets have TAG0. 22 * @CIP_DBC_IS_END_EVENT: Only for in-stream. The value of dbc in an in-packet 23 * corresponds to the end 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_SKIP_INIT_DBC_CHECK: Only for in-stream. The value of dbc in first 29 * packet is not continuous from an initial value. 30 * @CIP_EMPTY_HAS_WRONG_DBC: Only for in-stream. The value of dbc in empty 31 * packet is wrong but the others are correct. 32 */ 33enum cip_flags { 34 CIP_NONBLOCKING = 0x00, 35 CIP_BLOCKING = 0x01, 36 CIP_SYNC_TO_DEVICE = 0x02, 37 CIP_EMPTY_WITH_TAG0 = 0x04, 38 CIP_DBC_IS_END_EVENT = 0x08, 39 CIP_WRONG_DBS = 0x10, 40 CIP_SKIP_DBC_ZERO_CHECK = 0x20, 41 CIP_SKIP_INIT_DBC_CHECK = 0x40, 42 CIP_EMPTY_HAS_WRONG_DBC = 0x80, 43}; 44 45/** 46 * enum cip_sfc - supported Sampling Frequency Codes (SFCs) 47 * @CIP_SFC_32000: 32,000 data blocks 48 * @CIP_SFC_44100: 44,100 data blocks 49 * @CIP_SFC_48000: 48,000 data blocks 50 * @CIP_SFC_88200: 88,200 data blocks 51 * @CIP_SFC_96000: 96,000 data blocks 52 * @CIP_SFC_176400: 176,400 data blocks 53 * @CIP_SFC_192000: 192,000 data blocks 54 * @CIP_SFC_COUNT: the number of supported SFCs 55 * 56 * These values are used to show nominal Sampling Frequency Code in 57 * Format Dependent Field (FDF) of AMDTP packet header. In IEC 61883-6:2002, 58 * this code means the number of events per second. Actually the code 59 * represents the number of data blocks transferred per second in an AMDTP 60 * stream. 61 * 62 * In IEC 61883-6:2005, some extensions were added to support more types of 63 * data such as 'One Bit LInear Audio', therefore the meaning of SFC became 64 * different depending on the types. 65 * 66 * Currently our implementation is compatible with IEC 61883-6:2002. 67 */ 68enum cip_sfc { 69 CIP_SFC_32000 = 0, 70 CIP_SFC_44100 = 1, 71 CIP_SFC_48000 = 2, 72 CIP_SFC_88200 = 3, 73 CIP_SFC_96000 = 4, 74 CIP_SFC_176400 = 5, 75 CIP_SFC_192000 = 6, 76 CIP_SFC_COUNT 77}; 78 79#define AMDTP_IN_PCM_FORMAT_BITS SNDRV_PCM_FMTBIT_S32 80 81#define AMDTP_OUT_PCM_FORMAT_BITS (SNDRV_PCM_FMTBIT_S16 | \ 82 SNDRV_PCM_FMTBIT_S32) 83 84 85/* 86 * This module supports maximum 64 PCM channels for one PCM stream 87 * This is for our convenience. 88 */ 89#define AMDTP_MAX_CHANNELS_FOR_PCM 64 90 91/* 92 * AMDTP packet can include channels for MIDI conformant data. 93 * Each MIDI conformant data channel includes 8 MPX-MIDI data stream. 94 * Each MPX-MIDI data stream includes one data stream from/to MIDI ports. 95 * 96 * This module supports maximum 1 MIDI conformant data channels. 97 * Then this AMDTP packets can transfer maximum 8 MIDI data streams. 98 */ 99#define AMDTP_MAX_CHANNELS_FOR_MIDI 1 100 101struct fw_unit; 102struct fw_iso_context; 103struct snd_pcm_substream; 104struct snd_pcm_runtime; 105struct snd_rawmidi_substream; 106 107enum amdtp_stream_direction { 108 AMDTP_OUT_STREAM = 0, 109 AMDTP_IN_STREAM 110}; 111 112struct amdtp_stream { 113 struct fw_unit *unit; 114 enum cip_flags flags; 115 enum amdtp_stream_direction direction; 116 struct fw_iso_context *context; 117 struct mutex mutex; 118 119 enum cip_sfc sfc; 120 unsigned int data_block_quadlets; 121 unsigned int pcm_channels; 122 unsigned int midi_ports; 123 void (*transfer_samples)(struct amdtp_stream *s, 124 struct snd_pcm_substream *pcm, 125 __be32 *buffer, unsigned int frames); 126 u8 pcm_positions[AMDTP_MAX_CHANNELS_FOR_PCM]; 127 u8 midi_position; 128 129 unsigned int syt_interval; 130 unsigned int transfer_delay; 131 unsigned int source_node_id_field; 132 struct iso_packets_buffer buffer; 133 134 struct snd_pcm_substream *pcm; 135 struct tasklet_struct period_tasklet; 136 137 int packet_index; 138 unsigned int data_block_counter; 139 140 unsigned int data_block_state; 141 142 unsigned int last_syt_offset; 143 unsigned int syt_offset_state; 144 145 unsigned int pcm_buffer_pointer; 146 unsigned int pcm_period_pointer; 147 bool pointer_flush; 148 bool double_pcm_frames; 149 150 struct snd_rawmidi_substream *midi[AMDTP_MAX_CHANNELS_FOR_MIDI * 8]; 151 int midi_fifo_limit; 152 int midi_fifo_used[AMDTP_MAX_CHANNELS_FOR_MIDI * 8]; 153 154 /* quirk: fixed interval of dbc between previos/current packets. */ 155 unsigned int tx_dbc_interval; 156 /* quirk: indicate the value of dbc field in a first packet. */ 157 unsigned int tx_first_dbc; 158 159 bool callbacked; 160 wait_queue_head_t callback_wait; 161 struct amdtp_stream *sync_slave; 162}; 163 164int amdtp_stream_init(struct amdtp_stream *s, struct fw_unit *unit, 165 enum amdtp_stream_direction dir, 166 enum cip_flags flags); 167void amdtp_stream_destroy(struct amdtp_stream *s); 168 169void amdtp_stream_set_parameters(struct amdtp_stream *s, 170 unsigned int rate, 171 unsigned int pcm_channels, 172 unsigned int midi_ports); 173unsigned int amdtp_stream_get_max_payload(struct amdtp_stream *s); 174 175int amdtp_stream_start(struct amdtp_stream *s, int channel, int speed); 176void amdtp_stream_update(struct amdtp_stream *s); 177void amdtp_stream_stop(struct amdtp_stream *s); 178 179int amdtp_stream_add_pcm_hw_constraints(struct amdtp_stream *s, 180 struct snd_pcm_runtime *runtime); 181void amdtp_stream_set_pcm_format(struct amdtp_stream *s, 182 snd_pcm_format_t format); 183void amdtp_stream_pcm_prepare(struct amdtp_stream *s); 184unsigned long amdtp_stream_pcm_pointer(struct amdtp_stream *s); 185void amdtp_stream_pcm_abort(struct amdtp_stream *s); 186 187extern const unsigned int amdtp_syt_intervals[CIP_SFC_COUNT]; 188extern const unsigned int amdtp_rate_table[CIP_SFC_COUNT]; 189 190/** 191 * amdtp_stream_running - check stream is running or not 192 * @s: the AMDTP stream 193 * 194 * If this function returns true, the stream is running. 195 */ 196static inline bool amdtp_stream_running(struct amdtp_stream *s) 197{ 198 return !IS_ERR(s->context); 199} 200 201/** 202 * amdtp_streaming_error - check for streaming error 203 * @s: the AMDTP stream 204 * 205 * If this function returns true, the stream's packet queue has stopped due to 206 * an asynchronous error. 207 */ 208static inline bool amdtp_streaming_error(struct amdtp_stream *s) 209{ 210 return s->packet_index < 0; 211} 212 213/** 214 * amdtp_stream_pcm_running - check PCM substream is running or not 215 * @s: the AMDTP stream 216 * 217 * If this function returns true, PCM substream in the AMDTP stream is running. 218 */ 219static inline bool amdtp_stream_pcm_running(struct amdtp_stream *s) 220{ 221 return !!s->pcm; 222} 223 224/** 225 * amdtp_stream_pcm_trigger - start/stop playback from a PCM device 226 * @s: the AMDTP stream 227 * @pcm: the PCM device to be started, or %NULL to stop the current device 228 * 229 * Call this function on a running isochronous stream to enable the actual 230 * transmission of PCM data. This function should be called from the PCM 231 * device's .trigger callback. 232 */ 233static inline void amdtp_stream_pcm_trigger(struct amdtp_stream *s, 234 struct snd_pcm_substream *pcm) 235{ 236 ACCESS_ONCE(s->pcm) = pcm; 237} 238 239/** 240 * amdtp_stream_midi_trigger - start/stop playback/capture with a MIDI device 241 * @s: the AMDTP stream 242 * @port: index of MIDI port 243 * @midi: the MIDI device to be started, or %NULL to stop the current device 244 * 245 * Call this function on a running isochronous stream to enable the actual 246 * transmission of MIDI data. This function should be called from the MIDI 247 * device's .trigger callback. 248 */ 249static inline void amdtp_stream_midi_trigger(struct amdtp_stream *s, 250 unsigned int port, 251 struct snd_rawmidi_substream *midi) 252{ 253 if (port < s->midi_ports) 254 ACCESS_ONCE(s->midi[port]) = midi; 255} 256 257static inline bool cip_sfc_is_base_44100(enum cip_sfc sfc) 258{ 259 return sfc & 1; 260} 261 262static inline void amdtp_stream_set_sync(enum cip_flags sync_mode, 263 struct amdtp_stream *master, 264 struct amdtp_stream *slave) 265{ 266 if (sync_mode == CIP_SYNC_TO_DEVICE) { 267 master->flags |= CIP_SYNC_TO_DEVICE; 268 slave->flags |= CIP_SYNC_TO_DEVICE; 269 master->sync_slave = slave; 270 } else { 271 master->flags &= ~CIP_SYNC_TO_DEVICE; 272 slave->flags &= ~CIP_SYNC_TO_DEVICE; 273 master->sync_slave = NULL; 274 } 275 276 slave->sync_slave = NULL; 277} 278 279/** 280 * amdtp_stream_wait_callback - sleep till callbacked or timeout 281 * @s: the AMDTP stream 282 * @timeout: msec till timeout 283 * 284 * If this function return false, the AMDTP stream should be stopped. 285 */ 286static inline bool amdtp_stream_wait_callback(struct amdtp_stream *s, 287 unsigned int timeout) 288{ 289 return wait_event_timeout(s->callback_wait, 290 s->callbacked == true, 291 msecs_to_jiffies(timeout)) > 0; 292} 293 294#endif 295