root/trunk/libffado/src/motu/motu_avdevice.h

Revision 1265, 7.5 kB (checked in by jwoithe, 16 years ago)

MOTU: major reworking of mixer dbus interface structure. Matrix mixers are used (where it makes sense) to greatly reduce the number of dbus nodes required to a number well below the default limit.

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 /* Device registers */
71 #define MOTU_REG_ISOCTRL           0x0b00
72 #define MOTU_REG_OPTICAL_CTRL      0x0b10
73 #define MOTU_REG_CLK_CTRL          0x0b14
74 #define MOTU_REG_ROUTE_PORT_CONF   0x0c04
75 #define MOTU_REG_INPUT_LEVEL       0x0c08
76 #define MOTU_REG_INPUT_BOOST       0x0c14
77 #define MOTU_REG_INPUT_GAIN_PAD_0  0x0c1c
78 #define MOTU_REG_CLKSRC_NAME0      0x0c60
79
80 /* Port Active Flags (ports declaration) */
81 #define MOTU_PA_RATE_1x          0x0001    /* 44k1 or 48k */
82 #define MOTU_PA_RATE_2x          0x0002    /* 88k2 or 96k */
83 #define MOTU_PA_RATE_4x          0x0004    /* 176k4 or 192k */
84 #define MOTU_PA_RATE_1x2x        (MOTU_PA_RATE_1x|MOTU_PA_RATE_2x)
85 #define MOTU_PA_RATE_ANY         (MOTU_PA_RATE_1x|MOTU_PA_RATE_2x|MOTU_PA_RATE_4x)
86 #define MOTU_PA_RATE_MASK        MOTU_PA_RATE_ANY
87 #define MOTU_PA_OPTICAL_OFF      0x0010    /* Optical port off */
88 #define MOTU_PA_OPTICAL_ADAT     0x0020    /* Optical port in ADAT mode */
89 #define MOTU_PA_OPTICAL_TOSLINK  0x0040    /* Optical port in SPDIF/Toslink mode */
90 #define MOTU_PA_OPTICAL_ON       (MOTU_PA_OPTICAL_ADAT|MOTU_PA_OPTICAL_TOSLINK)
91 #define MOTU_PA_OPTICAL_ANY      (MOTU_PA_OPTICAL_OFF|MOTU_PA_OPTICAL_ON)
92 #define MOTU_PA_OPTICAL_MASK     MOTU_PA_OPTICAL_ANY
93
94 class ConfigRom;
95 class Ieee1394Service;
96
97 namespace Motu {
98
99 enum EMotuModel {
100     MOTU_MODEL_NONE     = 0x0000,
101     MOTU_MODEL_828mkII  = 0x0001,
102     MOTU_MODEL_TRAVELER = 0x0002,
103     MOTU_MODEL_ULTRALITE= 0x0003,
104     MOTU_MODEL_8PRE     = 0x0004,
105     MOTU_MODEL_828MkI   = 0x0005,
106     MOTU_MODEL_896HD    = 0x0006,
107 };
108
109 struct VendorModelEntry {
110     unsigned int vendor_id;
111     unsigned int model_id;
112     unsigned int unit_version;
113     unsigned int unit_specifier_id;
114     enum EMotuModel model;
115     const char *vendor_name;
116     const char *model_name;
117 };
118
119 struct PortEntry {
120     const char *port_name;
121     unsigned int port_dir;
122     unsigned int port_flags;
123     unsigned int port_offset;
124 };
125
126 struct MixerCtrl {
127     const char *name, *label, *desc;
128     unsigned int type;
129     unsigned int dev_register;
130 };
131
132 struct MatrixMixBus {
133     const char *name;
134     unsigned int address;
135 };
136
137 struct MatrixMixChannel {
138     const char *name;
139     unsigned int flags;
140     unsigned int addr_ofs;
141 };
142
143 struct MotuMixer {
144     const MixerCtrl *mixer_ctrl;
145     unsigned int n_mixer_ctrls;
146     const MatrixMixBus *mixer_buses;
147     unsigned int n_mixer_buses;
148     const MatrixMixChannel *mixer_channels;
149     unsigned int n_mixer_channels;
150 };
151
152 struct DevicePropertyEntry {
153     const PortEntry* port_entry;
154     unsigned int n_port_entries;
155     signed int MaxSampleRate;
156     const struct MotuMixer *mixer;
157     // Others features can be added here like MIDI port presence.
158 };
159
160 /* Macro to calculate the size of an array */
161 #define N_ELEMENTS(_array) (sizeof(_array) / sizeof((_array)[0]))
162
163 /* Macro to define a MotuMixer structure succintly */
164 #define MOTUMIXER(_ctrls, _buses, _channels) \
165     { _ctrls, N_ELEMENTS(_ctrls), _buses, N_ELEMENTS(_buses), _channels, N_ELEMENTS(_channels), }
166
167 class MotuDevice : public FFADODevice {
168 public:
169
170     MotuDevice( DeviceManager& d, std::auto_ptr<ConfigRom>( configRom ) );
171     virtual ~MotuDevice();
172
173     virtual bool buildMixer();
174     virtual bool destroyMixer();
175
176     static bool probe( ConfigRom& configRom, bool generic = false );
177     static FFADODevice * createDevice( DeviceManager& d, std::auto_ptr<ConfigRom>( configRom ));
178     static int getConfigurationId( );
179     virtual bool discover();
180
181     virtual void showDevice();
182
183     bool setClockCtrlRegister(signed int samplingFrequency, unsigned int clock_source);
184     virtual bool setSamplingFrequency( int samplingFrequency );
185     virtual int getSamplingFrequency( );
186
187     FFADODevice::ClockSource clockIdToClockSource(unsigned int id);
188     virtual ClockSourceVector getSupportedClockSources();
189     virtual bool setActiveClockSource(ClockSource);
190     virtual ClockSource getActiveClockSource();
191
192     virtual int getStreamCount();
193     virtual Streaming::StreamProcessor *getStreamProcessorByIndex(int i);
194
195     virtual bool prepare();
196     virtual bool lock();
197     virtual bool unlock();
198
199     virtual bool startStreamByIndex(int i);
200     virtual bool stopStreamByIndex(int i);
201
202     signed int getIsoRecvChannel(void);
203     signed int getIsoSendChannel(void);
204     unsigned int getOpticalMode(unsigned int dir);
205     signed int setOpticalMode(unsigned int dir, unsigned int mode);
206
207     signed int getEventSize(unsigned int dir);
208
209     signed int       m_motu_model;
210 protected:
211     struct VendorModelEntry * m_model;
212     signed int m_iso_recv_channel, m_iso_send_channel;
213     signed int m_rx_bandwidth, m_tx_bandwidth;
214
215     Streaming::MotuReceiveStreamProcessor *m_receiveProcessor;
216     Streaming::MotuTransmitStreamProcessor *m_transmitProcessor;
217
218 private:
219     bool addPort(Streaming::StreamProcessor *s_processor,
220         char *name,
221         enum Streaming::Port::E_Direction direction,
222         int position, int size);
223     bool addDirPorts(
224         enum Streaming::Port::E_Direction direction,
225         unsigned int sample_rate, unsigned int optical_mode);
226
227 public:
228     unsigned int ReadRegister(unsigned int reg);
229     signed int WriteRegister(unsigned int reg, quadlet_t data);
230
231 private:
232     Control::Container *m_MixerContainer;
233     Control::Container *m_ControlContainer;
234 };
235
236 }
237
238 #endif
Note: See TracBrowser for help on using the browser.