sound/firewire/tascam/tascam.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * tascam.h - a part of driver for TASCAM FireWire series
   4  *
   5  * Copyright (c) 2015 Takashi Sakamoto
   6  */
   7
   8 #ifndef SOUND_TASCAM_H_INCLUDED
   9 #define SOUND_TASCAM_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/core.h>
  22 #include <sound/initval.h>
  23 #include <sound/info.h>
  24 #include <sound/pcm.h>
  25 #include <sound/pcm_params.h>
  26 #include <sound/firewire.h>
  27 #include <sound/hwdep.h>
  28 #include <sound/rawmidi.h>
  29
  30 #include "../lib.h"
  31 #include "../amdtp-stream.h"
  32 #include "../iso-resources.h"
  33
  34 struct snd_tscm_spec {
  35         const char *const name;
  36         bool has_adat;
  37         bool has_spdif;
  38         unsigned int pcm_capture_analog_channels;
  39         unsigned int pcm_playback_analog_channels;
  40         unsigned int midi_capture_ports;
  41         unsigned int midi_playback_ports;
  42 };
  43
  44 #define TSCM_MIDI_IN_PORT_MAX   4
  45 #define TSCM_MIDI_OUT_PORT_MAX  4
  46
  47 struct snd_fw_async_midi_port {
  48         struct fw_device *parent;
  49         struct work_struct work;
  50         bool idling;
  51         ktime_t next_ktime;
  52         bool error;
  53
  54         struct fw_transaction transaction;
  55
  56         u8 buf[4];
  57         u8 running_status;
  58         bool on_sysex;
  59
  60         struct snd_rawmidi_substream *substream;
  61         int consume_bytes;
  62 };
  63
  64 #define SND_TSCM_QUEUE_COUNT    16
  65
  66 struct snd_tscm {
  67         struct snd_card *card;
  68         struct fw_unit *unit;
  69
  70         struct mutex mutex;
  71         spinlock_t lock;
  72
  73         bool registered;
  74         struct delayed_work dwork;
  75         const struct snd_tscm_spec *spec;
  76
  77         struct fw_iso_resources tx_resources;
  78         struct fw_iso_resources rx_resources;
  79         struct amdtp_stream tx_stream;
  80         struct amdtp_stream rx_stream;
  81         unsigned int substreams_counter;
  82
  83         int dev_lock_count;
  84         bool dev_lock_changed;
  85         wait_queue_head_t hwdep_wait;
  86
  87         /* For MIDI message incoming transactions. */
  88         struct fw_address_handler async_handler;
  89         struct snd_rawmidi_substream *tx_midi_substreams[TSCM_MIDI_IN_PORT_MAX];
  90
  91         /* For MIDI message outgoing transactions. */
  92         struct snd_fw_async_midi_port out_ports[TSCM_MIDI_OUT_PORT_MAX];
  93
  94         // A cache of status information in tx isoc packets.
  95         __be32 state[SNDRV_FIREWIRE_TASCAM_STATE_COUNT];
  96         struct snd_hwdep *hwdep;
  97         struct snd_firewire_tascam_change queue[SND_TSCM_QUEUE_COUNT];
  98         unsigned int pull_pos;
  99         unsigned int push_pos;
 100
 101         struct amdtp_domain domain;
 102 };
 103
 104 #define TSCM_ADDR_BASE                  0xffff00000000ull
 105
 106 #define TSCM_OFFSET_FIRMWARE_REGISTER   0x0000
 107 #define TSCM_OFFSET_FIRMWARE_FPGA       0x0004
 108 #define TSCM_OFFSET_FIRMWARE_ARM        0x0008
 109 #define TSCM_OFFSET_FIRMWARE_HW         0x000c
 110
 111 #define TSCM_OFFSET_ISOC_TX_CH          0x0200
 112 #define TSCM_OFFSET_UNKNOWN             0x0204
 113 #define TSCM_OFFSET_START_STREAMING     0x0208
 114 #define TSCM_OFFSET_ISOC_RX_CH          0x020c
 115 #define TSCM_OFFSET_ISOC_RX_ON          0x0210  /* Little conviction. */
 116 #define TSCM_OFFSET_TX_PCM_CHANNELS     0x0214
 117 #define TSCM_OFFSET_RX_PCM_CHANNELS     0x0218
 118 #define TSCM_OFFSET_MULTIPLEX_MODE      0x021c
 119 #define TSCM_OFFSET_ISOC_TX_ON          0x0220
 120 /* Unknown                              0x0224 */
 121 #define TSCM_OFFSET_CLOCK_STATUS        0x0228
 122 #define TSCM_OFFSET_SET_OPTION          0x022c
 123
 124 #define TSCM_OFFSET_MIDI_TX_ON          0x0300
 125 #define TSCM_OFFSET_MIDI_TX_ADDR_HI     0x0304
 126 #define TSCM_OFFSET_MIDI_TX_ADDR_LO     0x0308
 127
 128 #define TSCM_OFFSET_LED_POWER           0x0404
 129
 130 #define TSCM_OFFSET_MIDI_RX_QUAD        0x4000
 131
 132 // Although FE-8 supports the above registers, it has no I/O interfaces for
 133 // audio samples and music messages. Otherwise it supports another notification
 134 // for status and control message as well as LED brightening. The message
 135 // consists of quadlet-aligned data up to 32 quadlets. The first byte of message
 136 // is fixed to 0x40. The second byte is between 0x00 to 0x1f and represent each
 137 // control:
 138 //   fader:     0x00-0x07
 139 //   button:    0x0d, 0x0e
 140 //   knob:      0x14-0x1b
 141 //   sensing:   0x0b
 142 //
 143 // The rest two bytes represent state of the controls; e.g. current value for
 144 // fader and knob, bitmasks for button and sensing.
 145 // Just after turning on, 32 quadlets messages with 0x00-0x1f are immediately
 146 // sent in one transaction. After, several quadlets are sent in one transaction.
 147 //
 148 // TSCM_OFFSET_FE8_CTL_TX_ON            0x0310
 149 // TSCM_OFFSET_FE8_CTL_TX_ADDR_HI       0x0314
 150 // TSCM_OFFSET_FE8_CTL_TX_ADDR_LO       0x0318
 151
 152 enum snd_tscm_clock {
 153         SND_TSCM_CLOCK_INTERNAL = 0,
 154         SND_TSCM_CLOCK_WORD     = 1,
 155         SND_TSCM_CLOCK_SPDIF    = 2,
 156         SND_TSCM_CLOCK_ADAT     = 3,
 157 };
 158
 159 int amdtp_tscm_init(struct amdtp_stream *s, struct fw_unit *unit,
 160                   enum amdtp_stream_direction dir, unsigned int pcm_channels);
 161 int amdtp_tscm_set_parameters(struct amdtp_stream *s, unsigned int rate);
 162 int amdtp_tscm_add_pcm_hw_constraints(struct amdtp_stream *s,
 163                                       struct snd_pcm_runtime *runtime);
 164
 165 int snd_tscm_stream_get_rate(struct snd_tscm *tscm, unsigned int *rate);
 166 int snd_tscm_stream_get_clock(struct snd_tscm *tscm,
 167                               enum snd_tscm_clock *clock);
 168 int snd_tscm_stream_init_duplex(struct snd_tscm *tscm);
 169 void snd_tscm_stream_update_duplex(struct snd_tscm *tscm);
 170 void snd_tscm_stream_destroy_duplex(struct snd_tscm *tscm);
 171 int snd_tscm_stream_reserve_duplex(struct snd_tscm *tscm, unsigned int rate);
 172 int snd_tscm_stream_start_duplex(struct snd_tscm *tscm, unsigned int rate);
 173 void snd_tscm_stream_stop_duplex(struct snd_tscm *tscm);
 174
 175 void snd_tscm_stream_lock_changed(struct snd_tscm *tscm);
 176 int snd_tscm_stream_lock_try(struct snd_tscm *tscm);
 177 void snd_tscm_stream_lock_release(struct snd_tscm *tscm);
 178
 179 void snd_fw_async_midi_port_init(struct snd_fw_async_midi_port *port);
 180
 181 static inline void
 182 snd_fw_async_midi_port_run(struct snd_fw_async_midi_port *port,
 183                            struct snd_rawmidi_substream *substream)
 184 {
 185         if (!port->error) {
 186                 port->substream = substream;
 187                 schedule_work(&port->work);
 188         }
 189 }
 190
 191 static inline void
 192 snd_fw_async_midi_port_finish(struct snd_fw_async_midi_port *port)
 193 {
 194         port->substream = NULL;
 195         cancel_work_sync(&port->work);
 196         port->error = false;
 197 }
 198
 199 int snd_tscm_transaction_register(struct snd_tscm *tscm);
 200 int snd_tscm_transaction_reregister(struct snd_tscm *tscm);
 201 void snd_tscm_transaction_unregister(struct snd_tscm *tscm);
 202
 203 void snd_tscm_proc_init(struct snd_tscm *tscm);
 204
 205 int snd_tscm_create_pcm_devices(struct snd_tscm *tscm);
 206
 207 int snd_tscm_create_midi_devices(struct snd_tscm *tscm);
 208
 209 int snd_tscm_create_hwdep_device(struct snd_tscm *tscm);
 210
 211 #endif