root/branches/streaming-rework/src/motu/motu_avdevice.h

Revision 412, 4.8 kB (checked in by pieterpalmers, 16 years ago)

- added some documentation
- added a lock()/unlock() to IAvDevice (see header)
- reimplemented test-freebob to the new C++ api
- started with support for AddressRangeMapping?, i.e. response

to reads/writes of the 1394 memory space on the host

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 enum EMotuModel {
76       MOTUFW_MODEL_NONE     = 0x0000,
77       MOTUFW_MODEL_828mkII  = 0x0001,
78       MOTUFW_MODEL_TRAVELER = 0x0002,
79 };
80
81 struct VendorModelEntry {
82     unsigned int vendor_id;
83     unsigned int model_id;
84     unsigned int unit_version;
85     unsigned int unit_specifier_id;
86     enum EMotuModel model;
87     char *vendor_name;
88     char *model_name;
89 };
90
91 class MotuDevice : public IAvDevice {
92 public:
93
94     MotuDevice( std::auto_ptr<ConfigRom>( configRom ),
95           Ieee1394Service& ieee1394Service,
96                   int nodeId,
97                   int verboseLevel );
98     virtual ~MotuDevice();
99
100     static bool probe( ConfigRom& configRom );
101     virtual bool discover();
102     virtual ConfigRom& getConfigRom() const;
103
104     // obsolete, will be removed soon, unused
105     virtual bool addXmlDescription( xmlNodePtr deviceNode ) {return true;};
106
107     virtual void showDevice() const;
108
109     virtual bool setSamplingFrequency( ESamplingFrequency samplingFrequency );
110     virtual int getSamplingFrequency( );
111
112     virtual bool setId(unsigned int id);
113
114     virtual int getStreamCount();
115     virtual FreebobStreaming::StreamProcessor *getStreamProcessorByIndex(int i);
116
117     virtual bool prepare();
118     bool lock();
119     bool unlock();
120    
121     virtual int startStreamByIndex(int i);
122     virtual int stopStreamByIndex(int i);
123
124     signed int getIsoRecvChannel(void);
125     signed int getIsoSendChannel(void);
126     unsigned int getOpticalMode(unsigned int dir);
127     signed int setOpticalMode(unsigned int dir, unsigned int mode);
128
129     signed int getEventSize(unsigned int dir);
130  
131 protected:
132     std::auto_ptr<ConfigRom>( m_configRom );
133     Ieee1394Service* m_1394Service;
134    
135     signed int       m_motu_model;
136     struct VendorModelEntry * m_model;
137     int              m_nodeId;
138     int              m_verboseLevel;
139     signed int m_id;
140     signed int m_iso_recv_channel, m_iso_send_channel;
141     signed int m_bandwidth;
142    
143         FreebobStreaming::MotuReceiveStreamProcessor *m_receiveProcessor;
144         FreebobStreaming::MotuTransmitStreamProcessor *m_transmitProcessor;
145
146 private:
147         bool addPort(FreebobStreaming::StreamProcessor *s_processor,
148                 char *name,
149                 enum FreebobStreaming::Port::E_Direction direction,
150                 int position, int size);
151         bool addDirPorts(
152                 enum FreebobStreaming::Port::E_Direction direction,
153                 unsigned int sample_rate, unsigned int optical_mode);
154        
155         unsigned int ReadRegister(unsigned int reg);
156         signed int WriteRegister(unsigned int reg, quadlet_t data);
157
158     // debug support
159     DECLARE_DEBUG_MODULE;
160 };
161
162 }
163
164 #endif
Note: See TracBrowser for help on using the browser.