// Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// 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

// which accompanies this distribution, and is available

// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

// BT socket interface types

// 

//

/**

 @file

 @publishedAll

 @released

*/

#ifndef BT_SOCK_H

#define BT_SOCK_H

#include <es_sock.h>

#include <bttypes.h>

#include <d32comm.h>	// for RS232 signal names for RFCOMM

#include <bluetooth/hci/hcierrors.h>

#include <btsecmanclient.h>

#include <bt_subscribe.h>

_LIT(KRFCOMMDesC,"RFCOMM");	/*!< Descriptor name for RFCOMM */

_LIT(KL2CAPDesC,"L2CAP"); 	/*!< Descriptor name for L2CAP */

//

// BT Protocol Family

//

const TUint KBTAddrFamily = 0x101; 		/*!< BT Address Family */

const TUint KBTLinkManager = 0x0099; 	/*!< Protocol Number for Link Manager */

const TUint KL2CAP = 0x0100;			/*!< Protocol Number for L2CAP */

const TUint KRFCOMM = 0x0003;			/*!< Protocol Number for RFCOMM */

const TUint KSDP = 0x0001;				/*!< Protocol Number for SDP */

const TUint	KAVCTP = 0x0017;			/*!< Protocol Number for AVCTP */

const TInt KTCIL2CAP = 0xF100;			/*!< Protocol Number for TCI L2CAP */

const TInt KBTMajor = 0;				/*!< BT version number for major version */

const TInt KBTMinor = 1;				/*!< BT version number for minor version */

const TInt KBTBuild = 1;				/*!< BT version number for build version */

// Socket Options

const TUint	KSolBtBlog  =0x1000;		/*!< Logging socket option */

const TUint KSolBtHCI   =0x1010;		/*!< HCI socket option */

const TUint KSolBtLM    =0x1011;		/*!< Link Manager socket option */

const TUint KSolBtL2CAP =0x1012;		/*!< L2CAP socket option */

const TUint KSolBtRFCOMM=0x1013;		/*!< RFCOMM socket option */

const TUint KSolBtAVCTP	=0x1014;		/*!< AVCTP socket option */

const TUint KSolBtACL	=0x1015;		/*!< ACL socket option */

/**

Decimal Value: 4118.

*/

const TUint	KSolBtAVDTPSignalling	=0x1016;

/**

Decimal Value: 4119.

*/

const TUint	KSolBtAVDTPMedia		=0x1017;

/**

Decimal Value: 4120.

*/

const TUint	KSolBtAVDTPReporting	=0x1018;

/**

Decimal Value: 4121.

*/

const TUint	KSolBtAVDTPRecovery		=0x1019;

/**

Decimal Value: 4128.

*/

const TUint KSolBtAVDTPInternal		=0x1020;

const TUint KSolBtLMProxy = 0x2011;		/*!< Link Manager Proxy socket option */

const TUint KSolBtSAPBase  = 0x2020;	/*!< CBluetoothSAP handles SetOpt first */

const static TUint8 KSCOListenQueSize = 1; /*!< Length of SCO listening queue */

const static TUint16 KL2MinMTU = 48; 			/*!< BT Spec defined min. supported MTU size */

// All PSM values must be ODD, that is, the least significant bit of the least significant

// octet must be '1'. Also, all PSM values must be assigned such that the

// least significant bit of the most significant octet equals '0'.

const static TUint16 KMaxPSM = 0xFEFF;	/*!< Max L2CAP PSM value */

/**

 * This is the minimum user PSM. Smaller PSM values are possible but are reserved for use by the 

 * Bluetooth stack only.

 */

const static TUint16 KMinUserPSM = 0x1001;

/**

 * This constant has been deprecated since its name is misleading becasue it doesn't represent the 

 * absolute minimum PSM but the minimum user PSM instead. 

 * Use KMinUserPSM instead of this constant.

 * @deprecated

 */

const static TUint16 KMinPSM = 0x1001;

/**

An enumeration to represent the possible levels of Man-in-the-Middle protection

that a Bluetooth service may specify.

*/

enum TBluetoothMitmProtection

	{

	EMitmNotRequired	= 0x0, /*!< No Man-in-the-Middle protection is required. */

	EMitmDesired		= 0x1, /*!< Man-in-the-Middle protection should be used where possible. */

	EMitmRequired		= 0x2  /*!< Man-in-the-Middle protection is required. */

	};

NONSHARABLE_CLASS(TBTAccessRequirements)

