root/branches/libffado-2.0/src/motu/motu_avdevice.h

Revision 1385, 8.2 kB (checked in by ppalmers, 12 years ago)

Implement a mechanism to disable the samplerate and clock source controls while the device is streaming in order to avoid changes that could mess up jack. The saffire pro controls that cause a device reset to
happen are also disabled while streaming is active.

Line 
1 /*
2  * Copyright (C) 2005-2008 by Pieter Palmers
3  * Copyright (C) 2005-2008 by Jonathan Woithe
4  *
5  * This file is part of FFADO
6  * FFADO = Free Firewire (pro-)audio drivers for linux
7  *
8  * FFADO is based upon FreeBoB.
9  *
10  * This program is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation, either version 2 of the License, or
13  * (at your option) version 3 of the License.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
22  *
23  */
24
25 #ifndef MOTUDEVICE_H
26 #define MOTUDEVICE_H
27
28 #include "ffadodevice.h"
29
30 #include "debugmodule/debugmodule.h"
31 #include "libavc/avc_definitions.h"
32
33 #include "libstreaming/motu/MotuReceiveStreamProcessor.h"
34 #include "libstreaming/motu/MotuTransmitStreamProcessor.h"
35
36 #include "motu_controls.h"
37
38 #define MOTU_BASE_ADDR               0xfffff0000000ULL
39
40 #define MOTU_RATE_BASE_44100         (0<<3)
41 #define MOTU_RATE_BASE_48000         (1<<3)
42 #define MOTU_RATE_MULTIPLIER_1X      (0<<4)
43 #define MOTU_RATE_MULTIPLIER_2X      (1<<4)
44 #define MOTU_RATE_MULTIPLIER_4X      (2<<4)
45 #define MOTU_RATE_BASE_MASK          (0x00000008)
46 #define MOTU_RATE_MULTIPLIER_MASK    (0x00000030)
47
48 #define MOTU_OPTICAL_MODE_OFF        0x00
49 #define MOTU_OPTICAL_MODE_ADAT       0x01
50 #define MOTU_OPTICAL_MODE_TOSLINK    0x02
51 #define MOTU_OPTICAL_IN_MODE_MASK    (0x00000300)
52 #define MOTU_OPTICAL_OUT_MODE_MASK   (0x00000c00)
53 #define MOTU_OPTICAL_MODE_MASK       (MOTU_OPTICAL_IN_MODE_MASK|MOTU_OPTICAL_MODE_MASK)
54
55 #define MOTU_CLKSRC_MASK             0x00000007
56 #define MOTU_CLKSRC_INTERNAL         0
57 #define MOTU_CLKSRC_ADAT_OPTICAL     1
58 #define MOTU_CLKSRC_SPDIF_TOSLINK    2
59 #define MOTU_CLKSRC_SMPTE            3
60 #define MOTU_CLKSRC_WORDCLOCK        4
61 #define MOTU_CLKSRC_ADAT_9PIN        5
62 #define MOTU_CLKSRC_AES_EBU          7
63 #define MOTU_CLKSRC_NONE             0xffff
64 #define MOTU_CLKSRC_UNCHANGED        MOTU_CLKSRC_NONE
65
66 #define MOTU_DIR_IN          1
67 #define MOTU_DIR_OUT         2
68 #define MOTU_DIR_INOUT       (MOTU_DIR_IN | MOTU_DIR_OUT)
69
70 #define MOTU_METER_PEAKHOLD_MASK     0x3800
71 #define MOTU_METER_PEAKHOLD_SHIFT    11
72 #define MOTU_METER_CLIPHOLD_MASK     0x0700
73 #define MOTU_METER_CLIPHOLD_SHIFT    8
74 #define MOTU_METER_AESEBU_SRC_MASK   0x0004
75 #define MOTU_METER_AESEBU_SRC_SHIFT  2
76 #define MOTU_METER_PROG_SRC_MASK     0x0003
77 #define MOTU_METER_PROG_SRC_SHIFT    0
78
79 /* Device registers */
80 #define MOTU_REG_ISOCTRL           0x0b00
81 #define MOTU_REG_OPTICAL_CTRL      0x0b10
82 #define MOTU_REG_CLK_CTRL          0x0b14
83 #define MOTU_REG_896HD_METER_REG   0x0b1c
84 #define MOTU_REG_896HD_METER_CONF  0x0b24
85 #define MOTU_REG_ROUTE_PORT_CONF   0x0c04
86 #define MOTU_REG_INPUT_LEVEL       0x0c08
87 #define MOTU_REG_INPUT_BOOST       0x0c14
88 #define MOTU_REG_INPUT_GAIN_PAD_0  0x0c1c
89 #define MOTU_REG_CLKSRC_NAME0      0x0c60
90
91 /* Port Active Flags (ports declaration) */
92 #define MOTU_PA_RATE_1x          0x0001    /* 44k1 or 48k */
93 #define MOTU_PA_RATE_2x          0x0002    /* 88k2 or 96k */
94 #define MOTU_PA_RATE_4x          0x0004    /* 176k4 or 192k */
95 #define MOTU_PA_RATE_1x2x        (MOTU_PA_RATE_1x|MOTU_PA_RATE_2x)
96 #define MOTU_PA_RATE_ANY         (MOTU_PA_RATE_1x|MOTU_PA_RATE_2x|MOTU_PA_RATE_4x)
97 #define MOTU_PA_RATE_MASK        MOTU_PA_RATE_ANY
98 #define MOTU_PA_OPTICAL_OFF      0x0010    /* Optical port off */
99 #define MOTU_PA_OPTICAL_ADAT     0x0020    /* Optical port in ADAT mode */
100 #define MOTU_PA_OPTICAL_TOSLINK  0x0040    /* Optical port in SPDIF/Toslink mode */
101 #define MOTU_PA_OPTICAL_ON       (MOTU_PA_OPTICAL_ADAT|MOTU_PA_OPTICAL_TOSLINK)
102 #define MOTU_PA_OPTICAL_ANY      (MOTU_PA_OPTICAL_OFF|MOTU_PA_OPTICAL_ON)
103 #define MOTU_PA_OPTICAL_MASK     MOTU_PA_OPTICAL_ANY
104 #define MOTU_PA_PADDING          0x0100
105
106 class ConfigRom;
107 class Ieee1394Service;
108
109 namespace Util {
110     class Configuration;
111 }
112
113 namespace Motu {
114
115 enum EMotuModel {
116     MOTU_MODEL_NONE     = 0x0000,
117     MOTU_MODEL_828mkII  = 0x0001,
118     MOTU_MODEL_TRAVELER = 0x0002,
119     MOTU_MODEL_ULTRALITE= 0x0003,
120     MOTU_MODEL_8PRE     = 0x0004,
121     MOTU_MODEL_828MkI   = 0x0005,
122     MOTU_MODEL_896HD    = 0x0006,
123 };
124
125 struct VendorModelEntry {
126     unsigned int vendor_id;
127     unsigned int model_id;
128     unsigned int unit_version;
129     unsigned int unit_specifier_id;
130     enum EMotuModel model;
131     const char *vendor_name;
132     const char *model_name;
133 };
134
135 struct PortEntry {
136     const char *port_name;
137     unsigned int port_dir;
138     unsigned int port_flags;
139     unsigned int port_offset;
140 };
141
142 struct MixerCtrl {
143     const char *name, *label, *desc;
144     unsigned int type;
145     unsigned int dev_register;
146 };
147
148 struct MatrixMixBus {
149     const char *name;
150     unsigned int address;
151 };
152
153 struct MatrixMixChannel {
154     const char *name;
155     unsigned int flags;
156     unsigned int addr_ofs;
157 };
158
159 struct MotuMixer {
160     const MixerCtrl *mixer_ctrl;
161     unsigned int n_mixer_ctrls;
162     const MatrixMixBus *mixer_buses;
163     unsigned int n_mixer_buses;
164     const MatrixMixChannel *mixer_channels;
165     unsigned int n_mixer_channels;
166 };
167
168 struct DevicePropertyEntry {
169     const PortEntry* port_entry;
170     unsigned int n_port_entries;
171     signed int MaxSampleRate;
172     const struct MotuMixer *mixer;
173     // Others features can be added here like MIDI port presence.
174 };
175
176 /* Macro to calculate the size of an array */
177 #define N_ELEMENTS(_array) (sizeof(_array) / sizeof((_array)[0]))
178
179 /* Macro to define a MotuMixer structure succintly */
180 #define MOTUMIXER(_ctrls, _buses, _channels) \
181     { _ctrls, N_ELEMENTS(_ctrls), _buses, N_ELEMENTS(_buses), _channels, N_ELEMENTS(_channels), }
182
183 class MotuDevice : public FFADODevice {
184 public:
185
186     MotuDevice( DeviceManager& d, std::auto_ptr<ConfigRom>( configRom ) );
187     virtual ~MotuDevice();
188
189     virtual bool buildMixer();
190     virtual bool destroyMixer();
191
192     static bool probe( Util::Configuration&, ConfigRom& configRom, bool generic = false );
193     static FFADODevice * createDevice( DeviceManager& d, std::auto_ptr<ConfigRom>( configRom ));
194     static int getConfigurationId( );
195     virtual bool discover();
196
197     virtual void showDevice();
198
199     bool setClockCtrlRegister(signed int samplingFrequency, unsigned int clock_source);
200     virtual bool setSamplingFrequency( int samplingFrequency );
201     virtual int getSamplingFrequency( );
202     virtual std::vector<int> getSupportedSamplingFrequencies();
203
204     FFADODevice::ClockSource clockIdToClockSource(unsigned int id);
205     virtual ClockSourceVector getSupportedClockSources();
206     virtual bool setActiveClockSource(ClockSource);
207     virtual ClockSource getActiveClockSource();
208
209     virtual int getStreamCount();
210     virtual Streaming::StreamProcessor *getStreamProcessorByIndex(int i);
211     enum FFADODevice::eStreamingState getStreamingState();
212
213     virtual bool prepare();
214     virtual bool lock();
215     virtual bool unlock();
216
217     virtual bool startStreamByIndex(int i);
218     virtual bool stopStreamByIndex(int i);
219
220     signed int getIsoRecvChannel(void);
221     signed int getIsoSendChannel(void);
222     unsigned int getOpticalMode(unsigned int dir);
223     signed int setOpticalMode(unsigned int dir, unsigned int mode);
224
225     signed int getEventSize(unsigned int dir);
226
227     signed int       m_motu_model;
228 protected:
229     struct VendorModelEntry * m_model;
230     signed int m_iso_recv_channel, m_iso_send_channel;
231     signed int m_rx_bandwidth, m_tx_bandwidth;
232
233     Streaming::MotuReceiveStreamProcessor *m_receiveProcessor;
234     Streaming::MotuTransmitStreamProcessor *m_transmitProcessor;
235
236 private:
237     bool buildMixerAudioControls(void);
238     bool addPort(Streaming::StreamProcessor *s_processor,
239         char *name,
240         enum Streaming::Port::E_Direction direction,
241         int position, int size);
242     bool addDirPorts(
243         enum Streaming::Port::E_Direction direction,
244         unsigned int sample_rate, unsigned int optical_mode);
245
246 public:
247     unsigned int ReadRegister(unsigned int reg);
248     signed int WriteRegister(unsigned int reg, quadlet_t data);
249
250 private:
251     Control::Container *m_MixerContainer;
252     Control::Container *m_ControlContainer;
253 };
254
255 }
256
257 #endif
Note: See TracBrowser for help on using the browser.