// 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 "Eclipse Public License v1.0"

// which accompanies this distribution, and is available

// at the URL "http://www.eclipse.org/legal/epl-v10.html".

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

//

#ifndef BTDEVICE_H

#define BTDEVICE_H

#include <e32std.h>

#include <e32base.h>

#include <s32mem.h>

#include <bluetooth/hci/hciopcodes.h>

#include <bluetooth/hci/hciconsts.h>

/** The maximum length of a bluetooth device name, as stored in CBTDevice.

@publishedAll

@released

**/

static const TInt KMaxBluetoothNameLen = KHCILocalDeviceNameMaxLength;

/** The maximum length of the user-assinged friendly name for a bluetooth device, as stored in CBTDevice.

@publishedAll

@released

**/

static const TInt KMaxFriendlyNameLen = 100;

/** Length of a bluetooth device name. This is not to be used outside of the sub-system. Retained for binary compatibility.

@internalComponent

@deprecated

**/

static const TInt KMaxBCBluetoothNameLen = 256;

//forward declarations

class TBTDeviceClass;

class CBTDevice;

class TBTServiceSecurityPerDevice;

/** A typedef'ed array of CBTDevice objects.

@publishedAll

@released

**/

typedef CArrayPtrFlat<CBTDevice> CBTDeviceArray;

/** A typedef'ed array of TBTServiceSecurityPerDevice objects.

@publishedAll

@released

**/

typedef RArray<TBTServiceSecurityPerDevice> RBTSecurityArray;

/** Wide descriptor of correct length to hold a bluetooth device name.

@publishedAll

@released

**/

typedef TBuf<KMaxBCBluetoothNameLen> TBTDeviceName;

/** Narrow descriptor of correct length to hold a bluetooth device name.

@publishedAll

@released

**/

typedef TBuf8<KMaxBluetoothNameLen> TBTDeviceName8;

/** Utility class to convert between a wide TBTDeviceName and a narrow TBTDeviceName8.

@publishedAll

@released

**/

class BTDeviceNameConverter

	{

public:

	IMPORT_C static TBTDeviceName ToUnicodeL(const TBTDeviceName8& aName);

	IMPORT_C static TBTDeviceName8 ToUTF8L(const TBTDeviceName& aName);

	};

/** Cleanup utility for CBTDeviceArrays.

Creates a TCleanupItem that calls ResetAndDestroy and then deletes the array.

@publishedAll

@released

*/

class BTDeviceArrayCleanupStack

	{

public:

	IMPORT_C static void PushL(CBTDeviceArray* aBTDeviceArray);

private:

	static void ResetAndDestroy(TAny* aBTDeviceArray);

	};

/** Enum used to describe the Bluetooth major service classes.  

See the bluetooth specification for more details.

@publishedAll

@released

**/

enum TBTMajorServiceClass

	{												//23        13	<- bit number

	/** Limited discoverable mode **/

	EMajorServiceLimitedDiscoverableMode = 0x01,	//00000000001

	/** Positioning **/

	EMajorServicePositioning = 0x08,				//00000001000

	/** Networking **/

	EMajorServiceNetworking = 0x10,					//00000010000

	/** Rendering **/

	EMajorServiceRendering = 0x20,					//00000100000

	/** Capturing **/

	EMajorServiceCapturing = 0x40,					//00001000000

	/** Object transfer **/

	EMajorServiceObjectTransfer = 0x80,				//00010000000

	/** Audio **/

	EMajorServiceAudio = 0x100,						//00100000000

	/** Telephony **/

	EMajorServiceTelephony = 0x200,					//01000000000

	/** Information **/

	EMajorServiceInformation = 0x400,				//10000000000

	/**

	 * Old name kept for SC.

	 * @deprecated

	 * @see EMajorServiceAudio

	 */

	EMajorServiceAudioService = 0x100				//00100000000

	};

/** Enum used to describe the Bluetooth major device classes.  

See the bluetooth specification for more details.

@publishedAll

@released

**/

