examples/Base/IPC/AdvancedClientServerExample/driver/driver1_dev.h

Go to the documentation of this file.

/*
Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
* Neither the name of Nokia Corporation nor the names of its contributors
  may be used to endorse or promote products derived from this software
  without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Description: Kernel side interfaces to the example Logical and Physical Device Drivers  
*/



#ifndef __DRIVER1_DEV_H__
#define __DRIVER1_DEV_H__

class DDriver1Factory : public DLogicalDevice
        {
public:
        DDriver1Factory();
        ~DDriver1Factory();
        
        //      Inherited from DLogicalDevice
        virtual TInt Install();
        virtual void GetCaps(TDes8& aDes) const;
        virtual TInt Create(DLogicalChannelBase*& aChannel);
        };

class DDriver1;

class DDriver1Channel : public DLogicalChannel
        {
public:
        DDriver1Channel();
        virtual ~DDriver1Channel();
        
        //      Inherited from DObject
        virtual TInt RequestUserHandle(DThread* aThread, TOwnerType aType);
        
        // Inherited from DLogicalChannelBase
        virtual TInt DoCreate(TInt aUnit, const TDesC8* anInfo, const TVersion& aVer);
        
        // Inherited from DLogicalChannel
        virtual void HandleMsg(TMessageBase* aMsg);
private:
        // Panic reasons
        enum TPanic
                {
                // A request was issued when one is outstanding.
                ERequestAlreadyPending = 1
                };
                
        // Implementation of the different kinds of messages sent through RBusLogicalChannel
        TInt DoControl(TInt aFunction, TAny* a1, TAny* a2);
        TInt DoRequest(TInt aReqNo, TRequestStatus* aStatus, TAny* a1, TAny* a2);
        void DoCancel(TUint aMask);
        // Accessor for the PDD
        inline DDriver1* Pdd();
        // Methods for configuration
        TInt GetConfig(TDes8* aConfigBuf);
        TInt SetConfig(const TDesC8* aConfigBuf);
        void CurrentConfig(RDriver1::TConfig& aConfig);
        // Methods for processing a SendData request
        TInt SendData(TRequestStatus* aStatus,const TDesC8* aData);
        void SendDataCancel();
        void DoSendDataComplete();
        static void SendDataDfc(TAny* aPtr);
        // Methods for processing a ReceiveData request
        TInt ReceiveData(TRequestStatus* aStatus,TDes8* aBuffer);
        void ReceiveDataCancel();
        void DoReceiveDataComplete();
        static void ReceiveDataDfc(TAny* aPtr);
public:
        // Interface methods for use by PDD
        virtual void SendDataComplete(TInt aResult);
        virtual void ReceiveDataComplete(TInt aResult);
private:
        DThread* iClient;
        // Members used for processing a SendData request
        TRequestStatus* iSendDataStatus;
        TDfc iSendDataDfc;
        TInt iSendDataResult;
        TBuf8<256> iSendDataBuffer;
        // Members used for processing a ReceiveData request
        TDes8* iReceiveDataDescriptor;
        TRequestStatus* iReceiveDataStatus;
        TDfc iReceiveDataDfc;
        TInt iReceiveDataResult;
        TBuf8<256> iReceiveDataBuffer;
        };

inline DDriver1* DDriver1Channel::Pdd()
        { return (DDriver1*)iPdd; }

class DDriver1 : public DBase
        {
public:
        class TCaps
                {
        public:
                TVersion iVersion;
                };
public:
        virtual TInt BufferSize() const =0;
        virtual TInt Speed() const =0;
        virtual TInt SetSpeed(TInt aSpeed) =0;
        virtual TInt SendData(const TDesC8& aData) =0;
        virtual void SendDataCancel() =0;
        virtual TInt ReceiveData(TDes8& aBuffer) =0;
        virtual void ReceiveDataCancel() =0;
public:
        DDriver1Channel* iLdd;
        };

#endif

---