LXR linux/sound/firewire/amdtp.h

   1#ifndef SOUND_FIREWIRE_AMDTP_H_INCLUDED
   2#define SOUND_FIREWIRE_AMDTP_H_INCLUDED
   3
   4#include <linux/interrupt.h>
   5#include <linux/mutex.h>
   6#include <linux/spinlock.h>
   7#include "packets-buffer.h"
   8
   9/**
  10 * enum cip_out_flags - describes details of the streaming protocol
  11 * @CIP_NONBLOCKING: In non-blocking mode, each packet contains
  12 *      sample_rate/8000 samples, with rounding up or down to adjust
  13 *      for clock skew and left-over fractional samples.  This should
  14 *      be used if supported by the device.
  15 */
  16enum cip_out_flags {
  17        CIP_NONBLOCKING = 0,
  18};
  19
  20/**
  21 * enum cip_sfc - a stream's sample rate
  22 */
  23enum cip_sfc {
  24        CIP_SFC_32000  = 0,
  25        CIP_SFC_44100  = 1,
  26        CIP_SFC_48000  = 2,
  27        CIP_SFC_88200  = 3,
  28        CIP_SFC_96000  = 4,
  29        CIP_SFC_176400 = 5,
  30        CIP_SFC_192000 = 6,
  31};
  32
  33#define AMDTP_OUT_PCM_FORMAT_BITS       (SNDRV_PCM_FMTBIT_S16 | \
  34                                         SNDRV_PCM_FMTBIT_S32)
  35
  36struct fw_unit;
  37struct fw_iso_context;
  38struct snd_pcm_substream;
  39
  40struct amdtp_out_stream {
  41        struct fw_unit *unit;
  42        enum cip_out_flags flags;
  43        struct fw_iso_context *context;
  44        struct mutex mutex;
  45
  46        enum cip_sfc sfc;
  47        unsigned int data_block_quadlets;
  48        unsigned int pcm_channels;
  49        unsigned int midi_ports;
  50        void (*transfer_samples)(struct amdtp_out_stream *s,
  51                                 struct snd_pcm_substream *pcm,
  52                                 __be32 *buffer, unsigned int frames);
  53
  54        unsigned int syt_interval;
  55        unsigned int source_node_id_field;
  56        struct iso_packets_buffer buffer;
  57
  58        struct snd_pcm_substream *pcm;
  59        struct tasklet_struct period_tasklet;
  60
  61        int packet_index;
  62        unsigned int data_block_counter;
  63
  64        unsigned int data_block_state;
  65
  66        unsigned int last_syt_offset;
  67        unsigned int syt_offset_state;
  68
  69        unsigned int pcm_buffer_pointer;
  70        unsigned int pcm_period_pointer;
  71        bool pointer_flush;
  72};
  73
  74int amdtp_out_stream_init(struct amdtp_out_stream *s, struct fw_unit *unit,
  75                          enum cip_out_flags flags);
  76void amdtp_out_stream_destroy(struct amdtp_out_stream *s);
  77
  78void amdtp_out_stream_set_rate(struct amdtp_out_stream *s, unsigned int rate);
  79unsigned int amdtp_out_stream_get_max_payload(struct amdtp_out_stream *s);
  80
  81int amdtp_out_stream_start(struct amdtp_out_stream *s, int channel, int speed);
  82void amdtp_out_stream_update(struct amdtp_out_stream *s);
  83void amdtp_out_stream_stop(struct amdtp_out_stream *s);
  84
  85void amdtp_out_stream_set_pcm_format(struct amdtp_out_stream *s,
  86                                     snd_pcm_format_t format);
  87void amdtp_out_stream_pcm_prepare(struct amdtp_out_stream *s);
  88unsigned long amdtp_out_stream_pcm_pointer(struct amdtp_out_stream *s);
  89void amdtp_out_stream_pcm_abort(struct amdtp_out_stream *s);
  90
  91/**
  92 * amdtp_out_stream_set_pcm - configure format of PCM samples
  93 * @s: the AMDTP output stream to be configured
  94 * @pcm_channels: the number of PCM samples in each data block, to be encoded
  95 *                as AM824 multi-bit linear audio
  96 *
  97 * This function must not be called while the stream is running.
  98 */
  99static inline void amdtp_out_stream_set_pcm(struct amdtp_out_stream *s,
 100                                            unsigned int pcm_channels)
 101{
 102        s->pcm_channels = pcm_channels;
 103}
 104
 105/**
 106 * amdtp_out_stream_set_midi - configure format of MIDI data
 107 * @s: the AMDTP output stream to be configured
 108 * @midi_ports: the number of MIDI ports (i.e., MPX-MIDI Data Channels)
 109 *
 110 * This function must not be called while the stream is running.
 111 */
 112static inline void amdtp_out_stream_set_midi(struct amdtp_out_stream *s,
 113                                             unsigned int midi_ports)
 114{
 115        s->midi_ports = midi_ports;
 116}
 117
 118/**
 119 * amdtp_out_streaming_error - check for streaming error
 120 * @s: the AMDTP output stream
 121 *
 122 * If this function returns true, the stream's packet queue has stopped due to
 123 * an asynchronous error.
 124 */
 125static inline bool amdtp_out_streaming_error(struct amdtp_out_stream *s)
 126{
 127        return s->packet_index < 0;
 128}
 129
 130/**
 131 * amdtp_out_stream_pcm_trigger - start/stop playback from a PCM device
 132 * @s: the AMDTP output stream
 133 * @pcm: the PCM device to be started, or %NULL to stop the current device
 134 *
 135 * Call this function on a running isochronous stream to enable the actual
 136 * transmission of PCM data.  This function should be called from the PCM
 137 * device's .trigger callback.
 138 */
 139static inline void amdtp_out_stream_pcm_trigger(struct amdtp_out_stream *s,
 140                                                struct snd_pcm_substream *pcm)
 141{
 142        ACCESS_ONCE(s->pcm) = pcm;
 143}
 144
 145static inline bool cip_sfc_is_base_44100(enum cip_sfc sfc)
 146{
 147        return sfc & 1;
 148}
 149
 150#endif
 151