/** The access requirements set up by a bluetooth service.

An incoming connection must satisfy these criteria before the connection may proceed.

Not spectacularly useful for applications; mainly used by other Bluetooth libraries

@publishedAll

@released

*/

	{

public:

	IMPORT_C TBTAccessRequirements();

	IMPORT_C void SetAuthentication(TBool aPreference);

	IMPORT_C void SetAuthorisation(TBool aPreference);

	IMPORT_C void SetEncryption(TBool aPreference);

	IMPORT_C void SetDenied(TBool aPreference);

	IMPORT_C void SetAuthentication(TBluetoothMitmProtection aPreference);

	IMPORT_C TInt SetPasskeyMinLength(TUint aPasskeyMinLength);	

	IMPORT_C TBool AuthenticationRequired() const;

	IMPORT_C TBool AuthorisationRequired() const;

	IMPORT_C TBool EncryptionRequired() const;

	IMPORT_C TBool Denied() const;

	IMPORT_C TUint PasskeyMinLength() const;

	IMPORT_C TBool operator==(const TBTAccessRequirements& aRequirements) const;

	IMPORT_C TBluetoothMitmProtection MitmProtection() const;

private:

	TUint8 iRequirements;

	TUint  iPasskeyMinLength;

private:

	enum TBTServiceSecuritySettings

		{

		EAuthenticate = 0x01,

		EAuthorise = 0x02,

		EEncrypt = 0x04,

		EDenied = 0x08,

		EMitm = 0x30, // 2 bit field for MITM

		};

	enum TBTAccessRequirementsMitmProtection

		{

		EAccessRequirementsMitmUndefined = 0x00,

		EAccessRequirementsMitmNotRequired = 0x10,

		EAccessRequirementsMitmDesired = 0x20,

		EAccessRequirementsMitmRequired = 0x30

		};

	};

NONSHARABLE_CLASS(TBTServiceSecurity)

/** The security settings of a bluetooth service.

Contains information regarding the service UID and the access requirements.

@publishedAll

@released

*/

	{

public:

	IMPORT_C TBTServiceSecurity(const TBTServiceSecurity& aService);

	IMPORT_C TBTServiceSecurity();

	IMPORT_C void SetUid(TUid aUid);

	IMPORT_C void SetAuthentication(TBool aPreference);

	IMPORT_C void SetAuthorisation(TBool aPreference);

	IMPORT_C void SetEncryption(TBool aPreference);

	IMPORT_C void SetDenied(TBool aPreference);

	IMPORT_C void SetAuthentication(TBluetoothMitmProtection aPreference);

	IMPORT_C TInt SetPasskeyMinLength(TUint aPasskeyMinLength);	

	IMPORT_C TBool AuthorisationRequired() const;

	IMPORT_C TBool EncryptionRequired() const;

	IMPORT_C TBool AuthenticationRequired() const;

	IMPORT_C TBool Denied() const;

	IMPORT_C TUint PasskeyMinLength() const;

	IMPORT_C TUid Uid() const;

	IMPORT_C TBluetoothMitmProtection MitmProtection() const;

private:

	TUid iUid;	///<The UID of the service.  Will be used by the UI to work out the name of the service when prompting the user.

	TBTAccessRequirements iSecurityRequirements;	///<Whether the service requires authentication, authorisation, encryption or min passkey len.

	};

typedef TPckgBuf<TBTServiceSecurity> TBTServiceSecurityPckg;	/*!< Package definition for securty settings */

NONSHARABLE_CLASS(TBTSockAddr) : public TSockAddr

/** Bluetooth socket address

Stores bluetooth device address, and security - these are common to all Bluetooth addresses

@publishedAll

@released

*/

	{

struct SBTAddrSecurity

	{		

	TBTDevAddr iAddress;

	TBTServiceSecurity iSecurity;

	};

public:

	IMPORT_C TBTSockAddr();

	IMPORT_C TBTSockAddr(const TSockAddr& aAddr);

	IMPORT_C TBTDevAddr BTAddr() const;

	IMPORT_C void SetBTAddr(const TBTDevAddr& aRemote);

	IMPORT_C void SetSecurity(const TBTServiceSecurity& aSecurity);

	IMPORT_C TBTServiceSecurity BTSecurity() const;

	IMPORT_C static TBTSockAddr& Cast(const TSockAddr& aAddr);

protected:

	IMPORT_C TAny* EndBTSockAddrPtr() const;

private:

	SBTAddrSecurity& BTAddrSecStruct() const;

	TPtr8 AddressPtr() const;

	};