enum TBTMajorDeviceClass

	{												//12  8	<- bit number

	/** Miscellaneous device **/

	EMajorDeviceMisc = 0x0,							//00000

	/** Computer device **/

	EMajorDeviceComputer = 0x1,						//00001

	/** Phone device **/

	EMajorDevicePhone = 0x2,						//00010

	/** LAN access point device **/

	EMajorDeviceLanAccessPoint = 0x3,				//00011

	/** Audio-video device **/

	EMajorDeviceAV = 0x4,							//00100

	/** Peripheral device **/

	EMajorDevicePeripheral = 0x5,					//00101

	/** Imaging device **/

	EMajorDeviceImaging = 0x6,						//00110

	/** Wearable device **/

	EMajorDeviceWearable = 0x7,						//00111

	/** Toy device **/

	EMajorDeviceToy = 0x8,							//01000

	/** Unclassified device **/

	EMajorDeviceUnclassified = 0x1F,				//11111

	/**

	 * Old name kept for SC.

	 * @deprecated

	 * @see EMajorDeviceAV

	 */

	EMajorDeviceAudioDevice = 0x4,					//00100

	/**

	 * Old name kept for SC.

	 * @deprecated

	 * @see EMajorDeviceUnclassified

	 */

	EMajorDeviceDeviceUnclassified = 0x1F			//11111

	};

/** Enum used to describe the Bluetooth minor device classes relating to the "Computer" major device class.

See the bluetooth specification for more details.

@publishedAll

@released

**/

enum TBTMinorDeviceClassComputer

	{										//7    2	<- bit number

	/** Unclassified computer device **/

	EMinorDeviceComputerUnclassified = 0x0,	//000000

	/** Desktop computer device **/

	EMinorDeviceComputerDesktop = 0x1,		//000001

	/** Server computer device **/

	EMinorDeviceComputerServer = 0x2,		//000010

	/** Laptop computer device **/

	EMinorDeviceComputerLaptop = 0x3,		//000011

	/** Handheld computer device **/

	EMinorDeviceComputerHandheld = 0x4,		//000100

	/** Palm computer device **/

	EMinorDeviceComputerPalmSize = 0x5,		//000101

	/** Wearable computer device **/

	EMinorDeviceComputerWearable = 0x6		//000110

	};

/** Enum used to describe the Bluetooth minor device classes relating to the "phone" major device class.

See the bluetooth specification for more details.

@publishedAll

@released

**/

enum TBTMinorDeviceClassPhone

	{										//7    2	<- bit number

	/** Unclassified phone device **/

	EMinorDevicePhoneUnclassified = 0x0,	//000000

	/** Cellular phone device **/

	EMinorDevicePhoneCellular = 0x1,		//000001

	/** Cordless phone device **/

	EMinorDevicePhoneCordless = 0x2,		//000010

	/** Smart phone device **/

	EMinorDevicePhoneSmartPhone = 0x3,		//000011

	/** Wired modem phone device **/

	EMinorDevicePhoneWiredModem = 0x4,		//000100

	/** ISDN phone device **/

	EMinorDevicePhoneCommonISDNAccess = 0x5	//000101

	};

/** Enum used to describe the Bluetooth minor device classes relating to the "LAN" major device class.

See the bluetooth specification for more details.

@publishedAll

@released

**/

enum TBTMinorDeviceClassLAN

	{										//7    2	<- bit number

	/** LAN is currently 0% utilitized **/

	EMinorDeviceLANFullyAvailable = 0x0,	//000000

	/** LAN is currently 1-17% utilitized **/

	EMinorDeviceLANServiceOne = 0x8,		//001000

	/** LAN is currently 17-33% utilitized **/

	EMinorDeviceLANServiceTwo = 0x10,		//010000

	/** LAN is currently 33-50% utilitized **/

	EMinorDeviceLANServiceThree = 0x18,		//011000

	/** LAN is currently 50-67% utilitized **/

	EMinorDeviceLANServiceFour = 0x20,		//100000

	/** LAN is currently 67-83% utilitized **/

	EMinorDeviceLANServiceFive = 0x28,		//101000

	/** LAN is currently 83-99% utilitized **/

	EMinorDeviceLANServiceSix = 0x30,		//110000

	/** LAN is currently 100% utilitized **/

	EMinorDeviceLANNoService = 0x38			//111000

	};

