sound/firewire/amdtp.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 <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  */
  25 enum cip_flags {
  26         CIP_NONBLOCKING         = 0x00,
  27         CIP_BLOCKING            = 0x01,
  28         CIP_SYNC_TO_DEVICE      = 0x02,
  29         CIP_EMPTY_WITH_TAG0     = 0x04,
  30         CIP_DBC_IS_END_EVENT    = 0x08,
  31 };
  32
  33 /**
  34  * enum cip_sfc - a stream's sample rate
  35  */
  36 enum cip_sfc {
  37         CIP_SFC_32000  = 0,
  38         CIP_SFC_44100  = 1,
  39         CIP_SFC_48000  = 2,
  40         CIP_SFC_88200  = 3,
  41         CIP_SFC_96000  = 4,
  42         CIP_SFC_176400 = 5,
  43         CIP_SFC_192000 = 6,
  44         CIP_SFC_COUNT
  45 };
  46
  47 #define AMDTP_IN_PCM_FORMAT_BITS        SNDRV_PCM_FMTBIT_S32
  48
  49 #define AMDTP_OUT_PCM_FORMAT_BITS       (SNDRV_PCM_FMTBIT_S16 | \
  50                                          SNDRV_PCM_FMTBIT_S32)
  51
  52
  53 /*
  54  * This module supports maximum 64 PCM channels for one PCM stream
  55  * This is for our convenience.
  56  */
  57 #define AMDTP_MAX_CHANNELS_FOR_PCM      64
  58
  59 /*
  60  * AMDTP packet can include channels for MIDI conformant data.
  61  * Each MIDI conformant data channel includes 8 MPX-MIDI data stream.
  62  * Each MPX-MIDI data stream includes one data stream from/to MIDI ports.
  63  *
  64  * This module supports maximum 1 MIDI conformant data channels.
  65  * Then this AMDTP packets can transfer maximum 8 MIDI data streams.
  66  */
  67 #define AMDTP_MAX_CHANNELS_FOR_MIDI     1
  68
  69 struct fw_unit;
  70 struct fw_iso_context;
  71 struct snd_pcm_substream;
  72 struct snd_pcm_runtime;
  73 struct snd_rawmidi_substream;
  74
  75 enum amdtp_stream_direction {
  76         AMDTP_OUT_STREAM = 0,
  77         AMDTP_IN_STREAM
  78 };
  79
  80 struct amdtp_stream {
  81         struct fw_unit *unit;
  82         enum cip_flags flags;
  83         enum amdtp_stream_direction direction;
  84         struct fw_iso_context *context;
  85         struct mutex mutex;
  86
  87         enum cip_sfc sfc;
  88         unsigned int data_block_quadlets;
  89         unsigned int pcm_channels;
  90         unsigned int midi_ports;
  91         void (*transfer_samples)(struct amdtp_stream *s,
  92                                  struct snd_pcm_substream *pcm,
  93                                  __be32 *buffer, unsigned int frames);
  94         u8 pcm_positions[AMDTP_MAX_CHANNELS_FOR_PCM];
  95         u8 midi_position;
  96
  97         unsigned int syt_interval;
  98         unsigned int transfer_delay;
  99         unsigned int source_node_id_field;
 100         struct iso_packets_buffer buffer;
 101
 102         struct snd_pcm_substream *pcm;
 103         struct tasklet_struct period_tasklet;
 104
 105         int packet_index;
 106         unsigned int data_block_counter;
 107
 108         unsigned int data_block_state;
 109
 110         unsigned int last_syt_offset;
 111         unsigned int syt_offset_state;
 112
 113         unsigned int pcm_buffer_pointer;
 114         unsigned int pcm_period_pointer;
 115         bool pointer_flush;
 116
 117         struct snd_rawmidi_substream *midi[AMDTP_MAX_CHANNELS_FOR_MIDI * 8];
 118
 119         bool callbacked;
 120         wait_queue_head_t callback_wait;
 121         struct amdtp_stream *sync_slave;
 122 };
 123
 124 int amdtp_stream_init(struct amdtp_stream *s, struct fw_unit *unit,
 125                       enum amdtp_stream_direction dir,
 126                       enum cip_flags flags);
 127 void amdtp_stream_destroy(struct amdtp_stream *s);
 128
 129 void amdtp_stream_set_parameters(struct amdtp_stream *s,
 130                                  unsigned int rate,
 131                                  unsigned int pcm_channels,
 132                                  unsigned int midi_ports);
 133 unsigned int amdtp_stream_get_max_payload(struct amdtp_stream *s);
 134
 135 int amdtp_stream_start(struct amdtp_stream *s, int channel, int speed);
 136 void amdtp_stream_update(struct amdtp_stream *s);
 137 void amdtp_stream_stop(struct amdtp_stream *s);
 138
 139 int amdtp_stream_add_pcm_hw_constraints(struct amdtp_stream *s,
 140                                         struct snd_pcm_runtime *runtime);
 141 void amdtp_stream_set_pcm_format(struct amdtp_stream *s,
 142                                  snd_pcm_format_t format);
 143 void amdtp_stream_pcm_prepare(struct amdtp_stream *s);
 144 unsigned long amdtp_stream_pcm_pointer(struct amdtp_stream *s);
 145 void amdtp_stream_pcm_abort(struct amdtp_stream *s);
 146
 147 extern const unsigned int amdtp_syt_intervals[CIP_SFC_COUNT];
 148 extern const unsigned int amdtp_rate_table[CIP_SFC_COUNT];
 149
 150 /**
 151  * amdtp_stream_running - check stream is running or not
 152  * @s: the AMDTP stream
 153  *
 154  * If this function returns true, the stream is running.
 155  */
 156 static inline bool amdtp_stream_running(struct amdtp_stream *s)
 157 {
 158         return !IS_ERR(s->context);
 159 }
 160
 161 /**
 162  * amdtp_streaming_error - check for streaming error
 163  * @s: the AMDTP stream
 164  *
 165  * If this function returns true, the stream's packet queue has stopped due to
 166  * an asynchronous error.
 167  */
 168 static inline bool amdtp_streaming_error(struct amdtp_stream *s)
 169 {
 170         return s->packet_index < 0;
 171 }
 172
 173 /**
 174  * amdtp_stream_pcm_running - check PCM substream is running or not
 175  * @s: the AMDTP stream
 176  *
 177  * If this function returns true, PCM substream in the AMDTP stream is running.
 178  */
 179 static inline bool amdtp_stream_pcm_running(struct amdtp_stream *s)
 180 {
 181         return !!s->pcm;
 182 }
 183
 184 /**
 185  * amdtp_stream_pcm_trigger - start/stop playback from a PCM device
 186  * @s: the AMDTP stream
 187  * @pcm: the PCM device to be started, or %NULL to stop the current device
 188  *
 189  * Call this function on a running isochronous stream to enable the actual
 190  * transmission of PCM data.  This function should be called from the PCM
 191  * device's .trigger callback.
 192  */
 193 static inline void amdtp_stream_pcm_trigger(struct amdtp_stream *s,
 194                                             struct snd_pcm_substream *pcm)
 195 {
 196         ACCESS_ONCE(s->pcm) = pcm;
 197 }
 198
 199 /**
 200  * amdtp_stream_midi_trigger - start/stop playback/capture with a MIDI device
 201  * @s: the AMDTP stream
 202  * @port: index of MIDI port
 203  * @midi: the MIDI device to be started, or %NULL to stop the current device
 204  *
 205  * Call this function on a running isochronous stream to enable the actual
 206  * transmission of MIDI data.  This function should be called from the MIDI
 207  * device's .trigger callback.
 208  */
 209 static inline void amdtp_stream_midi_trigger(struct amdtp_stream *s,
 210                                              unsigned int port,
 211                                              struct snd_rawmidi_substream *midi)
 212 {
 213         if (port < s->midi_ports)
 214                 ACCESS_ONCE(s->midi[port]) = midi;
 215 }
 216
 217 static inline bool cip_sfc_is_base_44100(enum cip_sfc sfc)
 218 {
 219         return sfc & 1;
 220 }
 221
 222 static inline void amdtp_stream_set_sync(enum cip_flags sync_mode,
 223                                          struct amdtp_stream *master,
 224                                          struct amdtp_stream *slave)
 225 {
 226         if (sync_mode == CIP_SYNC_TO_DEVICE) {
 227                 master->flags |= CIP_SYNC_TO_DEVICE;
 228                 slave->flags |= CIP_SYNC_TO_DEVICE;
 229                 master->sync_slave = slave;
 230         } else {
 231                 master->flags &= ~CIP_SYNC_TO_DEVICE;
 232                 slave->flags &= ~CIP_SYNC_TO_DEVICE;
 233                 master->sync_slave = NULL;
 234         }
 235
 236         slave->sync_slave = NULL;
 237 }
 238
 239 /**
 240  * amdtp_stream_wait_callback - sleep till callbacked or timeout
 241  * @s: the AMDTP stream
 242  * @timeout: msec till timeout
 243  *
 244  * If this function return false, the AMDTP stream should be stopped.
 245  */
 246 static inline bool amdtp_stream_wait_callback(struct amdtp_stream *s,
 247                                               unsigned int timeout)
 248 {
 249         return wait_event_timeout(s->callback_wait,
 250                                   s->callbacked == true,
 251                                   msecs_to_jiffies(timeout)) > 0;
 252 }
 253
 254 #endif