sound/firewire/motu/motu.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * motu.h - a part of driver for MOTU FireWire series
   4  *
   5  * Copyright (c) 2015-2017 Takashi Sakamoto <o-takashi@sakamocchi.jp>
   6  */
   7
   8 #ifndef SOUND_FIREWIRE_MOTU_H_INCLUDED
   9 #define SOUND_FIREWIRE_MOTU_H_INCLUDED
  10
  11 #include <linux/device.h>
  12 #include <linux/firewire.h>
  13 #include <linux/firewire-constants.h>
  14 #include <linux/module.h>
  15 #include <linux/mod_devicetable.h>
  16 #include <linux/mutex.h>
  17 #include <linux/slab.h>
  18 #include <linux/compat.h>
  19 #include <linux/sched/signal.h>
  20
  21 #include <sound/control.h>
  22 #include <sound/core.h>
  23 #include <sound/pcm.h>
  24 #include <sound/info.h>
  25 #include <sound/rawmidi.h>
  26 #include <sound/firewire.h>
  27 #include <sound/hwdep.h>
  28
  29 #include "../lib.h"
  30 #include "../amdtp-stream.h"
  31 #include "../iso-resources.h"
  32
  33 struct snd_motu_packet_format {
  34         unsigned char midi_flag_offset;
  35         unsigned char midi_byte_offset;
  36         unsigned char pcm_byte_offset;
  37
  38         unsigned char msg_chunks;
  39         unsigned char pcm_chunks[3];
  40 };
  41
  42 struct amdtp_motu_cache {
  43         unsigned int *event_offsets;
  44         unsigned int size;
  45         unsigned int tail;
  46         unsigned int tx_cycle_count;
  47         unsigned int head;
  48         unsigned int rx_cycle_count;
  49 };
  50
  51 struct snd_motu {
  52         struct snd_card *card;
  53         struct fw_unit *unit;
  54         struct mutex mutex;
  55         spinlock_t lock;
  56
  57         /* Model dependent information. */
  58         const struct snd_motu_spec *spec;
  59
  60         /* For packet streaming */
  61         struct snd_motu_packet_format tx_packet_formats;
  62         struct snd_motu_packet_format rx_packet_formats;
  63         struct amdtp_stream tx_stream;
  64         struct amdtp_stream rx_stream;
  65         struct fw_iso_resources tx_resources;
  66         struct fw_iso_resources rx_resources;
  67         unsigned int substreams_counter;
  68
  69         /* For notification. */
  70         struct fw_address_handler async_handler;
  71         u32 msg;
  72
  73         /* For uapi */
  74         int dev_lock_count;
  75         bool dev_lock_changed;
  76         wait_queue_head_t hwdep_wait;
  77
  78         struct amdtp_domain domain;
  79
  80         struct amdtp_motu_cache cache;
  81 };
  82
  83 enum snd_motu_spec_flags {
  84         SND_MOTU_SPEC_RX_MIDI_2ND_Q     = 0x0001,
  85         SND_MOTU_SPEC_RX_MIDI_3RD_Q     = 0x0002,
  86         SND_MOTU_SPEC_TX_MIDI_2ND_Q     = 0x0004,
  87         SND_MOTU_SPEC_TX_MIDI_3RD_Q     = 0x0008,
  88 };
  89
  90 #define SND_MOTU_CLOCK_RATE_COUNT       6
  91 extern const unsigned int snd_motu_clock_rates[SND_MOTU_CLOCK_RATE_COUNT];
  92
  93 enum snd_motu_clock_source {
  94         SND_MOTU_CLOCK_SOURCE_INTERNAL,
  95         SND_MOTU_CLOCK_SOURCE_ADAT_ON_DSUB,
  96         SND_MOTU_CLOCK_SOURCE_ADAT_ON_OPT,
  97         SND_MOTU_CLOCK_SOURCE_ADAT_ON_OPT_A,
  98         SND_MOTU_CLOCK_SOURCE_ADAT_ON_OPT_B,
  99         SND_MOTU_CLOCK_SOURCE_SPDIF_ON_OPT,
 100         SND_MOTU_CLOCK_SOURCE_SPDIF_ON_OPT_A,
 101         SND_MOTU_CLOCK_SOURCE_SPDIF_ON_OPT_B,
 102         SND_MOTU_CLOCK_SOURCE_SPDIF_ON_COAX,
 103         SND_MOTU_CLOCK_SOURCE_AESEBU_ON_XLR,
 104         SND_MOTU_CLOCK_SOURCE_WORD_ON_BNC,
 105         SND_MOTU_CLOCK_SOURCE_SPH,
 106         SND_MOTU_CLOCK_SOURCE_UNKNOWN,
 107 };
 108
 109 enum snd_motu_protocol_version {
 110         SND_MOTU_PROTOCOL_V2,
 111         SND_MOTU_PROTOCOL_V3,
 112 };
 113
 114 struct snd_motu_spec {
 115         const char *const name;
 116         enum snd_motu_protocol_version protocol_version;
 117         // The combination of snd_motu_spec_flags enumeration-constants.
 118         unsigned int flags;
 119
 120         unsigned char tx_fixed_pcm_chunks[3];
 121         unsigned char rx_fixed_pcm_chunks[3];
 122 };
 123
 124 extern const struct snd_motu_spec snd_motu_spec_828mk2;
 125 extern const struct snd_motu_spec snd_motu_spec_traveler;
 126 extern const struct snd_motu_spec snd_motu_spec_ultralite;
 127 extern const struct snd_motu_spec snd_motu_spec_8pre;
 128
 129 extern const struct snd_motu_spec snd_motu_spec_828mk3;
 130 extern const struct snd_motu_spec snd_motu_spec_ultralite_mk3;
 131 extern const struct snd_motu_spec snd_motu_spec_audio_express;
 132 extern const struct snd_motu_spec snd_motu_spec_4pre;
 133
 134 int amdtp_motu_init(struct amdtp_stream *s, struct fw_unit *unit,
 135                     enum amdtp_stream_direction dir,
 136                     const struct snd_motu_spec *spec,
 137                     struct amdtp_motu_cache *cache);
 138 int amdtp_motu_set_parameters(struct amdtp_stream *s, unsigned int rate,
 139                               unsigned int midi_ports,
 140                               struct snd_motu_packet_format *formats);
 141 int amdtp_motu_add_pcm_hw_constraints(struct amdtp_stream *s,
 142                                       struct snd_pcm_runtime *runtime);
 143 void amdtp_motu_midi_trigger(struct amdtp_stream *s, unsigned int port,
 144                              struct snd_rawmidi_substream *midi);
 145
 146 int snd_motu_transaction_read(struct snd_motu *motu, u32 offset, __be32 *reg,
 147                               size_t size);
 148 int snd_motu_transaction_write(struct snd_motu *motu, u32 offset, __be32 *reg,
 149                                size_t size);
 150 int snd_motu_transaction_register(struct snd_motu *motu);
 151 int snd_motu_transaction_reregister(struct snd_motu *motu);
 152 void snd_motu_transaction_unregister(struct snd_motu *motu);
 153
 154 int snd_motu_stream_init_duplex(struct snd_motu *motu);
 155 void snd_motu_stream_destroy_duplex(struct snd_motu *motu);
 156 int snd_motu_stream_cache_packet_formats(struct snd_motu *motu);
 157 int snd_motu_stream_reserve_duplex(struct snd_motu *motu, unsigned int rate,
 158                                    unsigned int frames_per_period,
 159                                    unsigned int frames_per_buffer);
 160 int snd_motu_stream_start_duplex(struct snd_motu *motu);
 161 void snd_motu_stream_stop_duplex(struct snd_motu *motu);
 162 int snd_motu_stream_lock_try(struct snd_motu *motu);
 163 void snd_motu_stream_lock_release(struct snd_motu *motu);
 164
 165 void snd_motu_proc_init(struct snd_motu *motu);
 166
 167 int snd_motu_create_pcm_devices(struct snd_motu *motu);
 168
 169 int snd_motu_create_midi_devices(struct snd_motu *motu);
 170
 171 int snd_motu_create_hwdep_device(struct snd_motu *motu);
 172
 173 int snd_motu_protocol_v2_get_clock_rate(struct snd_motu *motu,
 174                                         unsigned int *rate);
 175 int snd_motu_protocol_v2_set_clock_rate(struct snd_motu *motu,
 176                                         unsigned int rate);
 177 int snd_motu_protocol_v2_get_clock_source(struct snd_motu *motu,
 178                                           enum snd_motu_clock_source *src);
 179 int snd_motu_protocol_v2_switch_fetching_mode(struct snd_motu *motu,
 180                                               bool enable);
 181 int snd_motu_protocol_v2_cache_packet_formats(struct snd_motu *motu);
 182
 183 int snd_motu_protocol_v3_get_clock_rate(struct snd_motu *motu,
 184                                         unsigned int *rate);
 185 int snd_motu_protocol_v3_set_clock_rate(struct snd_motu *motu,
 186                                         unsigned int rate);
 187 int snd_motu_protocol_v3_get_clock_source(struct snd_motu *motu,
 188                                           enum snd_motu_clock_source *src);
 189 int snd_motu_protocol_v3_switch_fetching_mode(struct snd_motu *motu,
 190                                               bool enable);
 191 int snd_motu_protocol_v3_cache_packet_formats(struct snd_motu *motu);
 192
 193 static inline int snd_motu_protocol_get_clock_rate(struct snd_motu *motu,
 194                                                    unsigned int *rate)
 195 {
 196         if (motu->spec->protocol_version == SND_MOTU_PROTOCOL_V2)
 197                 return snd_motu_protocol_v2_get_clock_rate(motu, rate);
 198         else if (motu->spec->protocol_version == SND_MOTU_PROTOCOL_V3)
 199                 return snd_motu_protocol_v3_get_clock_rate(motu, rate);
 200         else
 201                 return -ENXIO;
 202 }
 203
 204 static inline int snd_motu_protocol_set_clock_rate(struct snd_motu *motu,
 205                                                    unsigned int rate)
 206 {
 207         if (motu->spec->protocol_version == SND_MOTU_PROTOCOL_V2)
 208                 return snd_motu_protocol_v2_set_clock_rate(motu, rate);
 209         else if (motu->spec->protocol_version == SND_MOTU_PROTOCOL_V3)
 210                 return snd_motu_protocol_v3_set_clock_rate(motu, rate);
 211         else
 212                 return -ENXIO;
 213 }
 214
 215 static inline int snd_motu_protocol_get_clock_source(struct snd_motu *motu,
 216                                         enum snd_motu_clock_source *source)
 217 {
 218         if (motu->spec->protocol_version == SND_MOTU_PROTOCOL_V2)
 219                 return snd_motu_protocol_v2_get_clock_source(motu, source);
 220         else if (motu->spec->protocol_version == SND_MOTU_PROTOCOL_V3)
 221                 return snd_motu_protocol_v3_get_clock_source(motu, source);
 222         else
 223                 return -ENXIO;
 224 }
 225
 226 static inline int snd_motu_protocol_switch_fetching_mode(struct snd_motu *motu,
 227                                                          bool enable)
 228 {
 229         if (motu->spec->protocol_version == SND_MOTU_PROTOCOL_V2)
 230                 return snd_motu_protocol_v2_switch_fetching_mode(motu, enable);
 231         else if (motu->spec->protocol_version == SND_MOTU_PROTOCOL_V3)
 232                 return snd_motu_protocol_v3_switch_fetching_mode(motu, enable);
 233         else
 234                 return -ENXIO;
 235 }
 236
 237 static inline int snd_motu_protocol_cache_packet_formats(struct snd_motu *motu)
 238 {
 239         if (motu->spec->protocol_version == SND_MOTU_PROTOCOL_V2)
 240                 return snd_motu_protocol_v2_cache_packet_formats(motu);
 241         else if (motu->spec->protocol_version == SND_MOTU_PROTOCOL_V3)
 242                 return snd_motu_protocol_v3_cache_packet_formats(motu);
 243         else
 244                 return -ENXIO;
 245 }
 246
 247 #endif