0
|
1 |
/*
|
|
2 |
* Copyright (c) 2007-2008 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 |
|
|
20 |
// INCLUDE FILES
|
|
21 |
#include "dpdef.h" // dataport definitions
|
|
22 |
#include "dpdataport.h" // dataport main and c32 interface
|
|
23 |
#include "dpflowctrl.h" // flow control handling
|
|
24 |
#include "dppif.h" // dcs pipe interface
|
|
25 |
#include <iscdefinitions.h>
|
|
26 |
#include "dplog.h" // dataport logging
|
|
27 |
#include "osttracedefinitions.h"
|
|
28 |
#ifdef OST_TRACE_COMPILER_IN_USE
|
|
29 |
#include "dpflowctrltraces.h"
|
|
30 |
#endif
|
|
31 |
|
|
32 |
// EXTERNAL DATA STRUCTURES
|
|
33 |
// none
|
|
34 |
|
|
35 |
// EXTERNAL FUNCTION PROTOTYPES
|
|
36 |
// none
|
|
37 |
|
|
38 |
// CONSTANTS
|
|
39 |
// none
|
|
40 |
|
|
41 |
// MACROS
|
|
42 |
// none
|
|
43 |
|
|
44 |
// LOCAL CONSTANTS AND MACROS
|
|
45 |
// none
|
|
46 |
|
|
47 |
// MODULE DATA STRUCTURES
|
|
48 |
// none
|
|
49 |
|
|
50 |
// LOCAL FUNCTION PROTOTYPES
|
|
51 |
// none
|
|
52 |
|
|
53 |
// FORWARD DECLARATIONS
|
|
54 |
// none
|
|
55 |
|
|
56 |
// ============================= LOCAL FUNCTIONS ===============================
|
|
57 |
// none
|
|
58 |
|
|
59 |
// ============================ MEMBER FUNCTIONS ===============================
|
|
60 |
|
|
61 |
// -----------------------------------------------------------------------------
|
|
62 |
// CDpFlowCtrl::CDpFlowCtrl
|
|
63 |
// C++ default constructor can NOT contain any code, that
|
|
64 |
// might leave.
|
|
65 |
// -----------------------------------------------------------------------------
|
|
66 |
//
|
|
67 |
CDpFlowCtrl::CDpFlowCtrl(
|
|
68 |
CDpDataPort& aDataPort ) :
|
|
69 |
CActive( KDpFlowCtrlPriority ),
|
|
70 |
iDataPort( aDataPort ),
|
|
71 |
iPifDcs( iDataPort.Pif() ),
|
|
72 |
iFlowCtrlDp2Dcs( EFlowControlOn ),
|
|
73 |
iFlowCtrlDcs2Dp( EFlowControlOff ),
|
|
74 |
iLastFlowControlSentToClient( EFlowControlOn ),
|
|
75 |
iIsDataportReadyforDteFlow( EFalse )
|
|
76 |
{
|
|
77 |
OstTrace0( TRACE_NORMAL, CDPFLOWCTRL_CDPFLOWCTRL, "CDpFlowCtrl::CDpFlowCtrl" );
|
|
78 |
LOGM(" CDpFlowCtrl::CDpFlowCtrl");
|
|
79 |
|
|
80 |
iIscFlowCtrlStatus = EIscFlowControlOn;
|
|
81 |
|
|
82 |
CActiveScheduler::Add( this );
|
|
83 |
}
|
|
84 |
|
|
85 |
// -----------------------------------------------------------------------------
|
|
86 |
// CDpFlowCtrl::~CDpFlowCtrl
|
|
87 |
// Destructor
|
|
88 |
// -----------------------------------------------------------------------------
|
|
89 |
CDpFlowCtrl::~CDpFlowCtrl()
|
|
90 |
{
|
|
91 |
OstTrace0( TRACE_NORMAL, DUP1_CDPFLOWCTRL_CDPFLOWCTRL, "CDpFlowCtrl::~CDpFlowCtrl" );
|
|
92 |
LOGM(" CDpFlowCtrl::~CDpFlowCtrl");
|
|
93 |
}
|
|
94 |
|
|
95 |
// -----------------------------------------------------------------------------
|
|
96 |
// CDpFlowCtrl::RunL
|
|
97 |
// This method sets water mark according Isc Api' proxy's flow
|
|
98 |
// control status, if Dcs2Dp flow control status is not already set.
|
|
99 |
// Isc Api pipe data message buffer request is renewed.
|
|
100 |
// -----------------------------------------------------------------------------
|
|
101 |
//
|
|
102 |
void CDpFlowCtrl::RunL()
|
|
103 |
{
|
|
104 |
OstTrace0( TRACE_NORMAL, CDPFLOWCTRL_RUNL, "CDpFlowCtrl::RunL" );
|
|
105 |
OstTrace1( TRACE_NORMAL, DUP1_CDPFLOWCTRL_RUNL, "CDpFlowCtrl:: Port: %u", iDataPort.PortUnit() );
|
|
106 |
|
|
107 |
LOGM1("CDpFlowCtrl::RunL - Port %d", iDataPort.PortUnit() );
|
|
108 |
|
|
109 |
switch ( iIscFlowCtrlStatus )
|
|
110 |
{
|
|
111 |
// Dataport's Proxy's pipe data message buffer has reached HighWaterMark
|
|
112 |
case EIscFlowControlOn:
|
|
113 |
{
|
|
114 |
LOG(" CDpFlowCtrl::RunL, Proxy's High WaterMarkReached");
|
|
115 |
OstTrace0( TRACE_NORMAL, DUP2_CDPFLOWCTRL_RUNL, "CDpFlowCtrl:: Proxy's High WaterMarkReached" );
|
|
116 |
|
|
117 |
iFlowCtrlDp2Dcs = EFlowControlOn;
|
|
118 |
break;
|
|
119 |
}
|
|
120 |
// Dataport's Proxy's pipe data message buffer has reached LowWaterMark
|
|
121 |
case EIscFlowControlOff:
|
|
122 |
{
|
|
123 |
LOG(" CDpFlowCtrl::RunL, Proxy's Low WaterMarkReached");
|
|
124 |
OstTrace0( TRACE_NORMAL, DUP3_CDPFLOWCTRL_RUNL, "CDpFlowCtrl:: Proxy's Low WaterMarkReached" );
|
|
125 |
|
|
126 |
iFlowCtrlDp2Dcs = EFlowControlOff;
|
|
127 |
iPifDcs.SetPipeState( CDpPif::EDpPipeEnabled );
|
|
128 |
break;
|
|
129 |
}
|
|
130 |
// Connection closed, data transmission ended
|
|
131 |
case EIscTransmissionEnd:
|
|
132 |
{
|
|
133 |
LOG(" CDpFlowCtrl::RunL, Transmission End");
|
|
134 |
OstTrace0( TRACE_NORMAL, DUP4_CDPFLOWCTRL_RUNL, "CDpFlowCtrl:: Transmission End" );
|
|
135 |
|
|
136 |
// set flow control on
|
|
137 |
iFlowCtrlDp2Dcs = EFlowControlOn;
|
|
138 |
iFlowCtrlDcs2Dp = EFlowControlOn;
|
|
139 |
iPifDcs.SetPipeState( CDpPif::EDpPipeDisconnected );
|
|
140 |
break;
|
|
141 |
}
|
|
142 |
default:
|
|
143 |
{
|
|
144 |
// This should newer happen, No actions needed.
|
|
145 |
LOG(" CDpFlowCtrl::RunL, Proxy buffer reached HWM or LWM, but no action needed");
|
|
146 |
OstTrace0( TRACE_NORMAL, DUP5_CDPFLOWCTRL_RUNL, "CDpFlowCtrl:: Proxy buffer reached HWM or LWM, but no action needed" );
|
|
147 |
|
|
148 |
}
|
|
149 |
}
|
|
150 |
|
|
151 |
// inform client
|
|
152 |
if ( iFlowControlNotify )
|
|
153 |
{
|
|
154 |
InformFlowControlToClient();
|
|
155 |
}
|
|
156 |
// no else
|
|
157 |
|
|
158 |
// inform other modules
|
|
159 |
Notify();
|
|
160 |
|
|
161 |
if ( EIscTransmissionEnd != iIscFlowCtrlStatus )
|
|
162 |
{
|
|
163 |
// renew flow control request
|
|
164 |
RequestIscFlowControlNotification();
|
|
165 |
}
|
|
166 |
else
|
|
167 |
{
|
|
168 |
// Check if DataPort is ready to be deleted
|
|
169 |
if ( iDataPort.IsReadyToDestruct() )
|
|
170 |
{
|
|
171 |
iDataPort.DeleteDataPort();
|
|
172 |
}
|
|
173 |
//no else
|
|
174 |
}
|
|
175 |
}
|
|
176 |
|
|
177 |
// -----------------------------------------------------------------------------
|
|
178 |
// CDpFlowCtrl::RunError
|
|
179 |
// Leave in RunL() is handled here. Error code is returned,
|
|
180 |
// when internal error has occured.
|
|
181 |
// -----------------------------------------------------------------------------
|
|
182 |
//
|
|
183 |
TInt CDpFlowCtrl::RunError(
|
|
184 |
TInt aError )
|
|
185 |
{
|
|
186 |
OstTrace0( TRACE_NORMAL, CDPFLOWCTRL_RUNERROR, "CDpFlowCtrl::RunError" );
|
|
187 |
OstTraceExt2( TRACE_NORMAL, DUP1_CDPFLOWCTRL_RUNERROR, "CDpFlowCtrl:: Port: %u, error code: %d", iDataPort.PortUnit(), aError );
|
|
188 |
|
|
189 |
LOGM2("CDpFlowCtrl::RunError - Port %d, error code: %d",
|
|
190 |
iDataPort.PortUnit(), aError );
|
|
191 |
|
|
192 |
return aError;
|
|
193 |
}
|
|
194 |
|
|
195 |
// -----------------------------------------------------------------------------
|
|
196 |
// CDpFlowCtrl::RequestIscFlowControlNotification
|
|
197 |
// This method requests Isc Api pipe data message buffer status.
|
|
198 |
// -----------------------------------------------------------------------------
|
|
199 |
//
|
|
200 |
|
|
201 |
void CDpFlowCtrl::RequestIscFlowControlNotification()
|
|
202 |
{
|
|
203 |
OstTrace0( TRACE_NORMAL, CDPFLOWCTRL_REQUESTISCFLOWCONTROLNOTIFICATION, "CDpFlowCtrl::RequestIscFlowControlNotification" );
|
|
204 |
OstTrace1( TRACE_NORMAL, DUP1_CDPFLOWCTRL_REQUESTISCFLOWCONTROLNOTIFICATION, "CDpFlowCtrl:: Port: %u", iDataPort.PortUnit() );
|
|
205 |
|
|
206 |
LOGM1(" CDpFlowCtrl::RequestIscFlowControlNotification - Port %d",
|
|
207 |
iDataPort.PortUnit() );
|
|
208 |
|
|
209 |
if ( !IsActive() )
|
|
210 |
{
|
|
211 |
iDataPort.ISAHandle().NotifyFlowControl(
|
|
212 |
iStatus, iIscFlowCtrlStatus );
|
|
213 |
SetActive();
|
|
214 |
}
|
|
215 |
// no else
|
|
216 |
}
|
|
217 |
|
|
218 |
// -----------------------------------------------------------------------------
|
|
219 |
// CDpFlowCtrl::DoCancel
|
|
220 |
// This method cancels this active object by RequestComplete().
|
|
221 |
// Must be called directly (not through Cancel()), when RunL()
|
|
222 |
// should be completed with KErrCancel.
|
|
223 |
// -----------------------------------------------------------------------------
|
|
224 |
//
|
|
225 |
void CDpFlowCtrl::DoCancel()
|
|
226 |
{
|
|
227 |
OstTrace0( TRACE_NORMAL, CDPFLOWCTRL_DOCANCEL, "CDpFlowCtrl::DoCancel" );
|
|
228 |
LOG(" CDpFlowCtrl::DoCancel");
|
|
229 |
|
|
230 |
// do the required signaling
|
|
231 |
iDataPort.ISAHandle().NotifyFlowControlCancel();
|
|
232 |
}
|
|
233 |
|
|
234 |
// -----------------------------------------------------------------------------
|
|
235 |
// CDpFlowCtrl::GetDp2DcsFlowControlStatus
|
|
236 |
// Gets flowcontrol status of DP-->DCS
|
|
237 |
// -----------------------------------------------------------------------------
|
|
238 |
//
|
|
239 |
void CDpFlowCtrl::GetDp2DcsFlowControlStatus(
|
|
240 |
TFlowControl& aFlowControl )
|
|
241 |
{
|
|
242 |
OstTrace0( TRACE_NORMAL, CDPFLOWCTRL_GETDP2DCSFLOWCONTROLSTATUS, "CDpFlowCtrl::GetDp2DcsFlowControlStatus" );
|
|
243 |
LOGM(" CDpFlowCtrl::GetDp2DcsFlowControlStatus");
|
|
244 |
|
|
245 |
aFlowControl = iFlowCtrlDp2Dcs;
|
|
246 |
}
|
|
247 |
|
|
248 |
// -----------------------------------------------------------------------------
|
|
249 |
// CDpFlowCtrl::SetFlowControlNotify
|
|
250 |
// Set the flow control notify enabled/disabled.
|
|
251 |
// -----------------------------------------------------------------------------
|
|
252 |
//
|
|
253 |
void CDpFlowCtrl::SetFlowControlNotify(
|
|
254 |
const TBool aEnableNotify )
|
|
255 |
{
|
|
256 |
OstTrace0( TRACE_NORMAL, CDPFLOWCTRL_SETFLOWCONTROLNOTIFY, "CDpFlowCtrl::SetFlowControlNotify" );
|
|
257 |
LOGM(" CDpFlowCtrl::SetFlowControlNotify");
|
|
258 |
|
|
259 |
iFlowControlNotify = aEnableNotify;
|
|
260 |
// new flow control message is received while notification was not active.
|
|
261 |
if ( aEnableNotify && ( iLastFlowControlSentToClient != iFlowCtrlDp2Dcs ) )
|
|
262 |
{
|
|
263 |
InformFlowControlToClient();
|
|
264 |
}
|
|
265 |
// no else
|
|
266 |
}
|
|
267 |
|
|
268 |
// -----------------------------------------------------------------------------
|
|
269 |
// CDpFlowCtrl::WaterMarkLowReached
|
|
270 |
// RX buffer or Isc Api's proxy has reached low water mark.
|
|
271 |
// Sets the local FlowCtrlDcs2Dp flow OFF and sends flow
|
|
272 |
// change to DCS, if needed. Notify flow control users
|
|
273 |
// (flow control observers).
|
|
274 |
// -----------------------------------------------------------------------------
|
|
275 |
//
|
|
276 |
void CDpFlowCtrl::WaterMarkLowReached()
|
|
277 |
{
|
|
278 |
OstTrace0( TRACE_NORMAL, CDPFLOWCTRL_WATERMARKLOWREACHED, "CDpFlowCtrl::WaterMarkLowReached" );
|
|
279 |
OstTrace1( TRACE_NORMAL, DUP1_CDPFLOWCTRL_WATERMARKLOWREACHED, "CDpFlowCtrl:: Port: %u", iDataPort.PortUnit() );
|
|
280 |
OstTrace0( TRACE_NORMAL, DUP2_CDPFLOWCTRL_WATERMARKLOWREACHED, "CDpFlowCtrl:: LOW WATER MARK" );
|
|
281 |
|
|
282 |
LOGM1(" CDpFlowCtrl::WaterMarkLowReached - Port %d",
|
|
283 |
iDataPort.PortUnit() );
|
|
284 |
LOG(" CDpFlowCtrl - LOW WATER MARK");
|
|
285 |
|
|
286 |
// flow control is set OFF, i.e. data is being transmitted
|
|
287 |
iFlowCtrlDcs2Dp = EFlowControlOff;
|
|
288 |
// inform flow control users
|
|
289 |
Notify();
|
|
290 |
}
|
|
291 |
|
|
292 |
// -----------------------------------------------------------------------------
|
|
293 |
// CDpFlowCtrl::WaterMarkHighReached
|
|
294 |
// RX buffer or Isc Api's proxy has reached high water mark.
|
|
295 |
// Sets the local RX flow ON. Sends flow change to DCS if needed.
|
|
296 |
// Notify flow control users (flow control observers).
|
|
297 |
// -----------------------------------------------------------------------------
|
|
298 |
//
|
|
299 |
void CDpFlowCtrl::WaterMarkHighReached()
|
|
300 |
{
|
|
301 |
OstTrace0( TRACE_NORMAL, CDPFLOWCTRL_WATERMARKHIGHREACHED, "CDpFlowCtrl::WaterMarkHighReached" );
|
|
302 |
OstTrace1( TRACE_NORMAL, DUP1_CDPFLOWCTRL_WATERMARKHIGHREACHED, "CDpFlowCtrl:: Port: %u", iDataPort.PortUnit() );
|
|
303 |
OstTrace0( TRACE_NORMAL, DUP2_CDPFLOWCTRL_WATERMARKHIGHREACHED, "CDpFlowCtrl:: HIGH WATER MARK" );
|
|
304 |
|
|
305 |
LOGM1(" CDpFlowCtrl::WaterMarkHighReachedL - Port %d",
|
|
306 |
iDataPort.PortUnit() );
|
|
307 |
LOG(" CDpFlowCtrl - HIGH WATER MARK");
|
|
308 |
|
|
309 |
// flow control is set ON, ie data is inhibited
|
|
310 |
iFlowCtrlDcs2Dp = EFlowControlOn;
|
|
311 |
// inform flow control users
|
|
312 |
Notify();
|
|
313 |
}
|
|
314 |
|
|
315 |
// -----------------------------------------------------------------------------
|
|
316 |
// CDpFlowCtrl::NotifyClientDatapotReadyforDteFlow
|
|
317 |
// Notifies client about flow control change when starting DataPort.
|
|
318 |
// -----------------------------------------------------------------------------
|
|
319 |
//
|
|
320 |
void CDpFlowCtrl::NotifyClientDatapotReadyforDteFlow()
|
|
321 |
{
|
|
322 |
OstTrace0( TRACE_NORMAL, CDPFLOWCTRL_NOTIFYCLIENTDATAPOTREADYFORDTEFLOW, "CDpFlowCtrl::NotifyClientDatapotReadyforDteFlow" );
|
|
323 |
LOGM(" CDpFlowCtrl::NotifyClientDatapotReadyforDteFlow");
|
|
324 |
|
|
325 |
if ( ( !iIsDataportReadyforDteFlow ) && iFlowCtrlDp2Dcs )
|
|
326 |
{
|
|
327 |
InformFlowControlToClient();
|
|
328 |
}
|
|
329 |
// no else
|
|
330 |
}
|
|
331 |
|
|
332 |
// -----------------------------------------------------------------------------
|
|
333 |
// CDpFlowCtrl::InformFlowControlToClient
|
|
334 |
// Informs client about the flow control change.
|
|
335 |
// -----------------------------------------------------------------------------
|
|
336 |
//
|
|
337 |
void CDpFlowCtrl::InformFlowControlToClient()
|
|
338 |
{
|
|
339 |
OstTrace0( TRACE_NORMAL, CDPFLOWCTRL_INFORMFLOWCONTROLTOCLIENT, "CDpFlowCtrl::InformFlowControlToClient" );
|
|
340 |
LOGM(" CDpFlowCtrl::InformFlowControlToClient");
|
|
341 |
|
|
342 |
if ( EFlowControlOn == iFlowCtrlDp2Dcs )
|
|
343 |
{
|
|
344 |
LOG(" CDpFlowCtrl::InformFlowControlToClient, EFlowControlOn (completed)");
|
|
345 |
OstTrace0( TRACE_NORMAL, DUP1_CDPFLOWCTRL_INFORMFLOWCONTROLTOCLIENT, "CDpFlowCtrl:: EFlowControlOn (completed)" );
|
|
346 |
}
|
|
347 |
else
|
|
348 |
{
|
|
349 |
LOG(" CDpFlowCtrl::InformFlowControlToClient, EFlowControlOff (completed)");
|
|
350 |
OstTrace0( TRACE_NORMAL, DUP2_CDPFLOWCTRL_INFORMFLOWCONTROLTOCLIENT, "CDpFlowCtrl:: EFlowControlOff (completed)" );
|
|
351 |
}
|
|
352 |
|
|
353 |
iDataPort.FlowControlChangeCompleted( iFlowCtrlDp2Dcs, KErrNone );
|
|
354 |
iLastFlowControlSentToClient = iFlowCtrlDp2Dcs;
|
|
355 |
|
|
356 |
iIsDataportReadyforDteFlow = ETrue;
|
|
357 |
}
|
|
358 |
|
|
359 |
// -----------------------------------------------------------------------------
|
|
360 |
// CDpFlowCtrl::Attach
|
|
361 |
// Attach observer to CDpSubject.
|
|
362 |
// -----------------------------------------------------------------------------
|
|
363 |
//
|
|
364 |
void CDpFlowCtrl::Attach( CDpObserver& aObserver )
|
|
365 |
{
|
|
366 |
OstTrace0( TRACE_NORMAL, CDPFLOWCTRL_ATTACH, "CDpFlowCtrl::Attach" );
|
|
367 |
iDpSubject.Attach( aObserver );
|
|
368 |
}
|
|
369 |
|
|
370 |
// -----------------------------------------------------------------------------
|
|
371 |
// CDpFlowCtrl::Detach
|
|
372 |
// Detach observer from CDpSubject.
|
|
373 |
// -----------------------------------------------------------------------------
|
|
374 |
//
|
|
375 |
void CDpFlowCtrl::Detach( CDpObserver& aObserver )
|
|
376 |
{
|
|
377 |
OstTrace0( TRACE_NORMAL, CDPFLOWCTRL_DETACH, "CDpFlowCtrl::Detach" );
|
|
378 |
iDpSubject.Detach( aObserver );
|
|
379 |
}
|
|
380 |
|
|
381 |
// -----------------------------------------------------------------------------
|
|
382 |
// CDpFlowCtrl::Notify
|
|
383 |
// Notify all observers of CDpSubject object.
|
|
384 |
// -----------------------------------------------------------------------------
|
|
385 |
//
|
|
386 |
void CDpFlowCtrl::Notify()
|
|
387 |
{
|
|
388 |
OstTrace0( TRACE_NORMAL, CDPFLOWCTRL_NOTIFY, "CDpFlowCtrl::Notify" );
|
|
389 |
iDpSubject.Notify();
|
|
390 |
}
|
|
391 |
|
|
392 |
// ========================== OTHER EXPORTED FUNCTIONS =========================
|
|
393 |
// none
|
|
394 |
|
|
395 |
// End of File
|