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_rawmidi_substream;
  68
  69 enum amdtp_stream_direction {
  70         AMDTP_OUT_STREAM = 0,
  71         AMDTP_IN_STREAM
  72 };
  73
  74 struct amdtp_stream {
  75         struct fw_unit *unit;
  76         enum cip_flags flags;
  77         enum amdtp_stream_direction direction;
  78         struct fw_iso_context *context;
  79         struct mutex mutex;
  80
  81         enum cip_sfc sfc;
  82         unsigned int data_block_quadlets;
  83         unsigned int pcm_channels;
  84         unsigned int midi_ports;
  85         void (*transfer_samples)(struct amdtp_stream *s,
  86                                  struct snd_pcm_substream *pcm,
  87                                  __be32 *buffer, unsigned int frames);
  88         u8 pcm_positions[AMDTP_MAX_CHANNELS_FOR_PCM];
  89         u8 midi_position;
  90
  91         unsigned int syt_interval;
  92         unsigned int transfer_delay;
  93         unsigned int source_node_id_field;
  94         struct iso_packets_buffer buffer;
  95
  96         struct snd_pcm_substream *pcm;
  97         struct tasklet_struct period_tasklet;
  98
  99         int packet_index;
 100         unsigned int data_block_counter;
 101
 102         unsigned int data_block_state;
 103
 104         unsigned int last_syt_offset;
 105         unsigned int syt_offset_state;
 106
 107         unsigned int pcm_buffer_pointer;
 108         unsigned int pcm_period_pointer;
 109         bool pointer_flush;
 110
 111         struct snd_rawmidi_substream *midi[AMDTP_MAX_CHANNELS_FOR_MIDI * 8];
 112
 113         bool callbacked;
 114         wait_queue_head_t callback_wait;
 115         struct amdtp_stream *sync_slave;
 116 };
 117
 118 int amdtp_stream_init(struct amdtp_stream *s, struct fw_unit *unit,
 119                       enum amdtp_stream_direction dir,
 120                       enum cip_flags flags);
 121 void amdtp_stream_destroy(struct amdtp_stream *s);
 122
 123 void amdtp_stream_set_parameters(struct amdtp_stream *s,
 124                                  unsigned int rate,
 125                                  unsigned int pcm_channels,
 126                                  unsigned int midi_ports);
 127 unsigned int amdtp_stream_get_max_payload(struct amdtp_stream *s);
 128
 129 int amdtp_stream_start(struct amdtp_stream *s, int channel, int speed);
 130 void amdtp_stream_update(struct amdtp_stream *s);
 131 void amdtp_stream_stop(struct amdtp_stream *s);
 132
 133 void amdtp_stream_set_pcm_format(struct amdtp_stream *s,
 134                                  snd_pcm_format_t format);
 135 void amdtp_stream_pcm_prepare(struct amdtp_stream *s);
 136 unsigned long amdtp_stream_pcm_pointer(struct amdtp_stream *s);
 137 void amdtp_stream_pcm_abort(struct amdtp_stream *s);
 138
 139 extern const unsigned int amdtp_syt_intervals[CIP_SFC_COUNT];
 140
 141 /**
 142  * amdtp_stream_running - check stream is running or not
 143  * @s: the AMDTP stream
 144  *
 145  * If this function returns true, the stream is running.
 146  */
 147 static inline bool amdtp_stream_running(struct amdtp_stream *s)
 148 {
 149         return !IS_ERR(s->context);
 150 }
 151
 152 /**
 153  * amdtp_streaming_error - check for streaming error
 154  * @s: the AMDTP stream
 155  *
 156  * If this function returns true, the stream's packet queue has stopped due to
 157  * an asynchronous error.
 158  */
 159 static inline bool amdtp_streaming_error(struct amdtp_stream *s)
 160 {
 161         return s->packet_index < 0;
 162 }
 163
 164 /**
 165  * amdtp_stream_pcm_running - check PCM substream is running or not
 166  * @s: the AMDTP stream
 167  *
 168  * If this function returns true, PCM substream in the AMDTP stream is running.
 169  */
 170 static inline bool amdtp_stream_pcm_running(struct amdtp_stream *s)
 171 {
 172         return !!s->pcm;
 173 }
 174
 175 /**
 176  * amdtp_stream_pcm_trigger - start/stop playback from a PCM device
 177  * @s: the AMDTP stream
 178  * @pcm: the PCM device to be started, or %NULL to stop the current device
 179  *
 180  * Call this function on a running isochronous stream to enable the actual
 181  * transmission of PCM data.  This function should be called from the PCM
 182  * device's .trigger callback.
 183  */
 184 static inline void amdtp_stream_pcm_trigger(struct amdtp_stream *s,
 185                                             struct snd_pcm_substream *pcm)
 186 {
 187         ACCESS_ONCE(s->pcm) = pcm;
 188 }
 189
 190 /**
 191  * amdtp_stream_midi_trigger - start/stop playback/capture with a MIDI device
 192  * @s: the AMDTP stream
 193  * @port: index of MIDI port
 194  * @midi: the MIDI device to be started, or %NULL to stop the current device
 195  *
 196  * Call this function on a running isochronous stream to enable the actual
 197  * transmission of MIDI data.  This function should be called from the MIDI
 198  * device's .trigger callback.
 199  */
 200 static inline void amdtp_stream_midi_trigger(struct amdtp_stream *s,
 201                                              unsigned int port,
 202                                              struct snd_rawmidi_substream *midi)
 203 {
 204         if (port < s->midi_ports)
 205                 ACCESS_ONCE(s->midi[port]) = midi;
 206 }
 207
 208 static inline bool cip_sfc_is_base_44100(enum cip_sfc sfc)
 209 {
 210         return sfc & 1;
 211 }
 212
 213 static inline void amdtp_stream_set_sync(enum cip_flags sync_mode,
 214                                          struct amdtp_stream *master,
 215                                          struct amdtp_stream *slave)
 216 {
 217         if (sync_mode == CIP_SYNC_TO_DEVICE) {
 218                 master->flags |= CIP_SYNC_TO_DEVICE;
 219                 slave->flags |= CIP_SYNC_TO_DEVICE;
 220                 master->sync_slave = slave;
 221         } else {
 222                 master->flags &= ~CIP_SYNC_TO_DEVICE;
 223                 slave->flags &= ~CIP_SYNC_TO_DEVICE;
 224                 master->sync_slave = NULL;
 225         }
 226
 227         slave->sync_slave = NULL;
 228 }
 229
 230 /**
 231  * amdtp_stream_wait_callback - sleep till callbacked or timeout
 232  * @s: the AMDTP stream
 233  * @timeout: msec till timeout
 234  *
 235  * If this function return false, the AMDTP stream should be stopped.
 236  */
 237 static inline bool amdtp_stream_wait_callback(struct amdtp_stream *s,
 238                                               unsigned int timeout)
 239 {
 240         return wait_event_timeout(s->callback_wait,
 241                                   s->callbacked == true,
 242                                   msecs_to_jiffies(timeout)) > 0;
 243 }
 244
 245 #endif