root/trunk/libffado/src/libieee1394/IsoHandler.h

Revision 1246, 6.3 kB (checked in by ppalmers, 13 years ago)

add dead handler detection

Line 
1 /*
2  * Copyright (C) 2005-2008 by Pieter Palmers
3  *
4  * This file is part of FFADO
5  * FFADO = Free Firewire (pro-)audio drivers for linux
6  *
7  * FFADO is based upon FreeBoB.
8  *
9  * This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation, either version 2 of the License, or
12  * (at your option) version 3 of the License.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
21  *
22  */
23
24 #ifndef __FFADO_ISOHANDLER__
25 #define __FFADO_ISOHANDLER__
26
27 #include "debugmodule/debugmodule.h"
28
29 #include "libutil/Thread.h"
30
31 enum raw1394_iso_disposition;
32
33 class IsoHandlerManager;
34 namespace Streaming {
35     class StreamProcessor;
36 }
37
38 /*!
39 \brief The Base Class for ISO Handlers
40
41  These classes perform the actual ISO communication through libraw1394.
42  They are different from Streaming::StreamProcessors because one handler can provide multiple
43  streams with packets in case of ISO multichannel receive.
44
45 */
46
47 class IsoHandler
48 {
49 public:
50     enum EHandlerType {
51             eHT_Receive,
52             eHT_Transmit
53     };
54     IsoHandler(IsoHandlerManager& manager, enum EHandlerType t);
55     IsoHandler(IsoHandlerManager& manager, enum EHandlerType t,
56                unsigned int buf_packets, unsigned int max_packet_size, int irq);
57     IsoHandler(IsoHandlerManager& manager, enum EHandlerType t,
58                unsigned int buf_packets, unsigned int max_packet_size, int irq, enum raw1394_iso_speed speed);
59     ~IsoHandler();
60
61 private: // the ISO callback interface
62     static enum raw1394_iso_disposition
63     iso_receive_handler(raw1394handle_t handle, unsigned char *data,
64                         unsigned int length, unsigned char channel,
65                         unsigned char tag, unsigned char sy, unsigned int cycle,
66                         unsigned int dropped);
67
68     enum raw1394_iso_disposition
69             putPacket(unsigned char *data, unsigned int length,
70                         unsigned char channel, unsigned char tag, unsigned char sy,
71                         unsigned int cycle, unsigned int dropped, unsigned int skipped);
72
73     static enum raw1394_iso_disposition iso_transmit_handler(raw1394handle_t handle,
74                     unsigned char *data, unsigned int *length,
75                     unsigned char *tag, unsigned char *sy,
76                     int cycle, unsigned int dropped);
77     enum raw1394_iso_disposition
78             getPacket(unsigned char *data, unsigned int *length,
79                     unsigned char *tag, unsigned char *sy,
80                     int cycle, unsigned int dropped, unsigned int skipped);
81
82 public:
83
84     /**
85      * Iterate the handler, transporting ISO packets to the client(s)
86      * @return true if success
87      */
88     bool iterate();
89
90     /**
91      * Iterate the handler, transporting ISO packets to the client(s)
92      * @param  ctr_now the CTR time at which the iterate call is done.
93      * @return true if success
94      */
95     bool iterate(uint32_t ctr_now);
96
97     int getFileDescriptor() { return raw1394_get_fd(m_handle);};
98
99     bool init();
100     bool prepare();
101
102     void setVerboseLevel(int l);
103
104     bool enable() {return enable(-1);};
105     bool enable(int cycle);
106     bool disable();
107
108     void flush();
109     enum EHandlerType getType() {return m_type;};
110     const char *getTypeString() {return eHTToString(m_type); };
111
112     // pretty printing
113     const char *eHTToString(enum EHandlerType);
114
115     bool isEnabled()
116         {return m_State == E_Running;};
117
118     // no setter functions, because those would require a re-init
119     unsigned int getMaxPacketSize() { return m_max_packet_size;};
120     unsigned int getNbBuffers() { return m_buf_packets;};
121     int getPacketLatency() { return m_irq_interval;};
122
123     unsigned int getPreBuffers() {return m_prebuffers;};
124     void setPreBuffers(unsigned int n) {m_prebuffers=n;};
125
126     void dumpInfo();
127
128     bool inUse() {return (m_Client != 0) ;};
129     bool isStreamRegistered(Streaming::StreamProcessor *s) {return (m_Client == s);};
130
131     bool registerStream(Streaming::StreamProcessor *);
132     bool unregisterStream(Streaming::StreamProcessor *);
133
134     bool canIterateClient(); // FIXME: implement with functor
135
136     /**
137      * @brief request that the handler exits the packet processing loop ASAP
138      *
139      * The raw1394 lib doesn't provide a means to stop the packet iteration loop
140      * except when the iterate callback returns a DEFER value. Calling this function
141      * will make the callback return DEFER ASAP.
142      */
143     void requestIterateLoopExit() {m_dont_exit_iterate_loop = false;};
144     /**
145      * @brief allow the handler to stay in the packet processing loop
146      *
147      * This resets the state set by requestIterateLoopExit()
148      */
149     void allowIterateLoop() {m_dont_exit_iterate_loop = true;};
150
151
152     /**
153      * @brief get last cycle number seen by handler
154      * @return cycle number
155      */
156     int getLastCycle() {return m_last_cycle;};
157
158     /**
159      * @brief returns the CTR value saved at the last iterate() call
160      * @return CTR value saved at last iterate() call
161      */
162     uint32_t getLastIterateTime() {return m_last_now;};
163
164     void notifyOfDeath();
165 private:
166     IsoHandlerManager& m_manager;
167     enum EHandlerType m_type;
168     raw1394handle_t m_handle;
169     unsigned int    m_buf_packets;
170     unsigned int    m_max_packet_size;
171     int             m_irq_interval;
172     int             m_last_cycle;
173     uint32_t        m_last_now;
174
175     Streaming::StreamProcessor *m_Client; // FIXME: implement with functors
176
177     int handleBusReset(unsigned int generation);
178
179     static int busreset_handler(raw1394handle_t handle, unsigned int generation);
180
181     enum raw1394_iso_speed m_speed;
182     unsigned int m_prebuffers;
183     bool m_dont_exit_iterate_loop;
184
185     // the state machine
186     enum EHandlerStates {
187         E_Created,
188         E_Initialized,
189         E_Prepared,
190         E_Running,
191         E_Error
192     };
193     enum EHandlerStates m_State;
194
195     #ifdef DEBUG
196     unsigned int    m_packets;
197     unsigned int    m_dropped;
198     int             m_min_ahead;
199     #endif
200
201     DECLARE_DEBUG_MODULE;
202 };
203
204 #endif /* __FFADO_ISOHANDLER__  */
205
206
207
Note: See TracBrowser for help on using the browser.