/** Enum used to describe the Bluetooth minor device classes relating to the "AV" major device class.

See the bluetooth specification for more details.

@publishedAll

@released

**/

enum TBTMinorDeviceClassAV

	{												//7    2

	/** Unclassified AV Device **/

	EMinorDeviceAVUnclassified = 0x0,				//000000

	/** Headset AV Device **/

	EMinorDeviceAVHeadset = 0x1,					//000001

	/** Handsfree AV Device **/

	EMinorDeviceAVHandsfree = 0x2,					//000010

	/** Microphone AV Device **/

	EMinorDeviceAVMicrophone = 0x4,					//000100

	/** Loudspeaker AV Device **/

	EMinorDeviceAVLoudspeaker = 0x5,				//000101

	/** Headphone AV Device **/

	EMinorDeviceAVHeadphones = 0x6,					//000110

	/** Portable audio AV Device **/

	EMinorDeviceAVPortableAudio = 0x7,				//000111

	/** Car audio AV Device **/

	EMinorDeviceAVCarAudio = 0x8,					//001000

	/** Set top box AV Device **/

	EMinorDeviceAVSetTopBox = 0x9,					//001001

	/** Hifi audio AV Device **/

	EMinorDeviceAVHiFiAudio = 0xA,					//001010

	/** VCR AV Device **/

	EMinorDeviceAVVCR = 0xB,						//001011

	/** Video camera AV Device **/

	EMinorDeviceAVVideoCamera = 0xC,				//001100

	/** Camcorder AV Device **/

	EMinorDeviceAVCamcorder = 0xD,					//001101

	/** Video monitor AV Device **/

	EMinorDeviceAVVideoMonitor = 0xE,				//001110

	/** Video display and loudspeaker AV Device **/

	EMinorDeviceAVVideoDisplayAndLoudspeaker = 0xF,	//001111

	/** Video conferencing AV Device **/

	EMinorDeviceAVVideoConferencing = 0x10,			//010000

	/** Gaming toy AV Device **/

	EMinorDeviceAVGamingToy = 0x12					//010010

	};	

/** Enum used to describe the Bluetooth minor device classes relating to the "Peripheral" major device class.

See the bluetooth specification for more details.

@publishedAll

@released

**/

enum TBTMinorDeviceClassPeripheral

	{													//7    2

	/** Keyboard peripheral device.

	Note that the keyboard bit can be independently

	or'd with all other bits.

	**/

	EMinorDevicePeripheralKeyboard = 0x10,				//010000

	/** Pointer peripheral device.

	Note that the pointer bit can be independently

	or'd with all other bits.

	**/

	EMinorDevicePeripheralPointer = 0x20,				//100000

	//

	// All other bits are mutually exclusive

	//

	/** Uncategorized peripheral device **/

	EMinorDevicePeripheralUncategorized = 0x00,			//000000

	/** Joystick peripheral device **/

	EMinorDevicePeripheralJoystick = 0x01,				//000001

	/** Gamepad peripheral device **/

	EMinorDevicePeripheralGamepad = 0x02,				//000010

	/** Remote control peripheral device **/

	EMinorDevicePeripheralRemoteControl = 0x03,			//000011

	/** Sensing peripheral device **/

	EMinorDevicePeripheralSensingDevice = 0x04,			//000100

	/** Digitizer tablet peripheral device **/

	EMinorDevicePeripheralDigitizerTablet = 0x05,		//000101

	/** Card reader peripheral device **/

	EMinorDevicePeripheralCardReader = 0x06				//000110

	};

