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