Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/driver1__pdd_8cpp_source.html
Week 32 contribution of PDK documentation content. See release notes for details. Fixes bug Bug 3582
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>TB9.2 Example Applications: examples/Base/IPC/AdvancedClientServerExample/driver/driver1_pdd.cpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2 -->
<h1>examples/Base/IPC/AdvancedClientServerExample/driver/driver1_pdd.cpp</h1><a href="driver1__pdd_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).</span>
<a name="l00002"></a>00002 <span class="comment">// All rights reserved.</span>
<a name="l00003"></a>00003 <span class="comment">// This component and the accompanying materials are made available</span>
<a name="l00004"></a>00004 <span class="comment">// under the terms of "Eclipse Public License v1.0"</span>
<a name="l00005"></a>00005 <span class="comment">// which accompanies this distribution, and is available</span>
<a name="l00006"></a>00006 <span class="comment">// at the URL "http://www.eclipse.org/legal/epl-v10.html".</span>
<a name="l00007"></a>00007 <span class="comment">//</span>
<a name="l00008"></a>00008 <span class="comment">// Initial Contributors:</span>
<a name="l00009"></a>00009 <span class="comment">// Nokia Corporation - initial contribution.</span>
<a name="l00010"></a>00010 <span class="comment">//</span>
<a name="l00011"></a>00011 <span class="comment">// Contributors:</span>
<a name="l00012"></a>00012 <span class="comment">//</span>
<a name="l00013"></a>00013 <span class="comment">// Description:</span>
<a name="l00014"></a>00014 <span class="comment">// Example Physical Device Driver</span>
<a name="l00015"></a>00015 <span class="comment">//</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017
<a name="l00018"></a>00018
<a name="l00023"></a>00023 <span class="preprocessor">#include <kern_priv.h></span>
<a name="l00024"></a>00024 <span class="preprocessor">#include "<a class="code" href="driver1_8h.html">driver1.h</a>"</span>
<a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="driver1__dev_8h.html">driver1_dev.h</a>"</span>
<a name="l00026"></a>00026
<a name="l00030"></a>00030 <span class="keyword">class </span>DDevice1PddFactory : <span class="keyword">public</span> DPhysicalDevice
<a name="l00031"></a>00031 {
<a name="l00032"></a>00032 <span class="keyword">public</span>:
<a name="l00033"></a>00033 DDevice1PddFactory();
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="comment">// Inherited from DPhysicalDevice</span>
<a name="l00036"></a>00036 <span class="keyword">virtual</span> TInt Install();
<a name="l00037"></a>00037 <span class="keyword">virtual</span> <span class="keywordtype">void</span> GetCaps(TDes8& aDes) <span class="keyword">const</span>;
<a name="l00038"></a>00038 <span class="keyword">virtual</span> TInt Create(DBase*& aChannel, TInt aUnit, <span class="keyword">const</span> TDesC8* aInfo, <span class="keyword">const</span> TVersion& aVer);
<a name="l00039"></a>00039 <span class="keyword">virtual</span> TInt Validate(TInt aUnit, <span class="keyword">const</span> TDesC8* aInfo, <span class="keyword">const</span> TVersion& aVer);
<a name="l00040"></a>00040 <span class="keyword">public</span>:
<a name="l00041"></a>00041 TInt iHardwareInUse;
<a name="l00042"></a>00042 <span class="keyword">private</span>:
<a name="l00046"></a>00046 <span class="keyword">enum</span> TMinimumLDDVersion
<a name="l00047"></a>00047 {
<a name="l00048"></a>00048 EMinimumLddMajorVersion=1,
<a name="l00049"></a>00049 EMinimumLddMinorVersion=0,
<a name="l00050"></a>00050 EMinimumLddBuild=0 <span class="comment">//Not used</span>
<a name="l00051"></a>00051 };
<a name="l00052"></a>00052 };
<a name="l00053"></a>00053
<a name="l00054"></a>00054 <span class="comment">// Name for PDD, must match LDD name with a '.' and distinguishing name appended</span>
<a name="l00055"></a>00055 <a class="code" href="secureclientandserver_8h.html#a5eadd4429627d82193b37536d4faa03a">_LIT</a>(KDriver1PddName,<span class="stringliteral">"DRIVER1.template"</span>);
<a name="l00056"></a>00056
<a name="l00060"></a>00060 <span class="keyword">class </span>DDriver1Device : <span class="keyword">public</span> <a class="code" href="class_d_driver1.html">DDriver1</a>
<a name="l00061"></a>00061 {
<a name="l00062"></a>00062 <span class="keyword">public</span>:
<a name="l00063"></a>00063 DDriver1Device(DDevice1PddFactory* aFactory);
<a name="l00064"></a>00064 ~DDriver1Device();
<a name="l00065"></a>00065 TInt DoCreate();
<a name="l00066"></a>00066
<a name="l00067"></a>00067 <span class="comment">// Inherited from DDriver1. These functions are called by the LDD.</span>
<a name="l00068"></a>00068 <span class="keyword">virtual</span> TInt BufferSize() <span class="keyword">const</span>;
<a name="l00069"></a>00069 <span class="keyword">virtual</span> TInt Speed() <span class="keyword">const</span>;
<a name="l00070"></a>00070 <span class="keyword">virtual</span> TInt SetSpeed(TInt aSpeed);
<a name="l00071"></a>00071 <span class="keyword">virtual</span> TInt SendData(<span class="keyword">const</span> TDesC8& aData);
<a name="l00072"></a>00072 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SendDataCancel();
<a name="l00073"></a>00073 <span class="keyword">virtual</span> TInt ReceiveData(TDes8& aBuffer);
<a name="l00074"></a>00074 <span class="keyword">virtual</span> <span class="keywordtype">void</span> ReceiveDataCancel();
<a name="l00075"></a>00075 <span class="keyword">private</span>:
<a name="l00076"></a>00076 <span class="keyword">static</span> <span class="keywordtype">void</span> SendDataTimerCallback(TAny* aPtr);
<a name="l00077"></a>00077 <span class="keywordtype">void</span> SendDataCallback();
<a name="l00078"></a>00078 <span class="keyword">static</span> <span class="keywordtype">void</span> ReceiveDataTimerCallback(TAny* aPtr);
<a name="l00079"></a>00079 <span class="keywordtype">void</span> ReceiveDataCallback();
<a name="l00080"></a>00080 <span class="keyword">private</span>:
<a name="l00081"></a>00081 DDevice1PddFactory* iFactory;
<a name="l00082"></a>00082 TInt iSpeed;
<a name="l00083"></a>00083 NTimer iSendDataTimer;
<a name="l00084"></a>00084 NTimer iReceiveDataTimer;
<a name="l00085"></a>00085 TBuf8<256> iBuffer;
<a name="l00086"></a>00086 TDes8* iReceiveBuffer;
<a name="l00087"></a>00087 };
<a name="l00088"></a>00088 <span class="comment">//</span>
<a name="l00089"></a>00089 <span class="comment">// DDevice1PddFactory</span>
<a name="l00090"></a>00090 <span class="comment">//</span>
<a name="l00091"></a>00091
<a name="l00096"></a><a class="code" href="driver1__pdd_8cpp.html#a061eed382be7e15a773e024537b23677">00096</a> <a class="code" href="driver1__pdd_8cpp.html#a061eed382be7e15a773e024537b23677">DECLARE_STANDARD_PDD</a>()
<a name="l00097"></a>00097 {
<a name="l00098"></a>00098 <span class="keywordflow">return</span> <span class="keyword">new</span> DDevice1PddFactory;
<a name="l00099"></a>00099 }
<a name="l00100"></a>00100
<a name="l00101"></a>00101 DDevice1PddFactory::DDevice1PddFactory()
<a name="l00102"></a>00102 {
<a name="l00103"></a>00103 <span class="comment">// Sets version number for this device</span>
<a name="l00104"></a>00104 iVersion=<a class="code" href="class_r_driver1.html#a7d1f08b59801b5890fb77666e14d5e8f">RDriver1::VersionRequired</a>();
<a name="l00105"></a>00105 }
<a name="l00106"></a>00106
<a name="l00112"></a>00112 TInt DDevice1PddFactory::Install()
<a name="l00113"></a>00113 {
<a name="l00114"></a>00114 <span class="keywordflow">return</span> SetName(&KDriver1PddName);
<a name="l00115"></a>00115 }
<a name="l00116"></a>00116
<a name="l00122"></a>00122 <span class="keywordtype">void</span> DDevice1PddFactory::GetCaps(TDes8& aDes)<span class="keyword"> const</span>
<a name="l00123"></a>00123 <span class="keyword"> </span>{
<a name="l00124"></a>00124 <span class="comment">// Create a capabilities object</span>
<a name="l00125"></a>00125 <a class="code" href="class_d_driver1_1_1_t_caps.html">DDriver1::TCaps</a> caps;
<a name="l00126"></a>00126 caps.iVersion = iVersion;
<a name="l00127"></a>00127 <span class="comment">// Zero the buffer</span>
<a name="l00128"></a>00128 TInt maxLen = aDes.MaxLength();
<a name="l00129"></a>00129 aDes.FillZ(maxLen);
<a name="l00130"></a>00130 <span class="comment">// Copy capabilities</span>
<a name="l00131"></a>00131 TInt size=<span class="keyword">sizeof</span>(caps);
<a name="l00132"></a>00132 <span class="keywordflow">if</span>(size>maxLen)
<a name="l00133"></a>00133 size=maxLen;
<a name="l00134"></a>00134 aDes.Copy((TUint8*)&caps,size);
<a name="l00135"></a>00135 }
<a name="l00136"></a>00136
<a name="l00148"></a>00148 TInt DDevice1PddFactory::Create(DBase*& aChannel, TInt aUnit, <span class="keyword">const</span> TDesC8* aInfo, <span class="keyword">const</span> TVersion& aVer)
<a name="l00149"></a>00149 {
<a name="l00150"></a>00150 <span class="comment">// Ignore the parameters we aren't interested in...</span>
<a name="l00151"></a>00151 (void)aUnit;
<a name="l00152"></a>00152 (void)aInfo;
<a name="l00153"></a>00153 (void)aVer;
<a name="l00154"></a>00154
<a name="l00155"></a>00155 <span class="comment">// Create a new physical channel</span>
<a name="l00156"></a>00156 DDriver1Device* device=<span class="keyword">new</span> DDriver1Device(<span class="keyword">this</span>);
<a name="l00157"></a>00157 aChannel=device;
<a name="l00158"></a>00158 <span class="keywordflow">if</span> (!device)
<a name="l00159"></a>00159 <span class="keywordflow">return</span> KErrNoMemory;
<a name="l00160"></a>00160 <span class="keywordflow">return</span> device->DoCreate();
<a name="l00161"></a>00161 }
<a name="l00162"></a>00162
<a name="l00173"></a>00173 TInt DDevice1PddFactory::Validate(TInt aUnit, <span class="keyword">const</span> TDesC8* aInfo, <span class="keyword">const</span> TVersion& aVer)
<a name="l00174"></a>00174 {
<a name="l00175"></a>00175 <span class="comment">// Check version numbers</span>
<a name="l00176"></a>00176 <span class="keywordflow">if</span> ((!Kern::QueryVersionSupported(iVersion,aVer)) || (!Kern::QueryVersionSupported(aVer,TVersion(EMinimumLddMajorVersion,EMinimumLddMinorVersion,EMinimumLddBuild))))
<a name="l00177"></a>00177 <span class="keywordflow">return</span> KErrNotSupported;
<a name="l00178"></a>00178
<a name="l00179"></a>00179 <span class="comment">// We don't support units</span>
<a name="l00180"></a>00180 <span class="keywordflow">if</span> (aUnit != -1)
<a name="l00181"></a>00181 <span class="keywordflow">return</span> KErrNotSupported;
<a name="l00182"></a>00182
<a name="l00183"></a>00183 <span class="comment">// Ignore extra info, (this could be used for validation purposes).</span>
<a name="l00184"></a>00184 <span class="comment">// Note, aInfo is a pointer to a descriptor in user memory, therefore safe methods should</span>
<a name="l00185"></a>00185 <span class="comment">// be used for reading its contents e.g. using Kern::KUDesGet()</span>
<a name="l00186"></a>00186 (void)aInfo;
<a name="l00187"></a>00187
<a name="l00188"></a>00188 <span class="comment">// OK</span>
<a name="l00189"></a>00189 <span class="keywordflow">return</span> KErrNone;
<a name="l00190"></a>00190 }
<a name="l00191"></a>00191
<a name="l00195"></a>00195 DDriver1Device::DDriver1Device(DDevice1PddFactory* aFactory)
<a name="l00196"></a>00196 : iFactory(aFactory),
<a name="l00197"></a>00197 iSpeed(100000), <span class="comment">// 100000us (100ms) per byte</span>
<a name="l00198"></a>00198 iSendDataTimer(SendDataTimerCallback,this),
<a name="l00199"></a>00199 iReceiveDataTimer(ReceiveDataTimerCallback,this)
<a name="l00200"></a>00200 {
<a name="l00201"></a>00201 }
<a name="l00202"></a>00202
<a name="l00206"></a>00206 DDriver1Device::~DDriver1Device()
<a name="l00207"></a>00207 {
<a name="l00208"></a>00208 <span class="comment">// Driver no longer using hardware resources</span>
<a name="l00209"></a>00209 NKern::LockedDec(iFactory->iHardwareInUse);
<a name="l00210"></a>00210 }
<a name="l00211"></a>00211
<a name="l00212"></a>00212 TInt DDriver1Device::DoCreate()
<a name="l00213"></a>00213 {
<a name="l00214"></a>00214 <span class="comment">// Claim the hardware resources by incrementing iHardwareInUse.</span>
<a name="l00215"></a>00215 <span class="comment">// Must do this before any other failure can happen in this function so that</span>
<a name="l00216"></a>00216 <span class="comment">// the destructor can safely decrement iHardwareInUse.</span>
<a name="l00217"></a>00217 <span class="comment">//</span>
<a name="l00218"></a>00218 <span class="comment">// This method of ensuring hardware is only in use by one driver at a time</span>
<a name="l00219"></a>00219 <span class="comment">// wouldn't be needed if the driver claimed real hardware resources which</span>
<a name="l00220"></a>00220 <span class="comment">// could only be used once. E.g. binding to an interrupt.</span>
<a name="l00221"></a>00221 <span class="keywordflow">if</span>(NKern::LockedInc(iFactory->iHardwareInUse))
<a name="l00222"></a>00222 <span class="keywordflow">return</span> KErrInUse;
<a name="l00223"></a>00223
<a name="l00224"></a>00224 <span class="comment">// Other setup goes here</span>
<a name="l00225"></a>00225 <span class="keywordflow">return</span> KErrNone;
<a name="l00226"></a>00226 }
<a name="l00230"></a>00230 TInt DDriver1Device::BufferSize()<span class="keyword"> const</span>
<a name="l00231"></a>00231 <span class="keyword"> </span>{
<a name="l00232"></a>00232 <span class="keywordflow">return</span> iBuffer.MaxSize();
<a name="l00233"></a>00233 }
<a name="l00234"></a>00234
<a name="l00238"></a>00238 TInt DDriver1Device::Speed()<span class="keyword"> const</span>
<a name="l00239"></a>00239 <span class="keyword"> </span>{
<a name="l00240"></a>00240 <span class="keywordflow">return</span> iSpeed;
<a name="l00241"></a>00241 }
<a name="l00242"></a>00242
<a name="l00247"></a>00247 TInt DDriver1Device::SetSpeed(TInt aSpeed)
<a name="l00248"></a>00248 {
<a name="l00249"></a>00249 <span class="keywordflow">if</span>(aSpeed<=0)
<a name="l00250"></a>00250 <span class="keywordflow">return</span> KErrArgument;
<a name="l00251"></a>00251 iSpeed = aSpeed;
<a name="l00252"></a>00252 <span class="keywordflow">return</span> KErrNone;
<a name="l00253"></a>00253 }
<a name="l00254"></a>00254
<a name="l00255"></a>00255 <span class="comment">// Methods for processing 'SendData'</span>
<a name="l00256"></a>00256 <span class="comment">//</span>
<a name="l00260"></a>00260 <span class="comment"></span>TInt DDriver1Device::SendData(<span class="keyword">const</span> TDesC8& aData)
<a name="l00261"></a>00261 {
<a name="l00262"></a>00262 <span class="comment">// Save the last part of the data to 'send', we will pretend to 'receive' this later</span>
<a name="l00263"></a>00263 iBuffer=aData.Right(iBuffer.MaxSize());
<a name="l00264"></a>00264 <span class="comment">// Pretend to send the data by waiting for iSpeed micro-seconds per byte...</span>
<a name="l00265"></a>00265 iSendDataTimer.OneShot(aData.Size()*iSpeed/NKern::TickPeriod());
<a name="l00266"></a>00266 <span class="keywordflow">return</span> KErrNone;
<a name="l00267"></a>00267 }
<a name="l00268"></a>00268
<a name="l00272"></a>00272 <span class="keywordtype">void</span> DDriver1Device::SendDataCancel()
<a name="l00273"></a>00273 {
<a name="l00274"></a>00274 <span class="comment">// Stop the timer we were using to pretend we were processing the send.</span>
<a name="l00275"></a>00275 iSendDataTimer.Cancel();
<a name="l00276"></a>00276 }
<a name="l00277"></a>00277
<a name="l00282"></a>00282 <span class="keywordtype">void</span> DDriver1Device::SendDataTimerCallback(TAny* aPtr)
<a name="l00283"></a>00283 {
<a name="l00284"></a>00284 <span class="comment">// Just forward callback to non-static callback function</span>
<a name="l00285"></a>00285 ((DDriver1Device*)aPtr)->SendDataCallback();
<a name="l00286"></a>00286 }
<a name="l00287"></a>00287
<a name="l00291"></a>00291 <span class="keywordtype">void</span> DDriver1Device::SendDataCallback()
<a name="l00292"></a>00292 {
<a name="l00293"></a>00293 <span class="comment">// Tell LDD we've finished</span>
<a name="l00294"></a>00294 iLdd->SendDataComplete(KErrNone);
<a name="l00295"></a>00295 }
<a name="l00296"></a>00296
<a name="l00297"></a>00297 <span class="comment">//</span>
<a name="l00298"></a>00298 <span class="comment">// Methods for processing 'ReceiveData'</span>
<a name="l00299"></a>00299 <span class="comment">//</span>
<a name="l00303"></a>00303 <span class="comment"></span>TInt DDriver1Device::ReceiveData(TDes8& aBuffer)
<a name="l00304"></a>00304 {
<a name="l00305"></a>00305 <span class="comment">// Save a pointer to the buffer we need to put the 'received' data in</span>
<a name="l00306"></a>00306 iReceiveBuffer=&aBuffer;
<a name="l00307"></a>00307 <span class="comment">// Pretend to receive the data by waiting for iSpeed micro-seconds per byte...</span>
<a name="l00308"></a>00308 iReceiveDataTimer.OneShot(iBuffer.Size()*iSpeed/NKern::TickPeriod());
<a name="l00309"></a>00309 <span class="keywordflow">return</span> KErrNone;
<a name="l00310"></a>00310 }
<a name="l00314"></a>00314 <span class="keywordtype">void</span> DDriver1Device::ReceiveDataCancel()
<a name="l00315"></a>00315 {
<a name="l00316"></a>00316 <span class="comment">// Stop the timer we were using to pretend we were processing the receive</span>
<a name="l00317"></a>00317 iReceiveDataTimer.Cancel();
<a name="l00318"></a>00318 }
<a name="l00323"></a>00323 <span class="keywordtype">void</span> DDriver1Device::ReceiveDataTimerCallback(TAny* aPtr)
<a name="l00324"></a>00324 {
<a name="l00325"></a>00325 <span class="comment">// Just forward callback to non-static callback function</span>
<a name="l00326"></a>00326 ((DDriver1Device*)aPtr)->ReceiveDataCallback();
<a name="l00327"></a>00327 }
<a name="l00331"></a>00331 <span class="keywordtype">void</span> DDriver1Device::ReceiveDataCallback()
<a name="l00332"></a>00332 {
<a name="l00333"></a>00333 <span class="comment">// Pretend the data we have received is that saved in iBuffer when we last did a send</span>
<a name="l00334"></a>00334 *iReceiveBuffer=iBuffer;
<a name="l00335"></a>00335 <span class="comment">// Tell LDD we've finished</span>
<a name="l00336"></a>00336 iLdd->ReceiveDataComplete(KErrNone);
<a name="l00337"></a>00337 }
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>