sound/firewire/oxfw/oxfw.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * oxfw.h - a part of driver for OXFW970/971 based devices
   4  *
   5  * Copyright (c) Clemens Ladisch <[email protected]>
   6  */
   7
   8 #include <linux/device.h>
   9 #include <linux/firewire.h>
  10 #include <linux/firewire-constants.h>
  11 #include <linux/module.h>
  12 #include <linux/mod_devicetable.h>
  13 #include <linux/mutex.h>
  14 #include <linux/slab.h>
  15 #include <linux/compat.h>
  16 #include <linux/sched/signal.h>
  17
  18 #include <sound/control.h>
  19 #include <sound/core.h>
  20 #include <sound/initval.h>
  21 #include <sound/pcm.h>
  22 #include <sound/pcm_params.h>
  23 #include <sound/info.h>
  24 #include <sound/rawmidi.h>
  25 #include <sound/firewire.h>
  26 #include <sound/hwdep.h>
  27
  28 #include "../lib.h"
  29 #include "../fcp.h"
  30 #include "../packets-buffer.h"
  31 #include "../iso-resources.h"
  32 #include "../amdtp-am824.h"
  33 #include "../cmp.h"
  34
  35 enum snd_oxfw_quirk {
  36         // Postpone transferring packets during handling asynchronous transaction. As a result,
  37         // next isochronous packet includes more events than one packet can include.
  38         SND_OXFW_QUIRK_JUMBO_PAYLOAD = 0x01,
  39         // The dbs field of CIP header in tx packet is wrong.
  40         SND_OXFW_QUIRK_WRONG_DBS = 0x02,
  41         // Blocking transmission mode is used.
  42         SND_OXFW_QUIRK_BLOCKING_TRANSMISSION = 0x04,
  43         // Stanton SCS1.d and SCS1.m support unique transaction.
  44         SND_OXFW_QUIRK_SCS_TRANSACTION = 0x08,
  45         // Apogee Duet FireWire ignores data blocks in packet with NO_INFO for audio data
  46         // processing, while output level meter moves. Any value in syt field of packet takes
  47         // the device to process audio data even if the value is invalid in a point of
  48         // IEC 61883-1/6.
  49         SND_OXFW_QUIRK_IGNORE_NO_INFO_PACKET = 0x10,
  50 };
  51
  52 /* This is an arbitrary number for convinience. */
  53 #define SND_OXFW_STREAM_FORMAT_ENTRIES  10
  54 struct snd_oxfw {
  55         struct snd_card *card;
  56         struct fw_unit *unit;
  57         struct mutex mutex;
  58         spinlock_t lock;
  59
  60         // The combination of snd_oxfw_quirk enumeration-constants.
  61         unsigned int quirks;
  62         bool has_output;
  63         bool has_input;
  64         u8 *tx_stream_formats[SND_OXFW_STREAM_FORMAT_ENTRIES];
  65         u8 *rx_stream_formats[SND_OXFW_STREAM_FORMAT_ENTRIES];
  66         bool assumed;
  67         struct cmp_connection out_conn;
  68         struct cmp_connection in_conn;
  69         struct amdtp_stream tx_stream;
  70         struct amdtp_stream rx_stream;
  71         unsigned int substreams_count;
  72
  73         unsigned int midi_input_ports;
  74         unsigned int midi_output_ports;
  75
  76         int dev_lock_count;
  77         bool dev_lock_changed;
  78         wait_queue_head_t hwdep_wait;
  79
  80         void *spec;
  81
  82         struct amdtp_domain domain;
  83 };
  84
  85 /*
  86  * AV/C Stream Format Information Specification 1.1 Working Draft
  87  * (Apr 2005, 1394TA)
  88  */
  89 int avc_stream_set_format(struct fw_unit *unit, enum avc_general_plug_dir dir,
  90                           unsigned int pid, u8 *format, unsigned int len);
  91 int avc_stream_get_format(struct fw_unit *unit,
  92                           enum avc_general_plug_dir dir, unsigned int pid,
  93                           u8 *buf, unsigned int *len, unsigned int eid);
  94 static inline int
  95 avc_stream_get_format_single(struct fw_unit *unit,
  96                              enum avc_general_plug_dir dir, unsigned int pid,
  97                              u8 *buf, unsigned int *len)
  98 {
  99         return avc_stream_get_format(unit, dir, pid, buf, len, 0xff);
 100 }
 101 static inline int
 102 avc_stream_get_format_list(struct fw_unit *unit,
 103                            enum avc_general_plug_dir dir, unsigned int pid,
 104                            u8 *buf, unsigned int *len,
 105                            unsigned int eid)
 106 {
 107         return avc_stream_get_format(unit, dir, pid, buf, len, eid);
 108 }
 109
 110 /*
 111  * AV/C Digital Interface Command Set General Specification 4.2
 112  * (Sep 2004, 1394TA)
 113  */
 114 int avc_general_inquiry_sig_fmt(struct fw_unit *unit, unsigned int rate,
 115                                 enum avc_general_plug_dir dir,
 116                                 unsigned short pid);
 117
 118 int snd_oxfw_stream_init_duplex(struct snd_oxfw *oxfw);
 119 int snd_oxfw_stream_reserve_duplex(struct snd_oxfw *oxfw,
 120                                    struct amdtp_stream *stream,
 121                                    unsigned int rate, unsigned int pcm_channels,
 122                                    unsigned int frames_per_period,
 123                                    unsigned int frames_per_buffer);
 124 int snd_oxfw_stream_start_duplex(struct snd_oxfw *oxfw);
 125 void snd_oxfw_stream_stop_duplex(struct snd_oxfw *oxfw);
 126 void snd_oxfw_stream_destroy_duplex(struct snd_oxfw *oxfw);
 127 void snd_oxfw_stream_update_duplex(struct snd_oxfw *oxfw);
 128
 129 struct snd_oxfw_stream_formation {
 130         unsigned int rate;
 131         unsigned int pcm;
 132         unsigned int midi;
 133 };
 134 int snd_oxfw_stream_parse_format(u8 *format,
 135                                  struct snd_oxfw_stream_formation *formation);
 136 int snd_oxfw_stream_get_current_formation(struct snd_oxfw *oxfw,
 137                                 enum avc_general_plug_dir dir,
 138                                 struct snd_oxfw_stream_formation *formation);
 139
 140 int snd_oxfw_stream_discover(struct snd_oxfw *oxfw);
 141
 142 void snd_oxfw_stream_lock_changed(struct snd_oxfw *oxfw);
 143 int snd_oxfw_stream_lock_try(struct snd_oxfw *oxfw);
 144 void snd_oxfw_stream_lock_release(struct snd_oxfw *oxfw);
 145
 146 int snd_oxfw_create_pcm(struct snd_oxfw *oxfw);
 147
 148 void snd_oxfw_proc_init(struct snd_oxfw *oxfw);
 149
 150 int snd_oxfw_create_midi(struct snd_oxfw *oxfw);
 151
 152 int snd_oxfw_create_hwdep(struct snd_oxfw *oxfw);
 153
 154 int snd_oxfw_add_spkr(struct snd_oxfw *oxfw, bool is_lacie);
 155 int snd_oxfw_scs1x_add(struct snd_oxfw *oxfw);
 156 void snd_oxfw_scs1x_update(struct snd_oxfw *oxfw);