/** Enum used to describe the Bluetooth minor device classes relating to the "Imaging" major device class.

See the bluetooth specification for more details.

@publishedAll

@released

**/

enum TBTMinorDeviceClassImaging

	{											//7    2

	/** Display imaging device **/

	EMinorDeviceImagingDisplay = 0x04,			//000100

	/** Camera imaging device **/

	EMinorDeviceImagingCamera = 0x08,			//001000

	/** Scanner imaging device **/

	EMinorDeviceImagingScanner = 0x10,			//010000

	/** Printer imaging device **/

	EMinorDeviceImagingPrinter = 0x20,			//100000

	};

/** Enum used to describe the Bluetooth minor device classes relating to the "Wearable" major device class.

See the bluetooth specification for more details.

@publishedAll

@released

**/

enum TBTMinorDeviceClassWearable

	{											//7    2

	/** Wrist watch wearable device **/

	EMinorDeviceWearableWatch = 0x01,			//000001

	/** Pager wearable device **/

	EMinorDeviceWearablePager = 0x02,			//000010

	/** Jacket wearable device **/

	EMinorDeviceWearableJacket = 0x03,			//000011

	/** Helmet wearable device **/

	EMinorDeviceWearableHelmet = 0x04,			//000100

	/** Glasses wearable device **/

	EMinorDeviceWearableGlasses = 0x05,			//000101	

	};

/** Enum used to describe the Bluetooth minor device classes relating to the "Toy" major device class.

See the bluetooth specification for more details.

@publishedAll

@released

**/

enum TBTMinorDeviceClassToy

	{											//7    2

	/** Robot toy device **/

	EMinorDeviceToyRobot = 0x01,				//000001

	/** Vehicle toy device **/

	EMinorDeviceToyVehicle = 0x02,				//000010

	/** Doll toy device **/

	EMinorDeviceToyDoll = 0x03,					//000011

	/** Controller toy device **/

	EMinorDeviceToyController = 0x04,			//000100

	/** Game toy device **/

	EMinorDeviceToyGame = 0x05,					//000101	

	};

/** Encapsulation of device class definitions.

Contains a single TInt as member data and methods to extract the major, minor and service

class information from that TInt.

@publishedAll

@released

**/

NONSHARABLE_CLASS(TBTDeviceClass)

	{

public:

	IMPORT_C TBTDeviceClass();

	IMPORT_C TBTDeviceClass(TUint32 aDeviceClass);

	IMPORT_C TBTDeviceClass(TUint16 aMajorServiceClass, TUint8 aMajorDeviceClass,

							TUint8 aMinorDeviceClass);

	IMPORT_C TUint16 MajorServiceClass() const;

	IMPORT_C TUint8 MajorDeviceClass() const;

	IMPORT_C TUint8 MinorDeviceClass() const;

	IMPORT_C TUint32 DeviceClass() const;

	IMPORT_C TBool operator==(const TBTDeviceClass& aDeviceClass) const;

	IMPORT_C TBTDeviceClass& operator=(const TBTDeviceClass& aDeviceClass);

	IMPORT_C void ExternalizeL(RWriteStream& aStream) const;

	IMPORT_C void InternalizeL(RReadStream& aStream);

private:

	static const TUint32 KStreamVersion = 0x00000001;

private:

	TUint32	iDeviceClass;

	// This data padding has been added to help prevent future binary compatibility breaks	

	// Neither iPadding1 nor iPadding2 have been zero'd because they are currently not used

	TUint32	iPadding1; 

	TUint32	iPadding2; 

	};

/** Class to store the security override parameters for a particular remote device.

@publishedAll

@released

*/

