|
297
|
1 |
// Copyright (c) 2009-2010 Nokia Corporation and/or its subsidiary(-ies).
|
|
0
|
2 |
// All rights reserved.
|
|
|
3 |
// This component and the accompanying materials are made available
|
|
|
4 |
// under the terms of the License "Eclipse Public License v1.0"
|
|
|
5 |
// which accompanies this distribution, and is available
|
|
|
6 |
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
|
7 |
//
|
|
|
8 |
// Initial Contributors:
|
|
|
9 |
// Nokia Corporation - initial contribution.
|
|
|
10 |
//
|
|
|
11 |
// Contributors:
|
|
|
12 |
//
|
|
|
13 |
// Description:
|
|
|
14 |
// Class implementation of the drive publishing classes -
|
|
|
15 |
// RDriveMediaErrorPublisher,
|
|
|
16 |
// RDriveStateChangedPublisher,
|
|
|
17 |
// CDriveTransferPublisher,
|
|
|
18 |
// CDriveWriteTransferPublisher,
|
|
|
19 |
// CDriveReadTransferPublisher,
|
|
|
20 |
// CUsbTransferPublisher,
|
|
|
21 |
// CUsbReadTransferPublisher,
|
|
|
22 |
// CUsbReadTransferPublisher.
|
|
297
|
23 |
//
|
|
0
|
24 |
//
|
|
|
25 |
|
|
|
26 |
|
|
|
27 |
|
|
|
28 |
/**
|
|
|
29 |
@file
|
|
|
30 |
@internalTechnology
|
|
|
31 |
*/
|
|
|
32 |
|
|
|
33 |
#include <e32std.h>
|
|
|
34 |
#include <e32base.h>
|
|
|
35 |
#include <e32property.h>
|
|
|
36 |
#include <f32file.h>
|
|
|
37 |
|
|
|
38 |
#include "mstypes.h"
|
|
|
39 |
#include "msctypes.h"
|
|
|
40 |
#include "usbmsshared.h"
|
|
|
41 |
|
|
|
42 |
#include "drivepublisher.h"
|
|
|
43 |
#include "drivemanager.h"
|
|
|
44 |
#include "debug.h"
|
|
|
45 |
|
|
|
46 |
//
|
|
|
47 |
// Use Lookup table to translate from the internal pair of state variables
|
|
|
48 |
// to the externally published drive state code.
|
|
|
49 |
//
|
|
297
|
50 |
LOCAL_D const TUint8 table[][5] =
|
|
0
|
51 |
{
|
|
|
52 |
//TMountState=EDisconnected
|
|
297
|
53 |
{EUsbMsDriveState_Disconnected,
|
|
|
54 |
EUsbMsDriveState_Disconnected,
|
|
|
55 |
EUsbMsDriveState_Disconnected,
|
|
|
56 |
EUsbMsDriveState_Disconnected,
|
|
|
57 |
EUsbMsDriveState_Disconnected},
|
|
0
|
58 |
//TMountState=EConnecting
|
|
297
|
59 |
{EUsbMsDriveState_Connecting,
|
|
|
60 |
EUsbMsDriveState_Connecting,
|
|
|
61 |
EUsbMsDriveState_Connecting,
|
|
|
62 |
EUsbMsDriveState_Connecting,
|
|
|
63 |
EUsbMsDriveState_Connecting},
|
|
0
|
64 |
//TMountState=EConnected
|
|
297
|
65 |
//EIdle,EActive,ELocked,EMediaNotPresent,EErrDisMounted
|
|
|
66 |
{EUsbMsDriveState_Connected,
|
|
|
67 |
EUsbMsDriveState_Active,
|
|
|
68 |
EUsbMsDriveState_Locked,
|
|
|
69 |
EUsbMsDriveState_MediaNotPresent,
|
|
|
70 |
EUsbMsDriveState_Removed},
|
|
0
|
71 |
//TMountState=EDisconnecting
|
|
297
|
72 |
{EUsbMsDriveState_Disconnecting,
|
|
|
73 |
EUsbMsDriveState_Disconnecting,
|
|
|
74 |
EUsbMsDriveState_Disconnecting,
|
|
|
75 |
EUsbMsDriveState_Disconnecting,
|
|
|
76 |
EUsbMsDriveState_Disconnecting}
|
|
0
|
77 |
};
|
|
|
78 |
|
|
|
79 |
|
|
|
80 |
//----------------------------------------------------------------------------
|
|
|
81 |
/**
|
|
|
82 |
Constructor
|
|
|
83 |
*/
|
|
|
84 |
RDriveMediaErrorPublisher::RDriveMediaErrorPublisher()
|
|
297
|
85 |
{
|
|
|
86 |
_LIT_SECURITY_POLICY_PASS(KMassStorageReadPolicy);
|
|
|
87 |
_LIT_SECURITY_POLICY_S0(KMassStorageWritePolicy, KUsbMsDriveState_Category.iUid);
|
|
0
|
88 |
|
|
297
|
89 |
TInt result = RProperty::Define(EUsbMsDriveState_MediaError, RProperty::EInt,
|
|
|
90 |
KMassStorageReadPolicy, KMassStorageWritePolicy);
|
|
0
|
91 |
|
|
297
|
92 |
__ASSERT_DEBUG(result == KErrAlreadyExists || result == KErrNone, User::Invariant());
|
|
0
|
93 |
|
|
297
|
94 |
result = iMediaErrorProperty.Attach(KUsbMsDriveState_Category, EUsbMsDriveState_MediaError);
|
|
|
95 |
__ASSERT_DEBUG(result == KErrNone, User::Invariant());
|
|
|
96 |
}
|
|
0
|
97 |
|
|
|
98 |
|
|
|
99 |
RDriveMediaErrorPublisher::~RDriveMediaErrorPublisher()
|
|
297
|
100 |
{
|
|
|
101 |
iMediaErrorProperty.Close();
|
|
|
102 |
RProperty::Delete(KUsbMsDriveState_Category, EUsbMsDriveState_MediaError);
|
|
|
103 |
}
|
|
0
|
104 |
|
|
|
105 |
/**
|
|
|
106 |
Publishing method
|
|
|
107 |
|
|
|
108 |
Publishes the Media Error property event
|
|
|
109 |
|
|
|
110 |
@param aError ETrue if drive media has an error else EFalse for no error
|
|
|
111 |
*/
|
|
|
112 |
void RDriveMediaErrorPublisher::PublishErrorL(TBool aError)
|
|
297
|
113 |
{
|
|
|
114 |
__PRINT1(_L("<< RDriveMediaErrorPublisher::PublishError %x"), aError);
|
|
|
115 |
|
|
|
116 |
TInt oldValue;
|
|
|
117 |
iMediaErrorProperty.Get(oldValue);
|
|
0
|
118 |
|
|
297
|
119 |
if (oldValue != aError)
|
|
|
120 |
{
|
|
|
121 |
User::LeaveIfError(iMediaErrorProperty.Set(aError));
|
|
|
122 |
}
|
|
|
123 |
}
|
|
0
|
124 |
|
|
|
125 |
//----------------------------------------------------------------------------
|
|
|
126 |
/**
|
|
|
127 |
Constructor
|
|
|
128 |
|
|
|
129 |
@param aDrives
|
|
|
130 |
@param aDriveMap
|
|
|
131 |
*/
|
|
|
132 |
RDriveStateChangedPublisher::RDriveStateChangedPublisher(const TMsDriveList& aDrives,
|
|
297
|
133 |
const TLunToDriveMap& aDriveMap)
|
|
|
134 |
:
|
|
|
135 |
iDrives(aDrives),
|
|
|
136 |
iDriveMap(aDriveMap)
|
|
|
137 |
{
|
|
|
138 |
_LIT_SECURITY_POLICY_PASS(KMassStorageReadPolicy);
|
|
|
139 |
_LIT_SECURITY_POLICY_S0(KMassStorageWritePolicy, KUsbMsDriveState_Category.iUid);
|
|
0
|
140 |
|
|
297
|
141 |
TInt result = RProperty::Define(KUsbMsDriveState_Category,
|
|
|
142 |
EUsbMsDriveState_DriveStatus, RProperty::EByteArray,
|
|
|
143 |
KMassStorageReadPolicy, KMassStorageWritePolicy,
|
|
|
144 |
KUsbMsMaxDrives*2);
|
|
|
145 |
__ASSERT_DEBUG(result == KErrAlreadyExists || result == KErrNone, User::Invariant());
|
|
|
146 |
result = result; // remove urel warning
|
|
|
147 |
}
|
|
0
|
148 |
|
|
|
149 |
|
|
|
150 |
RDriveStateChangedPublisher::~RDriveStateChangedPublisher()
|
|
297
|
151 |
{
|
|
|
152 |
RProperty::Delete(KUsbMsDriveState_Category, EUsbMsDriveState_DriveStatus);
|
|
|
153 |
}
|
|
0
|
154 |
|
|
|
155 |
|
|
|
156 |
/**
|
|
|
157 |
Publishing method
|
|
|
158 |
|
|
|
159 |
Sends a property event on behalf of CMassStorageDrive, with the mountstate and drivestate
|
|
|
160 |
values encoded into one 32-bit word.
|
|
|
161 |
*/
|
|
|
162 |
void RDriveStateChangedPublisher::DriveStateChanged()
|
|
297
|
163 |
{
|
|
|
164 |
TUsbMsDrivesStatus allDrivesStatus;
|
|
0
|
165 |
|
|
297
|
166 |
for(TUint8 i = 0; i < iDrives.Count(); i++)
|
|
|
167 |
{
|
|
|
168 |
allDrivesStatus.Append(iDriveMap[i]);
|
|
0
|
169 |
|
|
297
|
170 |
CMassStorageDrive::TMountState ms = iDrives[i]->MountState();
|
|
|
171 |
TLocalDriveRef::TDriveState ds = iDrives[i]->DriveState();
|
|
|
172 |
TInt driveStatus = EUsbMsDriveState_Error;
|
|
|
173 |
if((TUint8)ds < sizeof(table[0]) && (TUint8)ms < sizeof(table)/sizeof(table[0]))
|
|
|
174 |
{
|
|
|
175 |
driveStatus = table[ms][ds];
|
|
|
176 |
__PRINT3(_L("ms=%d ds=%d %d"), ms, ds, driveStatus);
|
|
|
177 |
}
|
|
|
178 |
allDrivesStatus.Append(driveStatus);
|
|
|
179 |
}
|
|
0
|
180 |
|
|
|
181 |
|
|
297
|
182 |
__PRINT1(_L("Publishing EUsbMsDriveState_DriveStatus for %d drives\n"),
|
|
|
183 |
allDrivesStatus.Length()/2);
|
|
0
|
184 |
|
|
297
|
185 |
if(KErrNone != RProperty::Set(KUsbMsDriveState_Category,
|
|
|
186 |
EUsbMsDriveState_DriveStatus,
|
|
|
187 |
allDrivesStatus))
|
|
|
188 |
{
|
|
|
189 |
__ASSERT_DEBUG(EFalse,User::Invariant());
|
|
|
190 |
}
|
|
|
191 |
}
|
|
0
|
192 |
|
|
|
193 |
|
|
|
194 |
//----------------------------------------------------------------------------
|
|
|
195 |
|
|
|
196 |
/**
|
|
|
197 |
Private default constructor to ensure that NewL is used
|
|
|
198 |
|
|
|
199 |
@param aSubKey
|
|
|
200 |
@param aArray
|
|
|
201 |
*/
|
|
|
202 |
CUsbTransferPublisher::CUsbTransferPublisher(TUsbMsDriveState_Subkey aSubKey,
|
|
|
203 |
const TBytesTransferedList& aArray)
|
|
|
204 |
: iSubKey(aSubKey),
|
|
297
|
205 |
iArray(aArray)
|
|
|
206 |
{
|
|
|
207 |
}
|
|
0
|
208 |
|
|
|
209 |
|
|
|
210 |
void CUsbTransferPublisher::ConstructL()
|
|
297
|
211 |
{
|
|
|
212 |
_LIT_SECURITY_POLICY_PASS(KMassStorageReadPolicy);
|
|
|
213 |
_LIT_SECURITY_POLICY_S0(KMassStorageWritePolicy, KUsbMsDriveState_Category.iUid);
|
|
0
|
214 |
|
|
297
|
215 |
TInt r = RProperty::Define(iSubKey, RProperty::EByteArray,
|
|
|
216 |
KMassStorageReadPolicy, KMassStorageWritePolicy,
|
|
|
217 |
KUsbMsMaxDrives*sizeof(TInt));
|
|
0
|
218 |
|
|
297
|
219 |
if (r != KErrAlreadyExists)
|
|
|
220 |
{
|
|
|
221 |
User::LeaveIfError(r);
|
|
|
222 |
}
|
|
0
|
223 |
|
|
297
|
224 |
// Attach to the properties here. Only do this once, continuously attaching
|
|
|
225 |
// will currently cause a memory leak
|
|
|
226 |
User::LeaveIfError(iProperty.Attach(KUsbMsDriveState_Category, iSubKey));
|
|
0
|
227 |
|
|
297
|
228 |
// Create the EDataTransferred timer
|
|
|
229 |
iTimer = CPeriodic::NewL(CActive::EPriorityStandard);
|
|
|
230 |
iTimerRunning = EFalse;
|
|
|
231 |
}
|
|
0
|
232 |
|
|
|
233 |
|
|
|
234 |
/**
|
|
|
235 |
Destructor
|
|
|
236 |
*/
|
|
|
237 |
CUsbTransferPublisher::~CUsbTransferPublisher()
|
|
297
|
238 |
{
|
|
|
239 |
if(iTimer)
|
|
|
240 |
{
|
|
|
241 |
iTimer->Cancel();
|
|
|
242 |
}
|
|
|
243 |
delete iTimer;
|
|
|
244 |
iProperty.Close();
|
|
0
|
245 |
|
|
297
|
246 |
RProperty::Delete(KUsbMsDriveState_Category, iSubKey);
|
|
|
247 |
}
|
|
0
|
248 |
|
|
|
249 |
|
|
|
250 |
/**
|
|
|
251 |
A static wrapper for the DoPublishDataTransferredEvent member function
|
|
|
252 |
for use as a timer callback function.
|
|
|
253 |
|
|
|
254 |
@param obj 'this' pointer
|
|
|
255 |
@return not used in CPeriodic callback (see TCallback)
|
|
|
256 |
*/
|
|
|
257 |
TInt CUsbTransferPublisher::PublishDataTransferredEvent(TAny* obj)
|
|
297
|
258 |
{
|
|
|
259 |
static_cast<CUsbTransferPublisher*>(obj)->DoPublishDataTransferredEvent();
|
|
|
260 |
return 1;
|
|
|
261 |
}
|
|
0
|
262 |
|
|
|
263 |
|
|
|
264 |
/**
|
|
|
265 |
Update the data transferred properties if the counts have changed since
|
|
|
266 |
the last update.
|
|
|
267 |
*/
|
|
|
268 |
void CUsbTransferPublisher::DoPublishDataTransferredEvent()
|
|
297
|
269 |
{
|
|
|
270 |
if (PublishDataTransferred())
|
|
|
271 |
{
|
|
|
272 |
// some data has been transfered so reset the counter
|
|
|
273 |
iTimerCancelCnt = ETimerCancelDelay;
|
|
|
274 |
}
|
|
0
|
275 |
|
|
297
|
276 |
// Update the cancel count if no data was transferred the last
|
|
|
277 |
// (few) times this has been called
|
|
|
278 |
if (--iTimerCancelCnt == 0)
|
|
|
279 |
{
|
|
|
280 |
StopTimer();
|
|
|
281 |
iTimerCancelCnt = ETimerCancelDelay;
|
|
|
282 |
}
|
|
|
283 |
}
|
|
0
|
284 |
|
|
|
285 |
|
|
|
286 |
/**
|
|
|
287 |
Update the data transferred properties if the counts have changed since
|
|
|
288 |
the last update.
|
|
|
289 |
*/
|
|
|
290 |
TBool CUsbTransferPublisher::PublishDataTransferred()
|
|
297
|
291 |
{
|
|
|
292 |
TUsbMsBytesTransferred bytesTransferred;
|
|
|
293 |
TBool dataTransferred = EFalse;
|
|
|
294 |
|
|
|
295 |
for (TInt i = 0; i < iArray.Count(); i++)
|
|
|
296 |
{
|
|
|
297 |
bytesTransferred[i] = GetBytesTransferred(i);
|
|
|
298 |
}
|
|
0
|
299 |
|
|
297
|
300 |
// Update the properties only if they have changed
|
|
|
301 |
// (or if there's an error reading the old value.)
|
|
|
302 |
// Possible optimisation: keep a copy of the value
|
|
|
303 |
// as a member variable so we don't need the Get.
|
|
|
304 |
TUsbMsBytesTransferred oldValue;
|
|
0
|
305 |
|
|
297
|
306 |
if ((iProperty.Get(oldValue) != KErrNone) || (oldValue != bytesTransferred))
|
|
|
307 |
{
|
|
0
|
308 |
#ifdef __PRINT3
|
|
297
|
309 |
// trace of the bytes transferred
|
|
|
310 |
for (TInt j=0; j < iArray.Count(); j++)
|
|
|
311 |
{
|
|
|
312 |
if(oldValue[j] != bytesTransferred[j])
|
|
|
313 |
{
|
|
|
314 |
__PRINT3(_L("CDrivePublisher: KBytes[%d] %d->%d\n"), j, oldValue[j], bytesTransferred[j]);
|
|
|
315 |
}
|
|
|
316 |
}
|
|
0
|
317 |
#endif
|
|
297
|
318 |
if (KErrNone != iProperty.Set(bytesTransferred))
|
|
|
319 |
{
|
|
|
320 |
__ASSERT_DEBUG(EFalse, User::Invariant());
|
|
|
321 |
}
|
|
|
322 |
dataTransferred = ETrue;
|
|
|
323 |
}
|
|
0
|
324 |
|
|
297
|
325 |
return dataTransferred;
|
|
|
326 |
}
|
|
0
|
327 |
|
|
|
328 |
|
|
|
329 |
/**
|
|
|
330 |
Starts timer to periodically publish results.
|
|
|
331 |
If the timer is not yet running then start it.
|
|
|
332 |
*/
|
|
|
333 |
void CUsbTransferPublisher::StartTimer()
|
|
297
|
334 |
{
|
|
|
335 |
if (!iTimerRunning)
|
|
|
336 |
{
|
|
|
337 |
// EDataTransferred event every second
|
|
|
338 |
const TTimeIntervalMicroSeconds32 interval = 1 * 1000 * 1000;
|
|
|
339 |
TCallBack callback(PublishDataTransferredEvent, this);
|
|
|
340 |
__PRINT(_L("Starting timer"));
|
|
|
341 |
iTimer->Start(interval, interval, callback);
|
|
|
342 |
iTimerRunning = ETrue;
|
|
|
343 |
}
|
|
|
344 |
}
|
|
0
|
345 |
|
|
|
346 |
|
|
|
347 |
/**
|
|
|
348 |
Ensure that the Timer is stopped
|
|
|
349 |
*/
|
|
|
350 |
void CUsbTransferPublisher::StopTimer()
|
|
297
|
351 |
{
|
|
|
352 |
if (iTimerRunning)
|
|
|
353 |
{
|
|
|
354 |
__PRINT(_L("Stopping timer"));
|
|
|
355 |
iTimer->Cancel();
|
|
|
356 |
iTimerRunning = EFalse;
|
|
|
357 |
}
|
|
|
358 |
}
|
|
0
|
359 |
|
|
|
360 |
|
|
|
361 |
//----------------------------------------------------------------------------
|
|
|
362 |
/**
|
|
|
363 |
Constructor for Write property
|
|
|
364 |
|
|
|
365 |
@param aArray
|
|
|
366 |
*/
|
|
|
367 |
CUsbWriteTransferPublisher* CUsbWriteTransferPublisher::NewL(const TBytesTransferedList& aArray)
|
|
297
|
368 |
{
|
|
|
369 |
CUsbWriteTransferPublisher* self = new (ELeave) CUsbWriteTransferPublisher(aArray);
|
|
|
370 |
CleanupStack::PushL(self);
|
|
|
371 |
self->ConstructL();
|
|
|
372 |
CleanupStack::Pop();
|
|
|
373 |
return self;
|
|
|
374 |
}
|
|
0
|
375 |
|
|
|
376 |
|
|
|
377 |
CUsbWriteTransferPublisher::CUsbWriteTransferPublisher(const TBytesTransferedList& aArray)
|
|
|
378 |
: CUsbTransferPublisher(EUsbMsDriveState_KBytesWritten, aArray)
|
|
297
|
379 |
{
|
|
|
380 |
}
|
|
0
|
381 |
|
|
|
382 |
|
|
|
383 |
//----------------------------------------------------------------------------
|
|
|
384 |
/**
|
|
|
385 |
Constructor for Read property
|
|
|
386 |
|
|
|
387 |
@param aArray
|
|
|
388 |
*/
|
|
|
389 |
CUsbReadTransferPublisher* CUsbReadTransferPublisher::NewL(const TBytesTransferedList& aArray)
|
|
297
|
390 |
{
|
|
|
391 |
CUsbReadTransferPublisher* self = new (ELeave) CUsbReadTransferPublisher(aArray);
|
|
|
392 |
CleanupStack::PushL(self);
|
|
|
393 |
self->ConstructL();
|
|
|
394 |
CleanupStack::Pop();
|
|
|
395 |
return self;
|
|
|
396 |
}
|
|
0
|
397 |
|
|
|
398 |
|
|
|
399 |
CUsbReadTransferPublisher::CUsbReadTransferPublisher(const TBytesTransferedList& aArray)
|
|
|
400 |
: CUsbTransferPublisher(EUsbMsDriveState_KBytesRead, aArray)
|
|
297
|
401 |
{
|
|
|
402 |
}
|
|
0
|
403 |
|
|
|
404 |
/**
|
|
|
405 |
Transfer function for the property
|
|
|
406 |
|
|
|
407 |
@return Cumulative bytes read since the host connected to the drive,
|
|
|
408 |
in multiples of KBytesPerKilobyte rounded to nearest integer value.
|
|
|
409 |
The KBytes refer to multiples of 1000, not 1024.
|
|
|
410 |
*/
|
|
|
411 |
TUint CUsbTransferPublisher::GetBytesTransferred(TLun aLun) const
|
|
|
412 |
{
|
|
297
|
413 |
return I64LOW(iArray[aLun] / (TUint64)1000);
|
|
0
|
414 |
}
|