sl@0: // Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of the License "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // This file defines the interface provided by the driver to the user. 
sl@0: // It will be included both in the application (user) and the driver (kernel). 
sl@0: // This file typically defines the RBusLogicalChannel derived class that will 
sl@0: // inturn provide the driver API to the user application.
sl@0: // ifndef __EXINT_H__ will resolve the multiple inclusion of this header 
sl@0: // file in different source files. If the file is already included, then the 
sl@0: // following switch will not re-include the file.
sl@0: // 
sl@0: //
sl@0: 
sl@0: #ifndef __EXINT_H__
sl@0: #define __EXINT_H__
sl@0: 
sl@0: // include files
sl@0: // 
sl@0: // e32ver.h (for KE32BuildVersionNumber), e32cmn.h and e32std.h are already
sl@0: // included in d32comm.h and hence not repeating here.
sl@0: //
sl@0: #include <d32comm.h>
sl@0: 
sl@0: // Literal string descriptor constants for driver name. These descriptors 
sl@0: // are used by the driver to associate a name for registering to the 
sl@0: // Symbian OS. LDD will have a name to associate with.
sl@0: //
sl@0: _LIT(KDriverName, "d_exint");
sl@0: 
sl@0: // Loopback modes
sl@0: const TInt KIntLoopbackDisable=0;
sl@0: const TInt KIntLoopbackEnable=1;
sl@0: 
sl@0: /**
sl@0:  User interface for tutorial driver
sl@0:  
sl@0:  RExDriverChannel class is derived from the RBusLogicalChannel and provides 
sl@0:  the interface for user. User application accesses the driver functionality
sl@0:  using only these API.
sl@0:  */
sl@0: class RExDriverChannel:public RBusLogicalChannel
sl@0: 	{
sl@0: public:
sl@0: 	// TVer is an enumeration for the version related information. Driver will 
sl@0: 	// need to set and validate version related information while installing.
sl@0: 	// Version numbers are validated to check if this version of driver as 
sl@0: 	// expected by the client/user application
sl@0: 	//
sl@0: 	enum TVer
sl@0: 		{
sl@0: 		EUartMajorVersionNumber=1,						// Major number for driver
sl@0: 		EUartMinorVersionNumber=0,						// Minor number for device
sl@0: 		EUartBuildVersionNumber=KE32BuildVersionNumber	// Build version number for driver
sl@0: 		};
sl@0: 	// TControl is the enumeration for control and synchronous messages 
sl@0: 	// supported by the driver. User application can request for any of
sl@0: 	// the following control messages to the driver through DoControl() 
sl@0: 	// API provided by the RBusLogicalChannel class.
sl@0: 	//
sl@0: 	enum TControl							// Synchronous control messages used with DoControl()					
sl@0: 		{
sl@0: 		EControlCaps,						// Get the channel capabilities on uart
sl@0: 		EControlSetConfig,					// Configure the device (uart)
sl@0: 		EControlSetIntLoopback				// Configure the device's internal looback mode
sl@0: 		};
sl@0: 	// TRequest is the enumeration for asynchronous requests supported
sl@0: 	// by the driver. User application can request for any of the 
sl@0: 	// following messages to the driver through DoRequest() API provided
sl@0: 	// by the RBusLogicalChannel class.
sl@0: 	//
sl@0: 	enum TRequest							// Asynchronous request messages used with DoRequest()	
sl@0: 		{
sl@0: 		ERequestTransmitData,				// Transmit data over the device (uart)	
sl@0: 		ERequestReceiveData,				// Receive the data from the device (uart)
sl@0: 		ENumRequests,
sl@0: 		EAllRequests = (1<<ENumRequests)-1
sl@0: 		};	
sl@0: public:
sl@0: 	// VersionRequired() will provide the version of the driver. This is made inline
sl@0: 	// function to initialize the TVersion object with driver's Major,Minor and Build
sl@0: 	// version numbers. This is later used to validate the driver version.
sl@0: 	//
sl@0: 	inline static TVersion VersionRequired();		
sl@0: 	
sl@0: 	// This header file is included both in user application and driver (in kernel mode).
sl@0: 	// The following API are provided only in user space and are not required in kernel mode.
sl@0: 	// Therefore, they are defined under __KERNEL_MODE__ conditional compilation switch.
sl@0: 	// These functions are wrappers to the RBusLogicalChannel API and are inline.
sl@0: 	//
sl@0: 	inline TInt Open(TInt aUnit);					// Open the channel to the driver
sl@0: 	inline TInt Caps(TDes8& aCaps);					// Get the channel capabilities
sl@0: 	inline TInt SetIntLoopback(const TInt aMode);	// Configure the device's internal loopback
sl@0: 	inline TInt SetConfig(const TDesC8& aConfig);	// Configure device (UART)	
sl@0: 	inline TInt TransmitData(TRequestStatus& aStatus, const TDesC8& aData);		// Send data on device (UART)	
sl@0: 	inline TInt ReceiveData(TRequestStatus& aStatus, TDes8& aData);				// Receive data on device (UART)	
sl@0: 	inline void CancelTransmit();			// Cancel pending asynchronous Tx requests
sl@0: 	inline void CancelReceive();			// Cancel pending asynchronous Rx requests
sl@0: 	};
sl@0: 
sl@0: // All inline functions implementation is provided in a seperate inline file. This file
sl@0: // is included here to add the inline implementations. Note:these inline functions 
sl@0: // implementaion is also available only in user space.
sl@0: // 
sl@0: #include "exint.inl"
sl@0: 
sl@0: #endif  // __EXINT_H__
sl@0: 
sl@0: //
sl@0: // End of exint.h