sound/firewire/fireworks/fireworks.h

   1 /*
   2  * fireworks.h - a part of driver for Fireworks based devices
   3  *
   4  * Copyright (c) 2009-2010 Clemens Ladisch
   5  * Copyright (c) 2013-2014 Takashi Sakamoto
   6  *
   7  * Licensed under the terms of the GNU General Public License, version 2.
   8  */
   9 #ifndef SOUND_FIREWORKS_H_INCLUDED
  10 #define SOUND_FIREWORKS_H_INCLUDED
  11
  12 #include <linux/compat.h>
  13 #include <linux/device.h>
  14 #include <linux/firewire.h>
  15 #include <linux/firewire-constants.h>
  16 #include <linux/module.h>
  17 #include <linux/mod_devicetable.h>
  18 #include <linux/delay.h>
  19 #include <linux/slab.h>
  20
  21 #include <sound/core.h>
  22 #include <sound/initval.h>
  23 #include <sound/pcm.h>
  24
  25 #include "../packets-buffer.h"
  26 #include "../iso-resources.h"
  27 #include "../amdtp.h"
  28 #include "../cmp.h"
  29 #include "../lib.h"
  30
  31 #define SND_EFW_MAX_MIDI_OUT_PORTS      2
  32 #define SND_EFW_MAX_MIDI_IN_PORTS       2
  33
  34 #define SND_EFW_MULTIPLIER_MODES        3
  35 #define HWINFO_NAME_SIZE_BYTES          32
  36 #define HWINFO_MAX_CAPS_GROUPS          8
  37
  38 /*
  39  * This should be greater than maximum bytes for EFW response content.
  40  * Currently response against command for isochronous channel mapping is
  41  * confirmed to be the maximum one. But for flexibility, use maximum data
  42  * payload for asynchronous primary packets at S100 (Cable base rate) in
  43  * IEEE Std 1394-1995.
  44  */
  45 #define SND_EFW_RESPONSE_MAXIMUM_BYTES  0x200U
  46
  47 struct snd_efw_phys_grp {
  48         u8 type;        /* see enum snd_efw_grp_type */
  49         u8 count;
  50 } __packed;
  51
  52 struct snd_efw {
  53         struct snd_card *card;
  54         struct fw_unit *unit;
  55         int card_index;
  56
  57         struct mutex mutex;
  58         spinlock_t lock;
  59
  60         /* for transaction */
  61         u32 seqnum;
  62         bool resp_addr_changable;
  63
  64         /* for quirks */
  65         bool is_af9;
  66         u32 firmware_version;
  67
  68         unsigned int midi_in_ports;
  69         unsigned int midi_out_ports;
  70
  71         unsigned int supported_sampling_rate;
  72         unsigned int pcm_capture_channels[SND_EFW_MULTIPLIER_MODES];
  73         unsigned int pcm_playback_channels[SND_EFW_MULTIPLIER_MODES];
  74
  75         struct amdtp_stream *master;
  76         struct amdtp_stream tx_stream;
  77         struct amdtp_stream rx_stream;
  78         struct cmp_connection out_conn;
  79         struct cmp_connection in_conn;
  80         atomic_t capture_substreams;
  81         atomic_t playback_substreams;
  82 };
  83
  84 struct snd_efw_transaction {
  85         __be32 length;
  86         __be32 version;
  87         __be32 seqnum;
  88         __be32 category;
  89         __be32 command;
  90         __be32 status;
  91         __be32 params[0];
  92 };
  93 int snd_efw_transaction_run(struct fw_unit *unit,
  94                             const void *cmd, unsigned int cmd_size,
  95                             void *resp, unsigned int resp_size);
  96 int snd_efw_transaction_register(void);
  97 void snd_efw_transaction_unregister(void);
  98 void snd_efw_transaction_bus_reset(struct fw_unit *unit);
  99
 100 struct snd_efw_hwinfo {
 101         u32 flags;
 102         u32 guid_hi;
 103         u32 guid_lo;
 104         u32 type;
 105         u32 version;
 106         char vendor_name[HWINFO_NAME_SIZE_BYTES];
 107         char model_name[HWINFO_NAME_SIZE_BYTES];
 108         u32 supported_clocks;
 109         u32 amdtp_rx_pcm_channels;
 110         u32 amdtp_tx_pcm_channels;
 111         u32 phys_out;
 112         u32 phys_in;
 113         u32 phys_out_grp_count;
 114         struct snd_efw_phys_grp phys_out_grps[HWINFO_MAX_CAPS_GROUPS];
 115         u32 phys_in_grp_count;
 116         struct snd_efw_phys_grp phys_in_grps[HWINFO_MAX_CAPS_GROUPS];
 117         u32 midi_out_ports;
 118         u32 midi_in_ports;
 119         u32 max_sample_rate;
 120         u32 min_sample_rate;
 121         u32 dsp_version;
 122         u32 arm_version;
 123         u32 mixer_playback_channels;
 124         u32 mixer_capture_channels;
 125         u32 fpga_version;
 126         u32 amdtp_rx_pcm_channels_2x;
 127         u32 amdtp_tx_pcm_channels_2x;
 128         u32 amdtp_rx_pcm_channels_4x;
 129         u32 amdtp_tx_pcm_channels_4x;
 130         u32 reserved[16];
 131 } __packed;
 132 enum snd_efw_grp_type {
 133         SND_EFW_CH_TYPE_ANALOG                  = 0,
 134         SND_EFW_CH_TYPE_SPDIF                   = 1,
 135         SND_EFW_CH_TYPE_ADAT                    = 2,
 136         SND_EFW_CH_TYPE_SPDIF_OR_ADAT           = 3,
 137         SND_EFW_CH_TYPE_ANALOG_MIRRORING        = 4,
 138         SND_EFW_CH_TYPE_HEADPHONES              = 5,
 139         SND_EFW_CH_TYPE_I2S                     = 6,
 140         SND_EFW_CH_TYPE_GUITAR                  = 7,
 141         SND_EFW_CH_TYPE_PIEZO_GUITAR            = 8,
 142         SND_EFW_CH_TYPE_GUITAR_STRING           = 9,
 143         SND_EFW_CH_TYPE_VIRTUAL                 = 0x10000,
 144         SND_EFW_CH_TYPE_DUMMY
 145 };
 146 struct snd_efw_phys_meters {
 147         u32 status;     /* guitar state/midi signal/clock input detect */
 148         u32 reserved0;
 149         u32 reserved1;
 150         u32 reserved2;
 151         u32 reserved3;
 152         u32 out_meters;
 153         u32 in_meters;
 154         u32 reserved4;
 155         u32 reserved5;
 156         u32 values[0];
 157 } __packed;
 158 enum snd_efw_clock_source {
 159         SND_EFW_CLOCK_SOURCE_INTERNAL   = 0,
 160         SND_EFW_CLOCK_SOURCE_SYTMATCH   = 1,
 161         SND_EFW_CLOCK_SOURCE_WORDCLOCK  = 2,
 162         SND_EFW_CLOCK_SOURCE_SPDIF      = 3,
 163         SND_EFW_CLOCK_SOURCE_ADAT_1     = 4,
 164         SND_EFW_CLOCK_SOURCE_ADAT_2     = 5,
 165         SND_EFW_CLOCK_SOURCE_CONTINUOUS = 6     /* internal variable clock */
 166 };
 167 enum snd_efw_transport_mode {
 168         SND_EFW_TRANSPORT_MODE_WINDOWS  = 0,
 169         SND_EFW_TRANSPORT_MODE_IEC61883 = 1,
 170 };
 171 int snd_efw_command_set_resp_addr(struct snd_efw *efw,
 172                                   u16 addr_high, u32 addr_low);
 173 int snd_efw_command_set_tx_mode(struct snd_efw *efw, unsigned int mode);
 174 int snd_efw_command_get_hwinfo(struct snd_efw *efw,
 175                                struct snd_efw_hwinfo *hwinfo);
 176 int snd_efw_command_get_phys_meters(struct snd_efw *efw,
 177                                     struct snd_efw_phys_meters *meters,
 178                                     unsigned int len);
 179 int snd_efw_command_get_clock_source(struct snd_efw *efw,
 180                                      enum snd_efw_clock_source *source);
 181 int snd_efw_command_get_sampling_rate(struct snd_efw *efw, unsigned int *rate);
 182 int snd_efw_command_set_sampling_rate(struct snd_efw *efw, unsigned int rate);
 183
 184 int snd_efw_stream_init_duplex(struct snd_efw *efw);
 185 int snd_efw_stream_start_duplex(struct snd_efw *efw, int sampling_rate);
 186 void snd_efw_stream_stop_duplex(struct snd_efw *efw);
 187 void snd_efw_stream_update_duplex(struct snd_efw *efw);
 188 void snd_efw_stream_destroy_duplex(struct snd_efw *efw);
 189
 190 #define SND_EFW_DEV_ENTRY(vendor, model) \
 191 { \
 192         .match_flags    = IEEE1394_MATCH_VENDOR_ID | \
 193                           IEEE1394_MATCH_MODEL_ID, \
 194         .vendor_id      = vendor,\
 195         .model_id       = model \
 196 }
 197
 198 #endif