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