Gitiles
Code Review Sign In
192.168.1.100 / T103 / 1f884588077ad3476b9c91cbb0ee9ee0332bbb68 / . / src / kernel / linux / v4.14 / sound / firewire / motu / motu.h
blob: 4b23cf337c4bec535172f289186fefb295919697 [file] [log] [blame]
rjw1f884582022-01-06 17:20:42 +0800[diff] [blame^]1/*
2 * motu.h - a part of driver for MOTU FireWire series
3 *
4 * Copyright (c) 2015-2017 Takashi Sakamoto <o-takashi@sakamocchi.jp>
5 *
6 * Licensed under the terms of the GNU General Public License, version 2.
7 */
8
9#ifndef SOUND_FIREWIRE_MOTU_H_INCLUDED
10#define SOUND_FIREWIRE_MOTU_H_INCLUDED
11
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/mutex.h>
18#include <linux/slab.h>
19#include <linux/compat.h>
20#include <linux/sched/signal.h>
21
22#include <sound/control.h>
23#include <sound/core.h>
24#include <sound/pcm.h>
25#include <sound/info.h>
26#include <sound/rawmidi.h>
27#include <sound/firewire.h>
28#include <sound/hwdep.h>
29
30#include "../lib.h"
31#include "../amdtp-stream.h"
32#include "../iso-resources.h"
33
34struct snd_motu_packet_format {
35 unsigned char midi_flag_offset;
36 unsigned char midi_byte_offset;
37 unsigned char pcm_byte_offset;
38
39 unsigned char msg_chunks;
40 unsigned char fixed_part_pcm_chunks[3];
41 unsigned char differed_part_pcm_chunks[3];
42};
43
44struct snd_motu {
45 struct snd_card *card;
46 struct fw_unit *unit;
47 struct mutex mutex;
48 spinlock_t lock;
49
50 bool registered;
51 struct delayed_work dwork;
52
53 /* Model dependent information. */
54 const struct snd_motu_spec *spec;
55
56 /* For packet streaming */
57 struct snd_motu_packet_format tx_packet_formats;
58 struct snd_motu_packet_format rx_packet_formats;
59 struct amdtp_stream tx_stream;
60 struct amdtp_stream rx_stream;
61 struct fw_iso_resources tx_resources;
62 struct fw_iso_resources rx_resources;
63 unsigned int capture_substreams;
64 unsigned int playback_substreams;
65
66 /* For notification. */
67 struct fw_address_handler async_handler;
68 u32 msg;
69
70 /* For uapi */
71 int dev_lock_count;
72 bool dev_lock_changed;
73 wait_queue_head_t hwdep_wait;
74};
75
76enum snd_motu_spec_flags {
77 SND_MOTU_SPEC_SUPPORT_CLOCK_X2 = 0x0001,
78 SND_MOTU_SPEC_SUPPORT_CLOCK_X4 = 0x0002,
79 SND_MOTU_SPEC_TX_MICINST_CHUNK = 0x0004,
80 SND_MOTU_SPEC_TX_RETURN_CHUNK = 0x0008,
81 SND_MOTU_SPEC_TX_REVERB_CHUNK = 0x0010,
82 SND_MOTU_SPEC_TX_AESEBU_CHUNK = 0x0020,
83 SND_MOTU_SPEC_HAS_OPT_IFACE_A = 0x0040,
84 SND_MOTU_SPEC_HAS_OPT_IFACE_B = 0x0080,
85 SND_MOTU_SPEC_RX_MIDI_2ND_Q = 0x0100,
86 SND_MOTU_SPEC_RX_MIDI_3RD_Q = 0x0200,
87 SND_MOTU_SPEC_TX_MIDI_2ND_Q = 0x0400,
88 SND_MOTU_SPEC_TX_MIDI_3RD_Q = 0x0800,
89};
90
91#define SND_MOTU_CLOCK_RATE_COUNT 6
92extern const unsigned int snd_motu_clock_rates[SND_MOTU_CLOCK_RATE_COUNT];
93
94enum snd_motu_clock_source {
95 SND_MOTU_CLOCK_SOURCE_INTERNAL,
96 SND_MOTU_CLOCK_SOURCE_ADAT_ON_DSUB,
97 SND_MOTU_CLOCK_SOURCE_ADAT_ON_OPT,
98 SND_MOTU_CLOCK_SOURCE_ADAT_ON_OPT_A,
99 SND_MOTU_CLOCK_SOURCE_ADAT_ON_OPT_B,
100 SND_MOTU_CLOCK_SOURCE_SPDIF_ON_OPT,
101 SND_MOTU_CLOCK_SOURCE_SPDIF_ON_OPT_A,
102 SND_MOTU_CLOCK_SOURCE_SPDIF_ON_OPT_B,
103 SND_MOTU_CLOCK_SOURCE_SPDIF_ON_COAX,
104 SND_MOTU_CLOCK_SOURCE_AESEBU_ON_XLR,
105 SND_MOTU_CLOCK_SOURCE_WORD_ON_BNC,
106 SND_MOTU_CLOCK_SOURCE_UNKNOWN,
107};
108
109struct snd_motu_protocol {
110 int (*get_clock_rate)(struct snd_motu *motu, unsigned int *rate);
111 int (*set_clock_rate)(struct snd_motu *motu, unsigned int rate);
112 int (*get_clock_source)(struct snd_motu *motu,
113 enum snd_motu_clock_source *source);
114 int (*switch_fetching_mode)(struct snd_motu *motu, bool enable);
115 int (*cache_packet_formats)(struct snd_motu *motu);
116};
117
118struct snd_motu_spec {
119 const char *const name;
120 enum snd_motu_spec_flags flags;
121
122 unsigned char analog_in_ports;
123 unsigned char analog_out_ports;
124
125 const struct snd_motu_protocol *const protocol;
126};
127
128extern const struct snd_motu_protocol snd_motu_protocol_v2;
129extern const struct snd_motu_protocol snd_motu_protocol_v3;
130
131int amdtp_motu_init(struct amdtp_stream *s, struct fw_unit *unit,
132 enum amdtp_stream_direction dir,
133 const struct snd_motu_protocol *const protocol);
134int amdtp_motu_set_parameters(struct amdtp_stream *s, unsigned int rate,
135 unsigned int midi_ports,
136 struct snd_motu_packet_format *formats);
137int amdtp_motu_add_pcm_hw_constraints(struct amdtp_stream *s,
138 struct snd_pcm_runtime *runtime);
139void amdtp_motu_midi_trigger(struct amdtp_stream *s, unsigned int port,
140 struct snd_rawmidi_substream *midi);
141
142int snd_motu_transaction_read(struct snd_motu *motu, u32 offset, __be32 *reg,
143 size_t size);
144int snd_motu_transaction_write(struct snd_motu *motu, u32 offset, __be32 *reg,
145 size_t size);
146int snd_motu_transaction_register(struct snd_motu *motu);
147int snd_motu_transaction_reregister(struct snd_motu *motu);
148void snd_motu_transaction_unregister(struct snd_motu *motu);
149
150int snd_motu_stream_init_duplex(struct snd_motu *motu);
151void snd_motu_stream_destroy_duplex(struct snd_motu *motu);
152int snd_motu_stream_cache_packet_formats(struct snd_motu *motu);
153int snd_motu_stream_start_duplex(struct snd_motu *motu, unsigned int rate);
154void snd_motu_stream_stop_duplex(struct snd_motu *motu);
155int snd_motu_stream_lock_try(struct snd_motu *motu);
156void snd_motu_stream_lock_release(struct snd_motu *motu);
157
158void snd_motu_proc_init(struct snd_motu *motu);
159
160int snd_motu_create_pcm_devices(struct snd_motu *motu);
161
162int snd_motu_create_midi_devices(struct snd_motu *motu);
163
164int snd_motu_create_hwdep_device(struct snd_motu *motu);
165#endif