NONSHARABLE_CLASS(TBTDeviceSecurity)

	{

public:

	/** Enumeration to provide select MITM protection required. */

	enum TMitmRequired

		{

		EMitmUnspecified,	/*!< No specific MITM protection requirements */

		EMitmRequired		/*!< Require the link is MITM protected */

		};

public:

	IMPORT_C TBTDeviceSecurity();

	IMPORT_C TBTDeviceSecurity(TUint8 aSecurity);

	IMPORT_C TBTDeviceSecurity(TUint8 aSecurity, TUint aPasskeyMinLength);

	IMPORT_C TBTDeviceSecurity(TBool aNoAuthenticate, TBool aNoAuthorise, TBool aEncrypt, TBool aBanned);

	IMPORT_C TBTDeviceSecurity(TMitmRequired aMitmRequirements, TBool aNoAuthorise, TBool aEncrypt, TBool aBanned);

	IMPORT_C void SetNoAuthenticate(TBool aDecision);

	IMPORT_C void SetMitmRequirements(TMitmRequired aDecision);

	IMPORT_C void SetNoAuthorise(TBool aDecision);

	IMPORT_C void SetEncrypt(TBool aDecision);

	IMPORT_C void SetBanned(TBool aDecision);

	IMPORT_C TBool NoAuthenticate() const;

	IMPORT_C TMitmRequired MitmRequirements() const;

	IMPORT_C TBool NoAuthorise() const;

	IMPORT_C TBool Encrypt() const;

	IMPORT_C TBool Banned() const;

	IMPORT_C TUint PasskeyMinLength() const;

	IMPORT_C TUint8 SecurityValue() const;

	IMPORT_C void SetSecurityValue(TUint8 aDeviceSecurity);

	IMPORT_C TInt SetPasskeyMinLength(TUint aPasskeyMinLength);	

	IMPORT_C TBool operator==(const TBTDeviceSecurity& aDeviceSecurity) const;

	IMPORT_C TBool operator!=(const TBTDeviceSecurity& aDeviceSecurity) const;

	IMPORT_C void ExternalizeL(RWriteStream& aStream) const;

	IMPORT_C void InternalizeL(RReadStream& aStream);

public:

	/** Enumeration to assist in parsing of security settings. */

	enum TBTDeviceSecuritySettings

		{

		ENoAuthenticate			= 0x01, /*!< Don't authenticate the link @deprecated */

		ENoAuthorise			= 0x02, /*!< Don't authorise the connection */

		EEncrypt				= 0x04, /*!< Encrypt the link */

		EBanned					= 0x08, /*!< Don't connect to the device */

		EMitmProtectionRequired	= 0x10, /*!< Require the link is MITM protected */

		};

private:

	static const TUint32 KStreamVersion = 0x00000001;

private:

	TUint8	iSecurity;

	TUint	iPasskeyMinLength;	

	// This data padding has been added to help prevent future binary compatibility breaks	

	// Neither iPadding1 nor iPadding2 have been zero'd because they are currently not used

	TUint32	iPadding1; 

	TUint32	iPadding2; 

	};

/** Class to tie a service uid with a device security setting.

This allows us to have service-specific security settings for a device.

@publishedAll

@released

*/

NONSHARABLE_CLASS(TBTServiceSecurityPerDevice)

	{

public:

	IMPORT_C TBTServiceSecurityPerDevice();

	IMPORT_C TBTServiceSecurityPerDevice(const TBTDevAddr& aDevice, const TBTDeviceSecurity& aSecuritySettings);

	IMPORT_C TBTServiceSecurityPerDevice(const TBTServiceSecurityPerDevice&);

	IMPORT_C void SetDeviceSecurity(const TBTDeviceSecurity& aSecuritySettings);

	IMPORT_C void SetAddress(const TBTDevAddr& aAddress);

	IMPORT_C const TBTDeviceSecurity& DeviceSecurity() const;

	IMPORT_C const TBTDevAddr& DeviceAddress() const;

	IMPORT_C void operator=(const TBTServiceSecurityPerDevice& aServiceSecurityPerDevice);

	IMPORT_C TBool operator==(const TBTServiceSecurityPerDevice& aServiceSecurityPerDevice) const;

	IMPORT_C TBool operator!=(const TBTServiceSecurityPerDevice& aServiceSecurityPerDevice) const;