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