sound/firewire/bebob/bebob.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * bebob.h - a part of driver for BeBoB based devices
   4  *
   5  * Copyright (c) 2013-2014 Takashi Sakamoto
   6  */
   7
   8 #ifndef SOUND_BEBOB_H_INCLUDED
   9 #define SOUND_BEBOB_H_INCLUDED
  10
  11 #include <linux/compat.h>
  12 #include <linux/device.h>
  13 #include <linux/firewire.h>
  14 #include <linux/firewire-constants.h>
  15 #include <linux/module.h>
  16 #include <linux/mod_devicetable.h>
  17 #include <linux/delay.h>
  18 #include <linux/slab.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/rawmidi.h>
  25 #include <sound/pcm.h>
  26 #include <sound/pcm_params.h>
  27 #include <sound/firewire.h>
  28 #include <sound/hwdep.h>
  29
  30 #include "../lib.h"
  31 #include "../fcp.h"
  32 #include "../packets-buffer.h"
  33 #include "../iso-resources.h"
  34 #include "../amdtp-am824.h"
  35 #include "../cmp.h"
  36
  37 /* basic register addresses on DM1000/DM1100/DM1500 */
  38 #define BEBOB_ADDR_REG_INFO     0xffffc8020000ULL
  39 #define BEBOB_ADDR_REG_REQ      0xffffc8021000ULL
  40
  41 struct snd_bebob;
  42
  43 #define SND_BEBOB_STRM_FMT_ENTRIES      7
  44 struct snd_bebob_stream_formation {
  45         unsigned int pcm;
  46         unsigned int midi;
  47 };
  48 /* this is a lookup table for index of stream formations */
  49 extern const unsigned int snd_bebob_rate_table[SND_BEBOB_STRM_FMT_ENTRIES];
  50
  51 /* device specific operations */
  52 enum snd_bebob_clock_type {
  53         SND_BEBOB_CLOCK_TYPE_INTERNAL = 0,
  54         SND_BEBOB_CLOCK_TYPE_EXTERNAL,
  55         SND_BEBOB_CLOCK_TYPE_SYT,
  56 };
  57 struct snd_bebob_clock_spec {
  58         unsigned int num;
  59         const char *const *labels;
  60         const enum snd_bebob_clock_type *types;
  61         int (*get)(struct snd_bebob *bebob, unsigned int *id);
  62 };
  63 struct snd_bebob_rate_spec {
  64         int (*get)(struct snd_bebob *bebob, unsigned int *rate);
  65         int (*set)(struct snd_bebob *bebob, unsigned int rate);
  66 };
  67 struct snd_bebob_meter_spec {
  68         unsigned int num;
  69         const char *const *labels;
  70         int (*get)(struct snd_bebob *bebob, u32 *target, unsigned int size);
  71 };
  72 struct snd_bebob_spec {
  73         const struct snd_bebob_clock_spec *clock;
  74         const struct snd_bebob_rate_spec *rate;
  75         const struct snd_bebob_meter_spec *meter;
  76 };
  77
  78 struct snd_bebob {
  79         struct snd_card *card;
  80         struct fw_unit *unit;
  81         int card_index;
  82
  83         struct mutex mutex;
  84         spinlock_t lock;
  85
  86         bool registered;
  87         struct delayed_work dwork;
  88
  89         const struct ieee1394_device_id *entry;
  90         const struct snd_bebob_spec *spec;
  91
  92         unsigned int midi_input_ports;
  93         unsigned int midi_output_ports;
  94
  95         struct amdtp_stream tx_stream;
  96         struct amdtp_stream rx_stream;
  97         struct cmp_connection out_conn;
  98         struct cmp_connection in_conn;
  99         unsigned int substreams_counter;
 100
 101         struct snd_bebob_stream_formation
 102                 tx_stream_formations[SND_BEBOB_STRM_FMT_ENTRIES];
 103         struct snd_bebob_stream_formation
 104                 rx_stream_formations[SND_BEBOB_STRM_FMT_ENTRIES];
 105
 106         int sync_input_plug;
 107
 108         /* for uapi */
 109         int dev_lock_count;
 110         bool dev_lock_changed;
 111         wait_queue_head_t hwdep_wait;
 112
 113         /* for M-Audio special devices */
 114         void *maudio_special_quirk;
 115
 116         /* For BeBoB version quirk. */
 117         unsigned int version;
 118
 119         struct amdtp_domain domain;
 120 };
 121
 122 static inline int
 123 snd_bebob_read_block(struct fw_unit *unit, u64 addr, void *buf, int size)
 124 {
 125         return snd_fw_transaction(unit, TCODE_READ_BLOCK_REQUEST,
 126                                   BEBOB_ADDR_REG_INFO + addr,
 127                                   buf, size, 0);
 128 }
 129
 130 static inline int
 131 snd_bebob_read_quad(struct fw_unit *unit, u64 addr, u32 *buf)
 132 {
 133         return snd_fw_transaction(unit, TCODE_READ_QUADLET_REQUEST,
 134                                   BEBOB_ADDR_REG_INFO + addr,
 135                                   (void *)buf, sizeof(u32), 0);
 136 }
 137
 138 /* AV/C Audio Subunit Specification 1.0 (Oct 2000, 1394TA) */
 139 int avc_audio_set_selector(struct fw_unit *unit, unsigned int subunit_id,
 140                            unsigned int fb_id, unsigned int num);
 141 int avc_audio_get_selector(struct fw_unit *unit, unsigned  int subunit_id,
 142                            unsigned int fb_id, unsigned int *num);
 143
 144 /*
 145  * AVC command extensions, AV/C Unit and Subunit, Revision 17
 146  * (Nov 2003, BridgeCo)
 147  */
 148 #define AVC_BRIDGECO_ADDR_BYTES 6
 149 enum avc_bridgeco_plug_dir {
 150         AVC_BRIDGECO_PLUG_DIR_IN        = 0x00,
 151         AVC_BRIDGECO_PLUG_DIR_OUT       = 0x01
 152 };
 153 enum avc_bridgeco_plug_mode {
 154         AVC_BRIDGECO_PLUG_MODE_UNIT             = 0x00,
 155         AVC_BRIDGECO_PLUG_MODE_SUBUNIT          = 0x01,
 156         AVC_BRIDGECO_PLUG_MODE_FUNCTION_BLOCK   = 0x02
 157 };
 158 enum avc_bridgeco_plug_unit {
 159         AVC_BRIDGECO_PLUG_UNIT_ISOC     = 0x00,
 160         AVC_BRIDGECO_PLUG_UNIT_EXT      = 0x01,
 161         AVC_BRIDGECO_PLUG_UNIT_ASYNC    = 0x02
 162 };
 163 enum avc_bridgeco_plug_type {
 164         AVC_BRIDGECO_PLUG_TYPE_ISOC     = 0x00,
 165         AVC_BRIDGECO_PLUG_TYPE_ASYNC    = 0x01,
 166         AVC_BRIDGECO_PLUG_TYPE_MIDI     = 0x02,
 167         AVC_BRIDGECO_PLUG_TYPE_SYNC     = 0x03,
 168         AVC_BRIDGECO_PLUG_TYPE_ANA      = 0x04,
 169         AVC_BRIDGECO_PLUG_TYPE_DIG      = 0x05,
 170         AVC_BRIDGECO_PLUG_TYPE_ADDITION = 0x06
 171 };
 172 static inline void
 173 avc_bridgeco_fill_unit_addr(u8 buf[AVC_BRIDGECO_ADDR_BYTES],
 174                             enum avc_bridgeco_plug_dir dir,
 175                             enum avc_bridgeco_plug_unit unit,
 176                             unsigned int pid)
 177 {
 178         buf[0] = 0xff;  /* Unit */
 179         buf[1] = dir;
 180         buf[2] = AVC_BRIDGECO_PLUG_MODE_UNIT;
 181         buf[3] = unit;
 182         buf[4] = 0xff & pid;
 183         buf[5] = 0xff;  /* reserved */
 184 }
 185 static inline void
 186 avc_bridgeco_fill_msu_addr(u8 buf[AVC_BRIDGECO_ADDR_BYTES],
 187                            enum avc_bridgeco_plug_dir dir,
 188                            unsigned int pid)
 189 {
 190         buf[0] = 0x60;  /* Music subunit */
 191         buf[1] = dir;
 192         buf[2] = AVC_BRIDGECO_PLUG_MODE_SUBUNIT;
 193         buf[3] = 0xff & pid;
 194         buf[4] = 0xff;  /* reserved */
 195         buf[5] = 0xff;  /* reserved */
 196 }
 197 int avc_bridgeco_get_plug_ch_pos(struct fw_unit *unit,
 198                                  u8 addr[AVC_BRIDGECO_ADDR_BYTES],
 199                                  u8 *buf, unsigned int len);
 200 int avc_bridgeco_get_plug_type(struct fw_unit *unit,
 201                                u8 addr[AVC_BRIDGECO_ADDR_BYTES],
 202                                enum avc_bridgeco_plug_type *type);
 203 int avc_bridgeco_get_plug_section_type(struct fw_unit *unit,
 204                                        u8 addr[AVC_BRIDGECO_ADDR_BYTES],
 205                                        unsigned int id, u8 *type);
 206 int avc_bridgeco_get_plug_input(struct fw_unit *unit,
 207                                 u8 addr[AVC_BRIDGECO_ADDR_BYTES],
 208                                 u8 input[7]);
 209 int avc_bridgeco_get_plug_strm_fmt(struct fw_unit *unit,
 210                                    u8 addr[AVC_BRIDGECO_ADDR_BYTES], u8 *buf,
 211                                    unsigned int *len, unsigned int eid);
 212
 213 /* for AMDTP streaming */
 214 int snd_bebob_stream_get_rate(struct snd_bebob *bebob, unsigned int *rate);
 215 int snd_bebob_stream_set_rate(struct snd_bebob *bebob, unsigned int rate);
 216 int snd_bebob_stream_get_clock_src(struct snd_bebob *bebob,
 217                                    enum snd_bebob_clock_type *src);
 218 int snd_bebob_stream_discover(struct snd_bebob *bebob);
 219 int snd_bebob_stream_init_duplex(struct snd_bebob *bebob);
 220 int snd_bebob_stream_reserve_duplex(struct snd_bebob *bebob, unsigned int rate,
 221                                     unsigned int frames_per_period,
 222                                     unsigned int frames_per_buffer);
 223 int snd_bebob_stream_start_duplex(struct snd_bebob *bebob);
 224 void snd_bebob_stream_stop_duplex(struct snd_bebob *bebob);
 225 void snd_bebob_stream_destroy_duplex(struct snd_bebob *bebob);
 226
 227 void snd_bebob_stream_lock_changed(struct snd_bebob *bebob);
 228 int snd_bebob_stream_lock_try(struct snd_bebob *bebob);
 229 void snd_bebob_stream_lock_release(struct snd_bebob *bebob);
 230
 231 void snd_bebob_proc_init(struct snd_bebob *bebob);
 232
 233 int snd_bebob_create_midi_devices(struct snd_bebob *bebob);
 234
 235 int snd_bebob_create_pcm_devices(struct snd_bebob *bebob);
 236
 237 int snd_bebob_create_hwdep_device(struct snd_bebob *bebob);
 238
 239 /* model specific operations */
 240 extern const struct snd_bebob_spec phase88_rack_spec;
 241 extern const struct snd_bebob_spec yamaha_terratec_spec;
 242 extern const struct snd_bebob_spec saffirepro_26_spec;
 243 extern const struct snd_bebob_spec saffirepro_10_spec;
 244 extern const struct snd_bebob_spec saffire_le_spec;
 245 extern const struct snd_bebob_spec saffire_spec;
 246 extern const struct snd_bebob_spec maudio_fw410_spec;
 247 extern const struct snd_bebob_spec maudio_audiophile_spec;
 248 extern const struct snd_bebob_spec maudio_solo_spec;
 249 extern const struct snd_bebob_spec maudio_ozonic_spec;
 250 extern const struct snd_bebob_spec maudio_nrv10_spec;
 251 extern const struct snd_bebob_spec maudio_special_spec;
 252 int snd_bebob_maudio_special_discover(struct snd_bebob *bebob, bool is1814);
 253 int snd_bebob_maudio_load_firmware(struct fw_unit *unit);
 254
 255 #define SND_BEBOB_DEV_ENTRY(vendor, model, data) \
 256 { \
 257         .match_flags    = IEEE1394_MATCH_VENDOR_ID | \
 258                           IEEE1394_MATCH_MODEL_ID, \
 259         .vendor_id      = vendor, \
 260         .model_id       = model, \
 261         .driver_data    = (kernel_ulong_t)data \
 262 }
 263
 264 #endif