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