const static TInt KErrBtEskError = -6999;	/*!< BT ESK error code */

// Options available for all Bluetooth protocols

/** BT options. */

enum TBTOptions

	{

	/** Override device security */

	KBTRegisterCodService = 0x998,		/*!< Set a CoD Service bit(s) */

	KBTSecurityDeviceOverride = 0x999,

	};

typedef TPckgBuf<TBTServiceSecurityPerDevice> TBTServiceSecurityPerDeviceBuf;	/*!< Package definition for securty settings */

// Link manager error codes.

const static TInt KLinkManagerErrBase = -6450;								/*!< Link manager base error value */

const static TInt KErrInsufficientBasebandResources = KLinkManagerErrBase;	/*!< Insufficient baseband resources error value */

const static TInt KErrProxyWriteNotAvailable = KLinkManagerErrBase-1;		/*!< Proxy write not available error value */

const static TInt KErrReflexiveBluetoothLink = KLinkManagerErrBase-2;		/*!< Reflexive BT link error value */

const static TInt KErrPendingPhysicalLink = KLinkManagerErrBase-3;			/*!< Physical link connection already pending when trying to connect the physical link */

const static TInt KErrRemoteDeviceIndicatedNoBonding = KLinkManagerErrBase-4; /*!< Dedicated bonding attempt failure when the remote device responds with No-Bonding */

//

// L2CAP

//

const static TInt KL2CAPErrBase = -6300;								/*!< Base error value for L2CAP error codes */

const static TInt KErrBadAddress = KL2CAPErrBase;						/*!< L2CAP Bad address error code */

const static TInt KErrSAPUnexpectedEvent = KL2CAPErrBase - 1;			/*!< L2CAP unexpected SAP event error code */

const static TInt KErrBadPacketReceived = KL2CAPErrBase - 2;			/*!< L2CAP bad packet received error code */

const static TInt KErrL2CAPBadResponse = KL2CAPErrBase - 3;				/*!< L2CAP bad response error code */

const static TInt KErrHCIConnectFailed = KL2CAPErrBase - 4;				/*!< L2CAP HCI connection failed error code */

const static TInt KErrHCILinkDisconnection = KL2CAPErrBase - 5;			/*!< L2CAP HCI link disconnection error code */

const static TInt KErrSAPNotConnected = KL2CAPErrBase - 6;				/*!< L2CAP SAP not connected error code */

const static TInt KErrConfigBadParams = KL2CAPErrBase - 7;				/*!< L2CAP bad configuration parameters error code */

const static TInt KErrConfigRejected = KL2CAPErrBase - 8;				/*!< L2CAP configuration rejected error code */

const static TInt KErrConfigUnknownOptions = KL2CAPErrBase - 9;			/*!< L2CAP unknown configuration options error code */

const static TInt KErrL2PeerDisconnected = KL2CAPErrBase - 10;			/*!< L2CAP peer disconnected error code */

const static TInt KErrL2CAPAccessRequestDenied = KL2CAPErrBase - 11;	/*!< L2CAP access request denied error code */

const static TInt KErrL2CAPRequestTimeout = KL2CAPErrBase - 12;			/*!< L2CAP request timeout error code */

const static TInt KErrL2PeerRejectedCommand = KL2CAPErrBase - 13;		/*!< L2CAP peer rejected command error code */

const static TInt KErrHostResNameTooLong = KL2CAPErrBase - 14;			/*!< L2CAP host resolver name too long error code */

const static TInt KErrL2CAPNoMorePSMs = KL2CAPErrBase - 15;				/*!< L2CAP no more PSMs error code */

const static TInt KErrL2CAPMaxTransmitExceeded = KL2CAPErrBase - 16;	/*!< L2CAP in reliable mode: the maximum L2Cap retransmissions have been made and channel will disconnect error code*/

const static TInt KErrL2CAPDataControllerDetached = KL2CAPErrBase - 17;	/*!< L2CAP problems (e.g. no memory) whilst sending data error code*/

const static TInt KErrL2CAPConfigPending = KL2CAPErrBase - 18;			/*!< L2CAP configuration is in progress error code 

																			 @internalComponent*/

const static TInt KErrL2CAPConfigAlreadyInProgress = KL2CAPErrBase - 19;/*!< L2CAP attempt to alter config whilst configuration is in progress error code*/

const static TInt KErrL2CAPNoFreeCID = KL2CAPErrBase - 21;				/*!< L2CAP no more channel IDs available error code*/

