sound/firewire/amdtp-stream.h

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