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

Revision 1418, 8.4 kB (checked in by jwoithe, 15 years ago)

MOTU: tidy up internal port management code. There should be no user-visible changes as a result of this - please report any regressions.

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 /* Bitmasks and values used when setting MOTU device registers */
41 #define MOTU_RATE_BASE_44100         (0<<3)
42 #define MOTU_RATE_BASE_48000         (1<<3)
43 #define MOTU_RATE_MULTIPLIER_1X      (0<<4)
44 #define MOTU_RATE_MULTIPLIER_2X      (1<<4)
45 #define MOTU_RATE_MULTIPLIER_4X      (2<<4)
46 #define MOTU_RATE_BASE_MASK          (0x00000008)
47 #define MOTU_RATE_MULTIPLIER_MASK    (0x00000030)
48
49 #define MOTU_OPTICAL_MODE_OFF        0x00
50 #define MOTU_OPTICAL_MODE_ADAT       0x01
51 #define MOTU_OPTICAL_MODE_TOSLINK    0x02
52 #define MOTU_OPTICAL_IN_MODE_MASK    (0x00000300)
53 #define MOTU_OPTICAL_OUT_MODE_MASK   (0x00000c00)
54 #define MOTU_OPTICAL_MODE_MASK       (MOTU_OPTICAL_IN_MODE_MASK|MOTU_OPTICAL_MODE_MASK)
55
56 #define MOTU_CLKSRC_MASK             0x00000007
57 #define MOTU_CLKSRC_INTERNAL         0
58 #define MOTU_CLKSRC_ADAT_OPTICAL     1
59 #define MOTU_CLKSRC_SPDIF_TOSLINK    2
60 #define MOTU_CLKSRC_SMPTE            3
61 #define MOTU_CLKSRC_WORDCLOCK        4
62 #define MOTU_CLKSRC_ADAT_9PIN        5
63 #define MOTU_CLKSRC_AES_EBU          7
64 #define MOTU_CLKSRC_NONE             0xffff
65 #define MOTU_CLKSRC_UNCHANGED        MOTU_CLKSRC_NONE
66
67 #define MOTU_METER_PEAKHOLD_MASK     0x3800
68 #define MOTU_METER_PEAKHOLD_SHIFT    11
69 #define MOTU_METER_CLIPHOLD_MASK     0x0700
70 #define MOTU_METER_CLIPHOLD_SHIFT    8
71 #define MOTU_METER_AESEBU_SRC_MASK   0x0004
72 #define MOTU_METER_AESEBU_SRC_SHIFT  2
73 #define MOTU_METER_PROG_SRC_MASK     0x0003
74 #define MOTU_METER_PROG_SRC_SHIFT    0
75
76 /* Device registers */
77 #define MOTU_REG_ISOCTRL           0x0b00
78 #define MOTU_REG_OPTICAL_CTRL      0x0b10
79 #define MOTU_REG_CLK_CTRL          0x0b14
80 #define MOTU_REG_896HD_METER_REG   0x0b1c
81 #define MOTU_REG_896HD_METER_CONF  0x0b24
82 #define MOTU_REG_ROUTE_PORT_CONF   0x0c04
83 #define MOTU_REG_INPUT_LEVEL       0x0c08
84 #define MOTU_REG_INPUT_BOOST       0x0c14
85 #define MOTU_REG_INPUT_GAIN_PAD_0  0x0c1c
86 #define MOTU_REG_CLKSRC_NAME0      0x0c60
87
88 /* Port Active Flags (ports declaration) */
89 #define MOTU_PA_RATE_1x          0x0001    /* 44k1 or 48k */
90 #define MOTU_PA_RATE_2x          0x0002    /* 88k2 or 96k */
91 #define MOTU_PA_RATE_4x          0x0004    /* 176k4 or 192k */
92 #define MOTU_PA_RATE_1x2x        (MOTU_PA_RATE_1x|MOTU_PA_RATE_2x)
93 #define MOTU_PA_RATE_ANY         (MOTU_PA_RATE_1x|MOTU_PA_RATE_2x|MOTU_PA_RATE_4x)
94 #define MOTU_PA_RATE_MASK        MOTU_PA_RATE_ANY
95 #define MOTU_PA_OPTICAL_OFF      0x0010    /* Optical port off */
96 #define MOTU_PA_OPTICAL_ADAT     0x0020    /* Optical port in ADAT mode */
97 #define MOTU_PA_OPTICAL_TOSLINK  0x0040    /* Optical port in SPDIF/Toslink mode */
98 #define MOTU_PA_OPTICAL_ON       (MOTU_PA_OPTICAL_ADAT|MOTU_PA_OPTICAL_TOSLINK)
99 #define MOTU_PA_OPTICAL_ANY      (MOTU_PA_OPTICAL_OFF|MOTU_PA_OPTICAL_ON)
100 #define MOTU_PA_OPTICAL_MASK     MOTU_PA_OPTICAL_ANY
101 #define MOTU_PA_PADDING          0x0100
102 #define MOTU_PA_IN               0x0200
103 #define MOTU_PA_OUT              0x0400
104 #define MOTU_PA_INOUT            (MOTU_PA_IN | MOTU_PA_OUT)
105
106 /* Generic "direction" flags */
107 #define MOTU_DIR_IN          1
108 #define MOTU_DIR_OUT         2
109 #define MOTU_DIR_INOUT       (MOTU_DIR_IN | MOTU_DIR_OUT)
110
111 class ConfigRom;
112 class Ieee1394Service;
113
114 namespace Util {
115     class Configuration;
116 }
117
118 namespace Motu {
119
120 enum EMotuModel {
121     MOTU_MODEL_NONE     = 0x0000,
122     MOTU_MODEL_828mkII  = 0x0001,
123     MOTU_MODEL_TRAVELER = 0x0002,
124     MOTU_MODEL_ULTRALITE= 0x0003,
125     MOTU_MODEL_8PRE     = 0x0004,
126     MOTU_MODEL_828MkI   = 0x0005,
127     MOTU_MODEL_896HD    = 0x0006,
128 };
129
130 struct VendorModelEntry {
131     unsigned int vendor_id;
132     unsigned int model_id;
133     unsigned int unit_version;
134     unsigned int unit_specifier_id;
135     enum EMotuModel model;
136     const char *vendor_name;
137     const char *model_name;
138 };
139
140 struct PortEntry {
141     const char *port_name;
142     unsigned int port_flags;
143     unsigned int port_offset;
144 };
145
146 struct MixerCtrl {
147     const char *name, *label, *desc;
148     unsigned int type;
149     unsigned int dev_register;
150 };
151
152 struct MatrixMixBus {
153     const char *name;
154     unsigned int address;
155 };
156
157 struct MatrixMixChannel {
158     const char *name;
159     unsigned int flags;
160     unsigned int addr_ofs;
161 };
162
163 struct MotuMixer {
164     const MixerCtrl *mixer_ctrl;
165     unsigned int n_mixer_ctrls;
166     const MatrixMixBus *mixer_buses;
167     unsigned int n_mixer_buses;
168     const MatrixMixChannel *mixer_channels;
169     unsigned int n_mixer_channels;
170 };
171
172 struct DevicePropertyEntry {
173     const PortEntry* port_entry;
174     unsigned int n_port_entries;
175     signed int MaxSampleRate;
176     const struct MotuMixer *mixer;
177     // Others features can be added here like MIDI port presence.
178 };
179
180 /* Macro to calculate the size of an array */
181 #define N_ELEMENTS(_array) (sizeof(_array) / sizeof((_array)[0]))
182
183 /* Macro to define a MotuMixer structure succintly */
184 #define MOTUMIXER(_ctrls, _buses, _channels) \
185     { _ctrls, N_ELEMENTS(_ctrls), _buses, N_ELEMENTS(_buses), _channels, N_ELEMENTS(_channels), }
186
187 class MotuDevice : public FFADODevice {
188 public:
189
190     MotuDevice( DeviceManager& d, std::auto_ptr<ConfigRom>( configRom ) );
191     virtual ~MotuDevice();
192
193     virtual bool buildMixer();
194     virtual bool destroyMixer();
195
196     static bool probe( Util::Configuration&, ConfigRom& configRom, bool generic = false );
197     static FFADODevice * createDevice( DeviceManager& d, std::auto_ptr<ConfigRom>( configRom ));
198     static int getConfigurationId( );
199     virtual bool discover();
200
201     virtual void showDevice();
202
203     bool setClockCtrlRegister(signed int samplingFrequency, unsigned int clock_source);
204     virtual bool setSamplingFrequency( int samplingFrequency );
205     virtual int getSamplingFrequency( );
206     virtual std::vector<int> getSupportedSamplingFrequencies();
207
208     FFADODevice::ClockSource clockIdToClockSource(unsigned int id);
209     virtual ClockSourceVector getSupportedClockSources();
210     virtual bool setActiveClockSource(ClockSource);
211     virtual ClockSource getActiveClockSource();
212
213     virtual int getStreamCount();
214     virtual Streaming::StreamProcessor *getStreamProcessorByIndex(int i);
215     enum FFADODevice::eStreamingState getStreamingState();
216
217     virtual bool prepare();
218     virtual bool lock();
219     virtual bool unlock();
220
221     virtual bool startStreamByIndex(int i);
222     virtual bool stopStreamByIndex(int i);
223
224     signed int getIsoRecvChannel(void);
225     signed int getIsoSendChannel(void);
226     unsigned int getOpticalMode(unsigned int dir);
227     signed int setOpticalMode(unsigned int dir, unsigned int mode);
228
229     signed int getEventSize(unsigned int dir);
230
231     signed int       m_motu_model;
232 protected:
233     struct VendorModelEntry * m_model;
234     signed int m_iso_recv_channel, m_iso_send_channel;
235     signed int m_rx_bandwidth, m_tx_bandwidth;
236
237     Streaming::MotuReceiveStreamProcessor *m_receiveProcessor;
238     Streaming::MotuTransmitStreamProcessor *m_transmitProcessor;
239
240 private:
241     bool buildMixerAudioControls(void);
242     bool addPort(Streaming::StreamProcessor *s_processor,
243         char *name,
244         enum Streaming::Port::E_Direction direction,
245         int position, int size);
246     bool addDirPorts(
247         enum Streaming::Port::E_Direction direction,
248         unsigned int sample_rate, unsigned int optical_mode);
249
250 public:
251     unsigned int ReadRegister(unsigned int reg);
252     signed int WriteRegister(unsigned int reg, quadlet_t data);
253
254 private:
255     Control::Container *m_MixerContainer;
256     Control::Container *m_ControlContainer;
257 };
258
259 }
260
261 #endif
Note: See TracBrowser for help on using the browser.