// Host Resolver

const static TInt KErrHostResNoMoreResults = KErrEof;  					/*!< Host resolver has no more results error code */

const static TUint KHostResInquiry = 1;			/*!< Host resolver inquiry option */ 

const static TUint KHostResName = 2;			/*!< Host resolver name option. This is mutually exclusive with KHostResEir */ 

const static TUint KHostResIgnoreCache = 16; 	/*!< A way of ignoring the cache */ 

const static TUint KHostResCache = 32; 			/*!< A way to get CoD from cache */

const static TUint KHostResEir = 64; 			/*!< Host resolver Eir option. This is mutually exclusive with KHostResName  */

// L2CAP Ioctls

const static TInt KL2CAPEchoRequestIoctl	= 0;		/*!< Echo Request Ioctl name */

const static TInt KL2CAPIncomingMTUIoctl	= 1;		/*!< Change incoming MTU Ioctl name */

const static TInt KL2CAPOutgoingMTUIoctl    = 2;		/*!< Change outgoing MTU Ioctl name */

const static TInt KL2CAPUpdateChannelConfigIoctl	= 3;/*!< Change conguration parameters Ioctl name */

// Link Manager Ioctls

/** Link manager Ioctl codes.*/

enum TBTLMIoctls

	{

	/** Disconnect ACL Ioctl code

	@deprecated

	*/

	KLMDisconnectACLIoctl,

	/** Set Packet type Ioctl code

	@deprecated

	*/

	KLMSetPacketTypeIoctl,

	/** Wait for SCO notification Ioctl code

	@internalComponent

	*/

	KLMWaitForSCONotificationIoctl,

	/** One-shot baseband notification Ioctl code

	@internalComponent

	*/	

	KLMBasebandEventOneShotNotificationIoctl,

	/** Baseband event notification Ioctl code

	@internalComponent

	*/	

	KLMBasebandEventNotificationIoctl,

	/** Read Failed Contact Counter Ioctl

	@internalComponent

	*/	

	KLMReadFailedContactCounterIoctl,

	/** Read Link Quality Ioctl

	@internalComponent

	*/	

	KLMReadLinkQualityIoctl,

	/** Read RSSI Ioctl

	@internalComponent

	*/	

	KLMReadRssiIoctl,

	/** Read Current Transmit Power Level Ioctl

	@internalComponent

	*/	

	KLMReadCurrentTransmitPowerLevelIoctl,

	};

/** Paging policy for baseband.*/

enum TBasebandPageTimePolicy

    {

	EPagingDontCare,	/*!< Don't care setting */

    EPagingNormal,		/*!< Normal setting */

    EPagingBestEffort,	/*!< Best effort setting */

    EPagingQuick,		/*!< Quick paging setting */

    };

struct TBasebandPolicyParams

/** Baseband policy parameters.*/

	{

	TBasebandPageTimePolicy		iPageTimePolicy;	/*!< Page time policy */

	};

struct TSetBasebandPolicy

/** Set baseband policy.

@deprecated

@see RBTBaseband, TPhysicalLinkQuickConnectionToken

*/

	{

	TBTDevAddr				iDevAddr;	/*!< Device Address */

	TBasebandPolicyParams	iPolicy;	/*!< Policy parameters */

	};

/** Package for SetBasebandPolicy structure

@deprecated

*/

typedef TPckgBuf<TSetBasebandPolicy> TSetBasebandPolicyBuf;	

struct TPhysicalLinkQuickConnectionToken

/** Specifies details for faster connection.*/

	{

	TBTNamelessDevice		iDevice;	/*!< Nameless device */

	TBasebandPolicyParams	iPolicy;	/*!< New policy */

	};

typedef TPckgBuf<TPhysicalLinkQuickConnectionToken> TPhysicalLinkQuickConnectionTokenBuf;	/*!< Package for TPhysicalLinkQuickConnectionToken structure */

#define KBasebandSlotTime 0.000625	/*!< Baseband timeslot duration (0.000625 seconds) */

static const TUint KDefaultBasebandConnectionTimeout = 10;  /*!< Default baseband connection timeout (10 seconds) */

struct TLMDisconnectACLIoctl

/**

Structure to specify the remote ACL connection to disconnect.

The reason passed in iReason will be sent to the remote device.

Use with KLMDisconnectACLIoctl.

@deprecated

*/

	{

	TBTDevAddr	iDevAddr;	/*!< Device address */

	TUint8		iReason;	/*!< Reason code */

	};

