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

Revision 310, 4.9 kB (checked in by jwoithe, 16 years ago)

MOTU: fix optical mode detection and clear up some associated packet sizing issues.

Line 
1 /* motu_avdevice.h
2  * Copyright (C) 2006 by Pieter Palmers
3  * Copyright (C) 2006 Jonathan Woithe
4  *
5  * This file is part of FreeBob.
6  *
7  * FreeBob is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  * FreeBob is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with FreeBob; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
19  * MA 02111-1307 USA.
20  */
21
22 #ifndef MOTUDEVICE_H
23 #define MOTUDEVICE_H
24
25 #include "iavdevice.h"
26
27 #include "debugmodule/debugmodule.h"
28 #include "libfreebobavc/avc_definitions.h"
29 #include "libfreebob/xmlparser.h"
30
31 #include "libstreaming/MotuStreamProcessor.h"
32
33 #define MOTUFW_BASE_ADDR                0xfffff0000000ULL
34
35 #define MOTUFW_RATE_BASE_44100          (0<<3)
36 #define MOTUFW_RATE_BASE_48000          (1<<3)
37 #define MOTUFW_RATE_MULTIPLIER_1X       (0<<4)
38 #define MOTUFW_RATE_MULTIPLIER_2X       (1<<4)
39 #define MOTUFW_RATE_MULTIPLIER_4X       (2<<4)
40 #define MOTUFW_RATE_BASE_MASK           (0x00000008)
41 #define MOTUFW_RATE_MULTIPLIER_MASK     (0x00000030)
42
43 #define MOTUFW_OPTICAL_MODE_OFF         0x00
44 #define MOTUFW_OPTICAL_MODE_ADAT        0x01
45 #define MOTUFW_OPTICAL_MODE_TOSLINK     0x02
46 #define MOTUFW_OPTICAL_IN_MODE_MASK     (0x00000300)
47 #define MOTUFW_OPTICAL_OUT_MODE_MASK    (0x00000c00)
48 #define MOTUFW_OPTICAL_MODE_MASK        (MOTUFW_OPTICAL_IN_MODE_MASK|MOTUFW_OPTICAL_MODE_MASK)
49
50 #define MOTUFW_CLKSRC_MASK              0x00000007
51 #define MOTUFW_CLKSRC_INTERNAL          0
52 #define MOTUFW_CLKSRC_ADAT_OPTICAL      1
53 #define MOTUFW_CLKSRC_SPDIF_TOSLINK     2
54 #define MOTUFW_CLKSRC_SMTPE             3
55 #define MOTUFW_CLKSRC_WORDCLOCK         4
56 #define MOTUFW_CLKSRC_ADAT_9PIN         5
57 #define MOTUFW_CLKSRC_AES_EBU           7
58
59 #define MOTUFW_DIR_IN                   1
60 #define MOTUFW_DIR_OUT                  2
61 #define MOTUFW_DIR_INOUT                (MOTUFW_DIR_IN | MOTUFW_DIR_OUT)
62
63 /* Device registers */
64 #define MOTUFW_REG_ISOCTRL              0x0b00
65 #define MOTUFW_REG_OPTICAL_CTRL         0x0b10
66 #define MOTUFW_REG_CLK_CTRL             0x0b14
67 #define MOTUFW_REG_ROUTE_PORT_CONF      0x0c04
68 #define MOTUFW_REG_CLKSRC_NAME0         0x0c60
69
70 class ConfigRom;
71 class Ieee1394Service;
72
73 namespace Motu {
74
75 class MotuDevice : public IAvDevice {
76 public:
77     enum EMotuModel {
78       MOTUFW_MODEL_NONE     = 0x0000,
79       MOTUFW_MODEL_828mkII  = 0x0001,
80       MOTUFW_MODEL_TRAVELER = 0x0002,
81     };
82
83     MotuDevice( Ieee1394Service& ieee1394Service,
84                   int nodeId,
85                   int verboseLevel );
86     virtual ~MotuDevice();
87
88     virtual bool discover();
89     virtual ConfigRom& getConfigRom() const;
90
91     // obsolete, will be removed soon, unused
92     virtual bool addXmlDescription( xmlNodePtr deviceNode ) {return true;};
93
94     virtual void showDevice() const;
95
96     virtual bool setSamplingFrequency( ESamplingFrequency samplingFrequency );
97     virtual int getSamplingFrequency( );
98
99     virtual bool setId(unsigned int id);
100
101     virtual int getStreamCount();
102     virtual FreebobStreaming::StreamProcessor *getStreamProcessorByIndex(int i);
103
104     virtual bool prepare();
105
106     virtual int startStreamByIndex(int i);
107     virtual int stopStreamByIndex(int i);
108
109     signed int getIsoRecvChannel(void);
110     signed int getIsoSendChannel(void);
111     unsigned int getOpticalMode(unsigned int dir);
112     signed int setOpticalMode(unsigned int dir, unsigned int mode);
113
114     signed int getEventSize(unsigned int dir);
115  
116 protected:
117     Ieee1394Service* m_1394Service;
118     ConfigRom*       m_configRom;
119     signed int       m_motu_model;
120     int              m_nodeId;
121     int              m_verboseLevel;
122     signed int m_id;
123     signed int m_iso_recv_channel, m_iso_send_channel;
124     signed int m_bandwidth;
125    
126         FreebobStreaming::MotuReceiveStreamProcessor *m_receiveProcessor;
127         FreebobStreaming::MotuTransmitStreamProcessor *m_transmitProcessor;
128
129 private:
130         bool addPort(FreebobStreaming::StreamProcessor *s_processor,
131                 char *name,
132                 enum FreebobStreaming::Port::E_Direction direction,
133                 int position, int size);
134         bool addDirPorts(
135                 enum FreebobStreaming::Port::E_Direction direction,
136                 unsigned int sample_rate, unsigned int optical_mode);
137        
138         unsigned int ReadRegister(unsigned int reg);
139         signed int WriteRegister(unsigned int reg, quadlet_t data);
140
141         // IEEE1394 Vendor IDs.  One would expect only MOTU, but you never
142         // know if a clone might appear some day.
143         enum EVendorId {
144                 MOTUFW_VENDOR_MOTU = 0x000001f2,
145         };
146        
147         // IEEE1394 Unit directory version IDs for different MOTU hardware
148         enum EUnitVersionId {
149                 MOTUFW_UNITVER_828mkII  = 0x00000003,
150                 MOTUFW_UNITVER_TRAVELER = 0x00000009,
151         };
152
153     // debug support
154     DECLARE_DEBUG_MODULE;
155 };
156
157 }
158
159 #endif
Note: See TracBrowser for help on using the browser.