author | mikaruus <mika.a.ruuskanen@nokia.com> |
Wed, 17 Feb 2010 13:58:55 +0200 | |
changeset 7 | fa67e03b87df |
parent 0 | 63b37f68c1ce |
permissions | -rw-r--r-- |
0 | 1 |
/* |
2 |
* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). |
|
3 |
* All rights reserved. |
|
4 |
* This component and the accompanying materials are made available |
|
5 |
* under the terms of the License "Eclipse Public License v1.0" |
|
6 |
* which accompanies this distribution, and is available |
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 |
* |
|
9 |
* Initial Contributors: |
|
10 |
* Nokia Corporation - initial contribution. |
|
11 |
* |
|
12 |
* Contributors: |
|
13 |
* |
|
14 |
* Description: |
|
15 |
* |
|
16 |
*/ |
|
17 |
||
18 |
||
19 |
#ifndef CUSBPNUSBRECEIVER_H |
|
20 |
#define CUSBPNUSBRECEIVER_H |
|
21 |
||
22 |
// INCLUDES |
|
23 |
#include <e32base.h> // For CActive |
|
24 |
||
25 |
#include "musbpnbufferlistener.h" |
|
26 |
||
27 |
// CONSTANTS |
|
28 |
// MACROS |
|
29 |
// DATA TYPES |
|
30 |
// FUNCTION PROTOTYPES |
|
31 |
// FORWARD DECLARATIONS |
|
32 |
class CUsbPnIsaSender; |
|
33 |
class MUsbPnControlObserver; |
|
34 |
class CUsbPnPacket; |
|
35 |
class RDevUsbcClient; |
|
36 |
class RIscApi; |
|
37 |
||
38 |
// CLASS DECLARATION |
|
39 |
||
40 |
/** |
|
41 |
* Receiver for data coming from USB. |
|
42 |
*/ |
|
43 |
class CUsbPnUsbReceiver : public CActive, public MUsbPnBufferListener |
|
44 |
{ |
|
45 |
public: // Constructors and destructor |
|
46 |
||
47 |
/** |
|
48 |
* Two-phased constructor. |
|
49 |
*/ |
|
50 |
static CUsbPnUsbReceiver* NewL( RDevUsbcClient& aLdd, RIscApi& aIsc ); |
|
51 |
||
52 |
/** |
|
53 |
* Destructor. |
|
54 |
*/ |
|
55 |
~CUsbPnUsbReceiver(); |
|
56 |
||
57 |
public: // New functions |
|
58 |
||
59 |
/** |
|
60 |
* Get pointer for sending control messages. |
|
61 |
* @return pointer to control observer API |
|
62 |
*/ |
|
63 |
MUsbPnControlObserver* IsaSender(); |
|
64 |
||
65 |
/** |
|
66 |
* Sets state to enumerated. |
|
67 |
* @param aState ETrue says usb is enumerated |
|
68 |
*/ |
|
69 |
void SetEnumerated( TBool aState ); |
|
70 |
||
71 |
public: // Functions from base classes |
|
72 |
||
73 |
/** |
|
74 |
* From MUsbPnBufferListener. Called by CUsbPnInterface when initialised |
|
75 |
* or by sender when reactivating receive. |
|
76 |
* @param TBool aDiscard. Flag for determining if data can be transmitted to USB. |
|
77 |
*/ |
|
78 |
void Receive( TBool aDiscard ); |
|
79 |
||
80 |
||
81 |
protected: // Functions from base classes |
|
82 |
||
83 |
/** |
|
84 |
* From CActive. |
|
85 |
*/ |
|
86 |
void DoCancel(); |
|
87 |
||
88 |
/** |
|
89 |
* From CActive. |
|
90 |
*/ |
|
91 |
void RunL(); |
|
92 |
||
93 |
/** |
|
94 |
* From CActive. |
|
95 |
*/ |
|
96 |
TInt RunError( TInt ); |
|
97 |
||
98 |
||
99 |
private: |
|
100 |
||
101 |
/** |
|
102 |
* C++ default constructor. |
|
103 |
*/ |
|
104 |
CUsbPnUsbReceiver( RDevUsbcClient& aLdd ); |
|
105 |
||
106 |
/** |
|
107 |
* By default Symbian 2nd phase constructor is private. |
|
108 |
*/ |
|
109 |
void ConstructL( RIscApi& aIscApi ); |
|
110 |
||
111 |
||
112 |
/** |
|
113 |
* Construct message as needed by receiver. |
|
114 |
*/ |
|
115 |
void ConstructMessageL(); |
|
116 |
||
7
fa67e03b87df
New release based on our 2010wk08 release
mikaruus <mika.a.ruuskanen@nokia.com>
parents:
0
diff
changeset
|
117 |
/** |
fa67e03b87df
New release based on our 2010wk08 release
mikaruus <mika.a.ruuskanen@nokia.com>
parents:
0
diff
changeset
|
118 |
* Set message complete flag |
fa67e03b87df
New release based on our 2010wk08 release
mikaruus <mika.a.ruuskanen@nokia.com>
parents:
0
diff
changeset
|
119 |
* @param aMsgComplete ETrue says message constructed |
fa67e03b87df
New release based on our 2010wk08 release
mikaruus <mika.a.ruuskanen@nokia.com>
parents:
0
diff
changeset
|
120 |
*/ |
fa67e03b87df
New release based on our 2010wk08 release
mikaruus <mika.a.ruuskanen@nokia.com>
parents:
0
diff
changeset
|
121 |
void SetMessageComplete( const TBool aMsgComplete ); |
fa67e03b87df
New release based on our 2010wk08 release
mikaruus <mika.a.ruuskanen@nokia.com>
parents:
0
diff
changeset
|
122 |
|
fa67e03b87df
New release based on our 2010wk08 release
mikaruus <mika.a.ruuskanen@nokia.com>
parents:
0
diff
changeset
|
123 |
/** |
fa67e03b87df
New release based on our 2010wk08 release
mikaruus <mika.a.ruuskanen@nokia.com>
parents:
0
diff
changeset
|
124 |
* Set message byte count |
fa67e03b87df
New release based on our 2010wk08 release
mikaruus <mika.a.ruuskanen@nokia.com>
parents:
0
diff
changeset
|
125 |
* @param aByteCount counts packet bytes. Append to previous if next msg |
fa67e03b87df
New release based on our 2010wk08 release
mikaruus <mika.a.ruuskanen@nokia.com>
parents:
0
diff
changeset
|
126 |
*/ |
fa67e03b87df
New release based on our 2010wk08 release
mikaruus <mika.a.ruuskanen@nokia.com>
parents:
0
diff
changeset
|
127 |
void SetByteCount( const TUint aByteCount ); |
fa67e03b87df
New release based on our 2010wk08 release
mikaruus <mika.a.ruuskanen@nokia.com>
parents:
0
diff
changeset
|
128 |
|
fa67e03b87df
New release based on our 2010wk08 release
mikaruus <mika.a.ruuskanen@nokia.com>
parents:
0
diff
changeset
|
129 |
/** |
fa67e03b87df
New release based on our 2010wk08 release
mikaruus <mika.a.ruuskanen@nokia.com>
parents:
0
diff
changeset
|
130 |
* Set message length |
fa67e03b87df
New release based on our 2010wk08 release
mikaruus <mika.a.ruuskanen@nokia.com>
parents:
0
diff
changeset
|
131 |
* @param aMessageLength ISI msg length |
fa67e03b87df
New release based on our 2010wk08 release
mikaruus <mika.a.ruuskanen@nokia.com>
parents:
0
diff
changeset
|
132 |
*/ |
fa67e03b87df
New release based on our 2010wk08 release
mikaruus <mika.a.ruuskanen@nokia.com>
parents:
0
diff
changeset
|
133 |
void SetMessageLength( const TUint aMessageLength ); |
0 | 134 |
|
135 |
private: // Data |
|
136 |
||
137 |
// Ownership. Object for forwarding received data. |
|
138 |
CUsbPnIsaSender* iIsaSender; |
|
139 |
||
140 |
// Reference to USB driver ldd. |
|
141 |
RDevUsbcClient& iLdd; |
|
142 |
||
143 |
// Not owned. Pointer to receivable packet |
|
144 |
CUsbPnPacket* iPacket; |
|
145 |
||
146 |
// Modifiable ptr for receiving |
|
147 |
TPtr8 iRecvPtr; |
|
148 |
||
149 |
// Whole message received |
|
150 |
TBool iMessageComplete; |
|
151 |
||
152 |
// ISI message length |
|
153 |
TUint iMessageLength; |
|
154 |
||
155 |
// Whole message length |
|
156 |
TUint iByteCount; |
|
157 |
||
158 |
// Ownership. Temporary buffer for first part of exceptionally big message |
|
159 |
HBufC8* iStorage; |
|
160 |
||
161 |
TBool iEnumerated; |
|
162 |
||
163 |
}; |
|
164 |
||
165 |
#endif // CUSBPNUSBRECEIVER_H |
|
166 |
||
167 |
// End of File |