typedef TPckgBuf<TLMDisconnectACLIoctl> TLMDisconnectACLBuf;	/*!< Package for TLMDisconnectACLIoctl structure */

// private tokens for use by RBTBaseband facade and stack

_LIT8(KDisconnectOnePhysicalLink, "1");		/*!< Specifes one physical link should be disconnected */

_LIT8(KDisconnectAllPhysicalLinks, "A");	/*!< Specifes all physical links should be disconnected */

/** Link manager options.

@internalComponent

*/

enum TBTLMOptions

	{

	ELMOutboundACLSize,						/*!< Outbound ACL size option */

	ELMInboundACLSize,						/*!< Inbound ACL size option */

	KLMGetACLHandle,						/*!< Get ACL Handle option */

	KLMGetACLLinkCount,						/*!< Get ACL link count option */

	KLMGetACLLinkArray,						/*!< Get ACL link array option */

	KLMSetBasebandConnectionPolicy,			/*!< Set baseband connection policy option */

	KLMGetBasebandHandle,					/*!< Get baseband handle option */

	EBBSubscribePhysicalLink,				/*!< Subscribe physical link option */

	EBBBeginRaw,							/*!< Enable raw broadcast option */

	EBBRequestRoleMaster,					/*!< Request switch to master option */

	EBBRequestRoleSlave,					/*!< Request switch to slave option */

	EBBCancelModeRequest,					/*!< Cancel mode request option */

	EBBRequestSniff,						/*!< Request sniff mode option */

	EBBRequestPark,							/*!< Request park mode option */

	EBBRequestPreventRoleChange,			/*!< Request to prevent a role (master / slave) switch option */

	EBBRequestAllowRoleChange,				/*!< Request to allow a role (master / slave) switchoption */

	EBBRequestChangeSupportedPacketTypes,	/*!< Request to cange the current supported packet types option */

	EBBEnumeratePhysicalLinks,				/*!< Enumerate physical links option */

	EBBGetPhysicalLinkState,				/*!< Get the physical link state option */

	EBBGetSniffInterval,					/*!< Get Sniff Interval option */

	EBBRequestLinkAuthentication,			/*!< Request authentication on the link */

	EBBRequestExplicitActiveMode,			/*!< Explicitly request the link to go into active mode */

	//Allow combination of options below...

	EBBRequestPreventSniff = 0x100,			/*!< Request to prevent entering sniff mode option */

	EBBRequestPreventHold = 0x200,			/*!< Request to prevent entering hold mode option */

	EBBRequestPreventPark = 0x400,			/*!< Request to prevent entering park mode option */

	EBBRequestPreventAllLowPowerModes = 

		(EBBRequestPreventSniff | 

		 EBBRequestPreventHold | 

		 EBBRequestPreventPark),			/*!< Request to prevent entering all modes option */

	EBBRequestAllowSniff = 0x800,			/*!< Request to allow entering sniff mode option */

	EBBRequestAllowHold = 0x1000,			/*!< Request to allow entering hold mode option */

	EBBRequestAllowPark = 0x2000,			/*!< Request to allow entering park mode option */

	EBBRequestAllowAllLowPowerModes = 

		(EBBRequestAllowSniff | 

		 EBBRequestAllowHold | 

		 EBBRequestAllowPark),				/*!< Request to allow entering-all-modes option. */

	};

// HCI Ioctls

/** Add SCO connnection Ioctl

@deprecated

*/

static const TUint KLMAddSCOConnIoctl			=0;

/** Remove SCO connection Ioctl

@deprecated

*/

static const TUint KHCIRemoveSCOConnIoctl		=1;

/** Change packet types allowed Ioctl

@deprecated

*/

static const TUint KHCIChangePacketTypeIoctl	=2;

/** Request authorisation Ioctl 

@deprecated

*/

static const TUint KHCIAuthRequestIoctl			=3;

/** Request encryption Ioctl

@deprecated

*/

static const TUint KHCIEncryptIoctl				=4;

/** Change link key Ioctl

@deprecated

*/

static const TUint KHCIChangeLinkKeyIoctl		=5;

/** Master link key Ioctl

@deprecated

*/

static const TUint KHCIMasterLinkKeyIoctl		=6;

/** Enable hold mode Ioctl

@deprecated

*/

static const TUint KHCIHoldModeIoctl			=7;

/** Enable sniff mode Ioctl

@deprecated

*/

static const TUint KHCISniffModeIoctl			=8;

/** Exit sniff mode Ioctl