williamr@4: /*
williamr@4: * Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies). 
williamr@4: * All rights reserved.
williamr@4: * This component and the accompanying materials are made available
williamr@4: * under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@4: * which accompanies this distribution, and is available
williamr@4: * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@4: *
williamr@4: * Initial Contributors:
williamr@4: * Nokia Corporation - initial contribution.
williamr@4: *
williamr@4: * Contributors:
williamr@4: *
williamr@4: * Description:
williamr@4: *
williamr@4: */
williamr@4: 
williamr@4: /**
williamr@4: @file
williamr@4: @internalComponent
williamr@4: 
williamr@4: The interface of the serial driver stuff for users of the serial
williamr@4: driver library - not users of the class itself.
williamr@4: 
williamr@4: */
williamr@4: 
williamr@4: #ifndef __SERIAL_DRIVER_EXT_H
williamr@4: #define __SERIAL_DRIVER_EXT_H
williamr@4: 
williamr@4: #include <d32comm.h>   // gives us 'TCommConfig'
williamr@4: 
williamr@4: typedef TAny * SerialServer;
williamr@4: typedef TAny * SerialPort;
williamr@4: 
williamr@4: // The external interface to users of the library,
williamr@4: 			  		  
williamr@4: IMPORT_C SerialServer OpenSerialServerL(void);
williamr@4: 
williamr@4: IMPORT_C void CloseSerialServer(SerialServer aServer);
williamr@4: 
williamr@4: IMPORT_C SerialPort OpenSerialPortL(SerialServer aServer, TUint aPort);
williamr@4: 
williamr@4: IMPORT_C TBool CloseSerialPort(SerialPort aPort);
williamr@4: 
williamr@4: IMPORT_C TBool Read(SerialPort aPort,
williamr@4: 			  		TRequestStatus & aStatus, 
williamr@4: 			  		TTimeIntervalMicroSeconds32 aTimeout,
williamr@4: 			  		TDes8 &aDes,
williamr@4: 			  		TInt aLength);
williamr@4: 
williamr@4: IMPORT_C TBool Write(SerialPort aPort,
williamr@4: 					 TRequestStatus & aStatus,
williamr@4: 				     TTimeIntervalMicroSeconds32 aTimeout,
williamr@4: 				     const TDesC8 &aDes,
williamr@4: 				     TInt aLength);
williamr@4: 				     
williamr@4: IMPORT_C TInt SetConfig(SerialPort aPort, const TCommConfig & aRequiredConfig);
williamr@4: 
williamr@4: IMPORT_C TBool GetPortConfig (SerialPort aPort, TCommConfig & config);
williamr@4: 
williamr@4: IMPORT_C TBool ReadCancel(SerialPort aPort);
williamr@4: 
williamr@4: IMPORT_C TBool WriteCancel(SerialPort aPort);
williamr@4: 
williamr@4: IMPORT_C TBool SetReceiveBufferLength(SerialPort aPort, TInt aSize);
williamr@4: 
williamr@4: IMPORT_C TBool ReceiveBufferLength(SerialPort aPort, TInt & aSize);
williamr@4: 
williamr@4: // typedef equivalents
williamr@4: 
williamr@4: 
williamr@4: typedef SerialServer (*TLibOpenSerialServerL)(void);
williamr@4: typedef void (*TLibCloseSerialServer)(SerialServer aServer);
williamr@4: typedef SerialPort (*TLibOpenSerialPortL)(SerialServer aServer, TUint aPort);
williamr@4: typedef TBool (*TLibCloseSerialPort)(SerialPort aPort);
williamr@4: typedef TBool (*TLibRead)(SerialPort aPort,
williamr@4: 			  		  TRequestStatus & aStatus, 
williamr@4: 			  		  TTimeIntervalMicroSeconds32 aTimeout,
williamr@4: 			  		  TDes8 &aDes,
williamr@4: 			  		  TInt aLength);
williamr@4: typedef TBool (*TLibWrite)(SerialPort aPort,
williamr@4: 					   TRequestStatus & aStatus,
williamr@4: 				       TTimeIntervalMicroSeconds32 aTimeout,
williamr@4: 				       const TDesC8 &aDes,
williamr@4: 				       TInt aLength);
williamr@4: typedef TInt (*TLibSetConfig)(SerialPort aPort, const TCommConfig & aRequiredConfig );
williamr@4: 
williamr@4: typedef TBool (*TLibReadCancel)(SerialPort aPort);
williamr@4: 
williamr@4: typedef TBool (*TLibWriteCancel)(SerialPort aPort);
williamr@4: 
williamr@4: typedef TBool (*TLibSetReceiveBufferLength)(SerialPort aPort, TInt aSize);
williamr@4: 
williamr@4: typedef TBool (*TLibReceiveBufferLength)(SerialPort aPort, TInt & aSize);
williamr@4: 
williamr@4: 
williamr@4: #endif