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

Revision 1715, 10.8 kB (checked in by jwoithe, 11 years ago)

MOTU: add some initial details relating to the original 828 interface (known in FFADO as the 828Mk1).

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 #include "motu_mark3_controls.h"
38
39 #define MOTU_BASE_ADDR               0xfffff0000000ULL
40
41 /* Bitmasks and values used when setting MOTU device registers */
42 #define MOTU_RATE_BASE_44100         (0<<3)
43 #define MOTU_RATE_BASE_48000         (1<<3)
44 #define MOTU_RATE_MULTIPLIER_1X      (0<<4)
45 #define MOTU_RATE_MULTIPLIER_2X      (1<<4)
46 #define MOTU_RATE_MULTIPLIER_4X      (2<<4)
47 #define MOTU_RATE_BASE_MASK          (0x00000008)
48 #define MOTU_RATE_MULTIPLIER_MASK    (0x00000030)
49
50 #define MOTU_OPTICAL_MODE_OFF        0x00
51 #define MOTU_OPTICAL_MODE_ADAT       0x01
52 #define MOTU_OPTICAL_MODE_TOSLINK    0x02
53 #define MOTU_OPTICAL_IN_MODE_MASK    (0x00000300)
54 #define MOTU_OPTICAL_OUT_MODE_MASK   (0x00000c00)
55 #define MOTU_OPTICAL_MODE_MASK       (MOTU_OPTICAL_IN_MODE_MASK|MOTU_OPTICAL_MODE_MASK)
56
57 #define MOTU_CLKSRC_MASK             0x00000007
58 #define MOTU_CLKSRC_INTERNAL         0
59 #define MOTU_CLKSRC_ADAT_OPTICAL     1
60 #define MOTU_CLKSRC_SPDIF_TOSLINK    2
61 #define MOTU_CLKSRC_SMPTE            3
62 #define MOTU_CLKSRC_WORDCLOCK        4
63 #define MOTU_CLKSRC_ADAT_9PIN        5
64 #define MOTU_CLKSRC_AES_EBU          7
65 #define MOTU_CLKSRC_NONE             0xffff
66 #define MOTU_CLKSRC_UNCHANGED        MOTU_CLKSRC_NONE
67
68 #define MOTU_METER_PEAKHOLD_MASK     0x3800
69 #define MOTU_METER_PEAKHOLD_SHIFT    11
70 #define MOTU_METER_CLIPHOLD_MASK     0x0700
71 #define MOTU_METER_CLIPHOLD_SHIFT    8
72 #define MOTU_METER_AESEBU_SRC_MASK   0x0004
73 #define MOTU_METER_AESEBU_SRC_SHIFT  2
74 #define MOTU_METER_PROG_SRC_MASK     0x0003
75 #define MOTU_METER_PROG_SRC_SHIFT    0
76
77 /* Device registers */
78 #define MOTU_REG_ISOCTRL           0x0b00
79 #define MOTU_REG_OPTICAL_CTRL      0x0b10
80 #define MOTU_REG_CLK_CTRL          0x0b14
81 #define MOTU_REG_896HD_METER_REG   0x0b1c
82 #define MOTU_REG_896HD_METER_CONF  0x0b24
83 #define MOTU_REG_ROUTE_PORT_CONF   0x0c04
84 #define MOTU_REG_INPUT_LEVEL       0x0c08
85 #define MOTU_REG_INPUT_BOOST       0x0c14
86 #define MOTU_REG_INPUT_GAIN_PAD_0  0x0c1c
87 #define MOTU_REG_CLKSRC_NAME0      0x0c60
88 #define MOTU_REG_INPUT_GAIN_PHINV0 0x0c70
89 #define MOTU_REG_INPUT_GAIN_PHINV1 0x0c74
90 #define MOTU_REG_INPUT_GAIN_PHINV2 0x0c78
91
92 /* Device register definitions for the earliest generation devices */
93 #define MOTU_G1_REG_CONFIG         0x0b00
94
95 /* The optical mode defines for the 828Mk1 are estimates at present, to be
96  * confirmed.
97  */
98 #define MOTU_G1_OPT_IN_MODE_MASK   0x0000  // Still be be observed
99 #define MOTU_G1_OPT_IN_MODE_BIT0        0  // Still to be observed
100 #define MOTU_G1_OPT_OUT_MODE_MASK  0xc000
101 #define MOTU_G1_OPT_OUT_MODE_BIT0      26
102 #define MOTU_G1_OPTICAL_OFF        0x0000
103 #define MOTU_G1_OPTICAL_TOSLINK    0x0001
104 #define MOTU_G1_OPTICAL_ADAT       0x0002
105
106 #define MOTU_G1_RATE_MASK          0x0004
107 #define MOTU_G1_RATE_44100         0x0000
108 #define MOTU_G1_RATE_48000         0x0004
109
110 #define MOTU_G1_CLKSRC_MASK        0x0003
111 #define MOTU_G1_CLKSRC_INTERNAL    0x0000
112 #define MOTU_G1_CLKSRC_ADAT_9PIN   0x0001
113 #define MOTU_G1_CLKSRC_SPDIF       0x0002
114 #define MOTU_G1_CLKSRC_UNCHANGED   MOTU_CLKSRC_UNCHANGED
115
116 #define MOTU_G1_MONIN_MASK         0x3f00
117 #define MOTU_G1_MONIN_L_SRC_MASK   0x0600
118 #define MOTU_G1_MONIN_R_SRC_MASK   0x3000
119 #define MOTU_G1_MONIN_L_MUTE_MASK  0x0100  // Yes, the sense of these 2 bits
120 #define MOTU_G1_MONIN_R_EN_MASK    0x0800  //   really are reversed
121 #define MOTU_G1_MONIN_L_MUTE       0x0100
122 #define MOTU_G1_MONIN_L_ENABLE     0x0000
123 #define MOTU_G1_MONIN_R_MUTE       0x0000
124 #define MOTU_G1_MONIN_R_ENABLE     0x0800
125 #define MOTU_G1_MONIN_L_CH1        0x0000
126 #define MOTU_G1_MONIN_L_CH3        0x0020
127 #define MOTU_G1_MONIN_L_CH5        0x0040
128 #define MOTU_G1_MONIN_L_CH7        0x0060
129 #define MOTU_G1_MONIN_R_CH2        0x0000
130 #define MOTU_G1_MONIN_R_CH4        0x1000
131 #define MOTU_G1_MONIN_R_CH6        0x2000
132 #define MOTU_G1_MONIN_R_CH8        0x3000
133
134 /* Mark3 device registers - these don't have MOTU_BASE_ADDR as the base
135  * address so for now we'll define them as absolute addresses.
136  */
137 #define MOTU_MARK3_REG_MIXER     0xffff00010000LL
138
139 /* Port Active Flags (ports declaration) */
140 #define MOTU_PA_RATE_1x          0x0001    /* 44k1 or 48k */
141 #define MOTU_PA_RATE_2x          0x0002    /* 88k2 or 96k */
142 #define MOTU_PA_RATE_4x          0x0004    /* 176k4 or 192k */
143 #define MOTU_PA_RATE_1x2x        (MOTU_PA_RATE_1x|MOTU_PA_RATE_2x)
144 #define MOTU_PA_RATE_ANY         (MOTU_PA_RATE_1x|MOTU_PA_RATE_2x|MOTU_PA_RATE_4x)
145 #define MOTU_PA_RATE_MASK        MOTU_PA_RATE_ANY
146 #define MOTU_PA_OPTICAL_OFF      0x0010    /* Optical port off */
147 #define MOTU_PA_OPTICAL_ADAT     0x0020    /* Optical port in ADAT mode */
148 #define MOTU_PA_OPTICAL_TOSLINK  0x0040    /* Optical port in SPDIF/Toslink mode */
149 #define MOTU_PA_OPTICAL_ON       (MOTU_PA_OPTICAL_ADAT|MOTU_PA_OPTICAL_TOSLINK)
150 #define MOTU_PA_OPTICAL_ANY      (MOTU_PA_OPTICAL_OFF|MOTU_PA_OPTICAL_ON)
151 #define MOTU_PA_OPTICAL_MASK     MOTU_PA_OPTICAL_ANY
152 #define MOTU_PA_PADDING          0x0100
153 #define MOTU_PA_IN               0x0200
154 #define MOTU_PA_OUT              0x0400
155 #define MOTU_PA_INOUT            (MOTU_PA_IN | MOTU_PA_OUT)
156
157 /* Generic "direction" flags */
158 #define MOTU_DIR_IN          1
159 #define MOTU_DIR_OUT         2
160 #define MOTU_DIR_INOUT       (MOTU_DIR_IN | MOTU_DIR_OUT)
161
162 class ConfigRom;
163 class Ieee1394Service;
164
165 namespace Util {
166     class Configuration;
167 }
168
169 namespace Motu {
170
171 enum EMotuModel {
172     MOTU_MODEL_NONE         = 0x0000,
173     MOTU_MODEL_828mkII      = 0x0001,
174     MOTU_MODEL_TRAVELER     = 0x0002,
175     MOTU_MODEL_ULTRALITE    = 0x0003,
176     MOTU_MODEL_8PRE         = 0x0004,
177     MOTU_MODEL_828MkI       = 0x0005,
178     MOTU_MODEL_896HD        = 0x0006,
179     MOTU_MODEL_828mk3       = 0x0007,
180     MOTU_MODEL_ULTRALITEmk3 = 0x0008,
181 };
182
183 struct VendorModelEntry {
184     unsigned int vendor_id;
185     unsigned int model_id;
186     unsigned int unit_version;
187     unsigned int unit_specifier_id;
188     enum EMotuModel model;
189     const char *vendor_name;
190     const char *model_name;
191 };
192
193 struct PortEntry {
194     const char *port_name;
195     unsigned int port_flags;
196     unsigned int port_offset;
197 };
198
199 // Structures used for pre-Mark3 device mixer definitions
200 struct MixerCtrl {
201     const char *name, *label, *desc;
202     unsigned int type;
203     unsigned int dev_register;
204 };
205 struct MatrixMixBus {
206     const char *name;
207     unsigned int address;
208 };
209 struct MatrixMixChannel {
210     const char *name;
211     unsigned int flags;
212     unsigned int addr_ofs;
213 };
214 struct MotuMixer {
215     const MixerCtrl *mixer_ctrl;
216     unsigned int n_mixer_ctrls;
217     const MatrixMixBus *mixer_buses;
218     unsigned int n_mixer_buses;
219     const MatrixMixChannel *mixer_channels;
220     unsigned int n_mixer_channels;
221 };
222
223 // Structures used for devices which use the "Mark3" mixer protocol
224 struct MotuMark3Mixer {
225 };
226
227 struct DevicePropertyEntry {
228     const PortEntry* port_entry;
229     unsigned int n_port_entries;
230     signed int MaxSampleRate;
231     // A device will set at most one of the *mixer fields
232     const struct MotuMixer *mixer;
233     const struct MotuMark3Mixer *m3mixer;
234     // Others features can be added here like MIDI port presence.
235 };
236
237 extern const DevicePropertyEntry DevicesProperty[];
238
239 /* Macro to calculate the size of an array */
240 #define N_ELEMENTS(_array) (sizeof(_array) / sizeof((_array)[0]))
241
242 /* Macro to define a MotuMixer structure succintly */
243 #define MOTUMIXER(_ctrls, _buses, _channels) \
244     { _ctrls, N_ELEMENTS(_ctrls), _buses, N_ELEMENTS(_buses), _channels, N_ELEMENTS(_channels), }
245
246 class MotuDevice : public FFADODevice {
247 public:
248
249     MotuDevice( DeviceManager& d, std::auto_ptr<ConfigRom>( configRom ) );
250     virtual ~MotuDevice();
251
252     virtual bool buildMixer();
253     virtual bool destroyMixer();
254
255     static bool probe( Util::Configuration&, ConfigRom& configRom, bool generic = false );
256     static FFADODevice * createDevice( DeviceManager& d, std::auto_ptr<ConfigRom>( configRom ));
257     static int getConfigurationId( );
258     virtual bool discover();
259
260     virtual void showDevice();
261
262     bool setClockCtrlRegister(signed int samplingFrequency, unsigned int clock_source);
263     virtual bool setSamplingFrequency( int samplingFrequency );
264     virtual int getSamplingFrequency( );
265     virtual std::vector<int> getSupportedSamplingFrequencies();
266
267     FFADODevice::ClockSource clockIdToClockSource(unsigned int id);
268     virtual ClockSourceVector getSupportedClockSources();
269     virtual bool setActiveClockSource(ClockSource);
270     virtual ClockSource getActiveClockSource();
271
272     virtual int getStreamCount();
273     virtual Streaming::StreamProcessor *getStreamProcessorByIndex(int i);
274     enum FFADODevice::eStreamingState getStreamingState();
275
276     virtual bool prepare();
277     virtual bool lock();
278     virtual bool unlock();
279
280     virtual bool startStreamByIndex(int i);
281     virtual bool stopStreamByIndex(int i);
282
283     signed int getIsoRecvChannel(void);
284     signed int getIsoSendChannel(void);
285     unsigned int getOpticalMode(unsigned int dir);
286     signed int setOpticalMode(unsigned int dir, unsigned int mode);
287
288     signed int getEventSize(unsigned int dir);
289
290     signed int       m_motu_model;
291 protected:
292     struct VendorModelEntry * m_model;
293     signed int m_iso_recv_channel, m_iso_send_channel;
294     signed int m_rx_bandwidth, m_tx_bandwidth;
295
296     Streaming::MotuReceiveStreamProcessor *m_receiveProcessor;
297     Streaming::MotuTransmitStreamProcessor *m_transmitProcessor;
298
299 private:
300     bool buildMixerAudioControls(void);
301     bool buildMark3MixerAudioControls(void);
302     bool addPort(Streaming::StreamProcessor *s_processor,
303         char *name,
304         enum Streaming::Port::E_Direction direction,
305         int position, int size);
306     bool addDirPorts(
307         enum Streaming::Port::E_Direction direction,
308         unsigned int sample_rate, unsigned int optical_mode);
309
310 public:
311     unsigned int ReadRegister(unsigned int reg);
312     signed int WriteRegister(unsigned int reg, quadlet_t data);
313
314 private:
315     Control::Container *m_MixerContainer;
316     Control::Container *m_ControlContainer;
317 };
318
319 }
320
321 #endif
Note: See TracBrowser for help on using the browser.