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

// BT protocol wide types

// 

//

#ifndef _BTTYPES_H

#define _BTTYPES_H

#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS

#include <bttypespartner.h>

#endif

#include <e32std.h>

#include <bluetooth/eirdatacodec.h>

/**

@publishedAll

@released

Minimum eSCO connection latency in milliseconds.  Attempts to specify less than this will be silently

increased to this level.

*/

static const TInt KMinESCOLatency = 4;

/**

@publishedAll

@released

Typedef to represent a HCI connection handle.

*/

typedef TUint16 THCIConnHandle;

/**

@publishedAll

@released

Bluetooth SIG specified values for specification of (piconet) role.

*/

enum TBTBasebandRole

	{

	EMaster			= 0x00, /*!< Master role */

	ESlave			= 0x01, /*!< Slave role */

	ERoleUnknown,			/*!< Unknown role */

	};

/**

@publishedAll

@released

Bluetooth SIG specified values for indicating link modes.

*/

enum TBTLinkMode

    {

    EActiveMode		= 0x00, /*!< Active mode */

    EHoldMode		= 0x01, /*!< Hold mode */

    ESniffMode		= 0x02, /*!< Sniff mode */

    EParkMode		= 0x04, /*!< Park mode */

	EScatterMode	= 0x08, /*!< Scatter mode */

    };

/**

@publishedAll

@released

Typedef to represent a union of TBTLinkMode values.

*/

typedef TUint32 TBTLinkModeSet;

/**

@publishedAll

@released

Bitmask values to help request combinations of link modes.

@see TBTLinkMode

*/

enum TBTLinkModeCombinations

	{

	EAnyLowPowerMode = (EHoldMode | ESniffMode | EParkMode | EScatterMode) /*!< Any low power mode */

	};

/**

@publishedAll

@released

Bluetooth SIG specified values for indicating packet types.

DM1, DH1, DM3, DH3, DM5, DH5 are ACL packet types

HV1, HV2, HV3 are SCO (synchronous link) packet types

*/

enum TBTPacketType

	{

	EPacketsDM1			= 0x0008, /*!< DM1 ACL packet type */

	EPacketsDH1			= 0x0010, /*!< DH1 ACL packet type */

	EPacketsDM3			= 0x0400, /*!< DM3 ACL packet type */

	EPacketsDH3			= 0x0800, /*!< DH3 ACL packet type */

	EPacketsDM5			= 0x4000, /*!< DM5 ACL packet type */

	EPacketsDH5			= 0x8000, /*!< DH5 ACL packet type */

	EPackets2_DH1		= 0x0002, /*!< 2-DH1 ACL packet type */

	EPackets3_DH1		= 0x0004, /*!< 3-DH1 ACL packet type */

	EPackets2_DH3		= 0x0100, /*!< 2-DH3 ACL packet type */

	EPackets3_DH3		= 0x0200, /*!< 3-DH3 ACL packet type */

	EPackets2_DH5		= 0x1000, /*!< 2-DH5 ACL packet type */

	EPackets3_DH5		= 0x2000, /*!< 3-DH5 ACL packet type */

	EPacketsHV1			= 0x0020, /*!< HV1 SCO packet type */

	EPacketsHV2			= 0x0040, /*!< HV2 SCO packet type */

	EPacketsHV3			= 0x0080, /*!< HV3 SCO packet type */

	};

/**

@publishedAll

@released

Typedef to represent a set of SCO packet types.

*/

typedef TUint16 TBTSCOPackets;

/**

@publishedAll

@released

Typedef to represent a set of ACL packet types.

*/

typedef TUint16 TBTACLPackets;

/**

@publishedAll

@released

Bitmask values to help request combinations of packets.

@see TBTPacketType

*/

enum TBTPacketTypeCombinations

	{

	EAnyACLPacket	 = EPacketsDM1 | EPacketsDM3 | EPacketsDM5 | EPacketsDH1 | EPacketsDH3 | EPacketsDH5, /*!< Any ACL packet */

	EAnyNonEdrACLPacket = EAnyACLPacket | EPackets2_DH1 | EPackets3_DH1 | EPackets2_DH3 | EPackets3_DH3 | EPackets2_DH5 | EPackets3_DH5, /*!< Any Non-EDR ACL packet */

	EAnySCOPacket	 = EPacketsHV1 | EPacketsHV2 | EPacketsHV3, /*!< Any SCO packet */

	EAnyPacket		= EAnyACLPacket | EAnySCOPacket  /*!< Any packet */

	};

/**

@publishedAll

@released

Typedef to represent a set of synchronous packet types (SCO and eSCO on v1.2).

@see TBTSyncPackets::TSyncPackets

*/

typedef TUint32 TBTSyncPacketTypes;

/**

@publishedAll

@deprecated

This constant is no longer needed to translate the SCO mapping of HV packet types to Synchronous

because CBluetoothSynchronousLink::SetupConnection(const TBTDevAddr& aBDAddr, const TUint16 aPacketTypes)

adjusts aPacketTypes internally on behalf of clients.

*/

static const TInt KSCOvsSyncHVOffset = 5;

/**

@publishedAll

@released

Class to represent a set of synchronous packet types (SCO and eSCO on v1.2).

This differs from TBTSyncPacketTypes as it is the interface used by CBluetoothSynchronousLink

in order to detect the difference between a pre and post eSCO caller.  This is necessary

as HV1 packets in the SCO numbering clash with EV5 packets in the sync numbering.

*/

NONSHARABLE_CLASS(TBTSyncPackets)

	{

	public:

		/**

		@publishedAll

		@released

		Individual synchronous packet types.

		@see TBTSyncPacketTypes

		*/

		enum TSyncPackets

			{

			ESyncPacketsHV1		= 0x10001,

			ESyncPacketsHV2		= 0x10002,

			ESyncPacketsHV3		= 0x10004,

			ESyncPacketsEV3		= 0x20008,

			ESyncPacketsEV4		= 0x20010,

			ESyncPacketsEV5		= 0x20020,

			ESyncAnySCOPacket	= ESyncPacketsHV1 | ESyncPacketsHV2 | ESyncPacketsHV3,

			ESyncAnyESCOPacket	= ESyncPacketsEV3 | ESyncPacketsEV4 | ESyncPacketsEV5

			};

	public:

		IMPORT_C explicit TBTSyncPackets(TBTSyncPacketTypes aPackets);

		IMPORT_C TBTSyncPacketTypes operator()() const;

	private:

		TUint32 iPacketTypes;

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

	};

/**

@publishedAll

@released

eSCO links can have different retransmission options, optimised for link usage,

power or reliability.

@see CBluetoothSynchronousLink::SetRetransmissionEffort

*/

enum TBTeSCORetransmissionTypes

	{

	EeSCORetransmitNone			= 0,

	EeSCORetransmitPower		= 1,

	EeSCORetransmitReliability	= 2,

	EeSCORetransmitDontCare		= 0xff

	};

/**

@publishedAll

@released

eSCO unspecified bandwidth.  This value can only be used by the accepting side

of an eSCO link, to allow any bandwidth to be specified by the initiator.

Otherwise both sides of the link must agree on the same bandwidth.

@see CBluetoothSynchronousLink::SetBandwidth

@see CBluetoothSynchronousLink::AcceptConnection

*/

static const TUint32 KESCOBandwidthDontCare = KMaxTUint32;

/**

@publishedAll

@released

Bluetooth SIG specified values indicating whether a device

is physically able to support a baseband (or link manager protocol) feature

*/

enum TBTSupportedFeatures

	{

	ESupportedThreeSlotPackets				= 1<<0,  /*!< Three slot packets are supported */

	ESupportedFiveSlotPackets				= 1<<1,  /*!< Five slot packets are supported */

	ESupportedEncryption					= 1<<2,  /*!< Encryption is supported */

	ESupportedSlotOffset					= 1<<3,  /*!< Slot offset is supported */

	ESupportedTimingAccuracy				= 1<<4,  /*!< Timing accuracy is supported */

	ESupportedSwitch						= 1<<5,  /*!< Role switch is supported */

	ESupportedHoldMode						= 1<<6,  /*!< Hold mode is supported */

	ESupportedSniffMode						= 1<<7,  /*!< Sniff mode is supported */

	ESupportedParkMode						= 1<<8,  /*!< Park mode is supported */

	ESupportedRSSI							= 1<<9,  /*!< Receive signal strength indication is supported */

	ESupportedChannelQualityDrivenDataRate	= 1<<10, /*!< Channel quality driven data rate is supported */

	ESupportedSCOLink						= 1<<11, /*!< SCO links are supported */

	ESupportedHV2Packets					= 1<<12, /*!< HV2 packets are supported */

	ESupportedHV3Packets					= 1<<13, /*!< HV3 packets are supported */

	ESupportedu_lawLog						= 1<<14, /*!< SCO u-law encoding is supported */

	ESupportedA_lawLog						= 1<<15, /*!< SCO A-law encoding is supported */

	ESupportedCVSD							= 1<<16, /*!< SCO Continuously variable slope delta modulation is supported */

	ESupportedPagingScheme					= 1<<17, /*!< Paging scheme is supported */

	ESupportedPowerControl					= 1<<18, /*!< Power control is supported */

	ESupportedTransparentSCOData			= 1<<19, /*!< Transparent SCO data is supported */

	ESupportedFlowControlLagBit0			= 1<<20, /*!< Flow control lag bit 0 is supported */

	ESupportedFlowControlLagBit1			= 1<<21, /*!< Flow control lag bit 1 is supported */

	ESupportedFlowControlLagBit2			= 1<<22, /*!< Flow control lag bit 2 is supported */

	};

/**

@publishedAll

@released

Bitmask values for notifying/requesting notification of the state of a physical link.

These values have a two fold purpose:

1) They can be used along with TBTPhysicalLinkStateNotifierCombinations to specify

a set of baseband change events for which notification is desired.

2) They can be used to notify the state of a physical link or a subset of that state.

For example if only mode change events are being monitored, then at each mode change event

only the bit reperesenting the new mode will be returned, however if the whole link state

is required, then a combination of bit values indicating that state will be returned.

THESE BIT VALUES MUST ONLY BE USED WHEN REQUESTING NOTIFICATION, OR WHEN PARSING THE

RESULTS OF A NOTIFICATION. All other baseband state activities should use one of the 

appropriate Bluetooth SIG specified enums

@see TBTBasebandRole

@see TBTLinkMode

@see TBTLinkModeCombinations

@see TBTPacketType

@see TBTPacketTypeCombinations

*/

enum TBTPhysicalLinkStateNotifier

	{

	ENotifyMaster					= 0x00000001, /*!< Master */

	ENotifySlave					= 0x00000002, /*!< Slave */

	ENotifyActiveMode				= 0x00000004, /*!< Active mode */

	ENotifySniffMode				= 0x00000008, /*!< Sniff mode */

	ENotifyParkMode					= 0x00000010, /*!< Park mode */

	ENotifyHoldMode					= 0x00000020, /*!< Hold mode */

	ENotifyMaxSlots1				= 0x00000040, /*!< Max slots 1 */

	ENotifyMaxSlots3				= 0x00000080, /*!< Max slots 3 */

	ENotifyMaxSlots5				= 0x00000100, /*!< Max slots 5 */

	ENotifyPacketsDM1				= 0x00000200, /*!< Packets DM1 */

	ENotifyPacketsDH1				= 0x00000400, /*!< Packets DH1 */

	ENotifyPacketsDM3				= 0x00000800, /*!< Packets DM3 */

	ENotifyPacketsDH3				= 0x00001000, /*!< Packets DH3 */

	ENotifyPacketsDM5				= 0x00002000, /*!< Packets DM5 */

	ENotifyPacketsDH5				= 0x00004000, /*!< Packets DH5 */

	ENotifyPacketsHV1				= 0x00008000, /*!< HV1 */

	ENotifyPacketsHV2				= 0x00010000, /*!< HV2 */

	ENotifyPacketsHV3				= 0x00020000, /*!< HV3 */

	ENotifyAuthenticationComplete	= 0x00040000, /*!< Authentication Complete */

	ENotifyEncryptionChangeOn		= 0x00080000, /*!< Encryption Change On */

	ENotifyEncryptionChangeOff		= 0x00100000, /*!< Encryption Change Off */

	ENotifyPhysicalLinkUp			= 0x00200000, /*!< Physical Link Up */

	ENotifyPhysicalLinkDown			= 0x00400000, /*!< Physical Link Down */

	ENotifyPhysicalLinkError		= 0x00800000, /*!< Physical Link Error */

	ENotifySynchronousLinkUp		= 0x01000000, /*!< Synchronous Link Up */

	ENotifySynchronousLinkDown		= 0x02000000, /*!< Synchronous Link Down */

	ENotifySynchronousLinkError		= 0x04000000, /*!< Synchronous Link Error */

	/**

	@deprecated This has been superseded by ENotifySynchronousLinkUp

	@see ENotifySynchronousLinkUp 

	*/

	ENotifySCOLinkUp				= ENotifySynchronousLinkUp,

	/**

	@deprecated This has been superseded by ENotifySynchronousLinkDown

	@see ENotifySynchronousLinkDown 

	*/

	ENotifySCOLinkDown				= ENotifySynchronousLinkDown, 

	/**

	@deprecated This has been superseded by ENotifySynchronousLinkError

	@see ENotifySynchronousLinkError 

	*/

	ENotifySCOLinkError				= ENotifySynchronousLinkError 

	};

/**

@publishedAll

@released

Bitmask values to help request notification of the state of a physical link.

@see TBTPhysicalLinkStateNotifier

*/

enum TBTPhysicalLinkStateNotifierCombinations

	{

	ENotifyAnyRole					= ENotifyMaster | ENotifySlave,

	ENotifyAnyLowPowerMode			= ENotifySniffMode | ENotifyParkMode | ENotifyHoldMode,

	ENotifyAnyPowerMode				= ENotifyActiveMode | ENotifyAnyLowPowerMode,

	ENotifyAnyMaxSlots				= ENotifyMaxSlots1 | ENotifyMaxSlots3 | ENotifyMaxSlots5,

	ENotifyAnyACLPacketType			= ENotifyPacketsDM1 | ENotifyPacketsDH1 | ENotifyPacketsDM3 | EPacketsDH3 | EPacketsDM5 | EPacketsDH5,

	ENotifyAnySCOPacketType			= ENotifyPacketsHV1 | ENotifyPacketsHV2 | ENotifyPacketsHV3,

	ENotifyAnyPacketType			= ENotifyAnyACLPacketType | ENotifyAnySCOPacketType,

	ENotifyAnyPhysicalLinkState		= 0xffffffff,

	};

/**

@publishedAll

@released

The maximum length of an SDP UUID.

*/

static const TInt KSdpUUIDMaxLength			= 16;

/**

@publishedAll

@released

The size of a bluetooth device address in bytes.

*/

const TInt KBTDevAddrSize=0x06;

/**

@publishedAll

@released

The size of a bluetooth device address in bytes.

*/

const TInt KBTMaxDevAddrSize = KBTDevAddrSize;

/**

@publishedAll

@released

48-bit bluetooth device address.

Each bluetooth device has a unique address built into the hardware, which

is represented by this class. Used for identifying remote addresses.

The interface operates in a big-endian manner -- e.g. addr[0] refers

to the most significant byte of the address. This is the same ordering

as the addresses would naturally be written down on paper.

**/

NONSHARABLE_CLASS(TBTDevAddr)

	{

public:

	IMPORT_C TBTDevAddr();

	IMPORT_C TBTDevAddr(const TInt64 &aInt);

	IMPORT_C TBTDevAddr(const TDesC8 &aDes);

	IMPORT_C TBool operator==(const TBTDevAddr& aAddr) const;

	IMPORT_C TBool operator!=(const TBTDevAddr& aAddr) const;

	IMPORT_C const TUint8 &operator[](TInt aIndex) const;

	IMPORT_C TUint8 &operator[](TInt aIndex);

	IMPORT_C void Reset();

	IMPORT_C TPtr8 Des();

	IMPORT_C const TPtrC8 Des() const;

	IMPORT_C TInt SetReadable(const TDesC& aSource);

	IMPORT_C void GetReadable(TDes& aDest) const;

	IMPORT_C void GetReadable(TDes& aDest, const TDesC& aPrepend, const TDesC& aByteSeperator, const TDesC& aAppend) const;

	IMPORT_C TBool operator<=(const TBTDevAddr& aAddr) const;

private:

	TFixedArray<TUint8, KBTDevAddrSize> iAddr;

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

	// iPadding hasn't been zero'd because it is currently not used

	TUint16		iPadding;

    };

/** Array of device addresses

@see Enumerate method

*/

typedef RArray<TBTDevAddr> RBTDevAddrArray;

/**

@publishedAll

@released

A Bluetooth Universally Unique Identifier.

This is a 128-bit quantity that can be created without a central registry 

while still being globally unique.

UUIDs are always held in full 128 bit format, however they can be set from 

BT SIG short form (16 or 32 bit) addresses, and returned as down to their 

shortest form using ShortestForm().

**/

NONSHARABLE_CLASS(TUUID)

	{

public:

	IMPORT_C TUUID();

	IMPORT_C TUUID(TUint32 aLong);

	IMPORT_C TUUID(TUint32 aHH, TUint32 aHL, TUint32 aLH, TUint32 aLL);

	IMPORT_C TUUID(const TUid& aUid);

	IMPORT_C void SetL(const TDesC8& aDes);

	IMPORT_C const TPtrC8 LongForm() const;

	IMPORT_C const TPtrC8 ShortestForm() const;

	IMPORT_C const TPtrC8 Des() const;

	/**

	@deprecated

	Use SpecifiedLengthL(TInt aLength) instead

	*/

	IMPORT_C const TPtrC8 FixedLengthL(TInt aLength) const;

	IMPORT_C TInt MinimumSize() const;

	IMPORT_C TBool operator==(const TUUID& aUUID) const;

	IMPORT_C TBool operator!=(const TUUID& aUUID) const;

	IMPORT_C const TUint8 &operator[](TInt aIndex) const;

	IMPORT_C TUint8 &operator[](TInt aIndex);

	IMPORT_C const TPtrC8 SpecifiedLengthL(TInt aLength) const;

	IMPORT_C void SetFromLittleEndianL(const TDesC8& aDes);

private:

	TFixedArray<TUint8, KSdpUUIDMaxLength> iUUID;	

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

	};

/**

@publishedAll

@released

A UUID container class

*/

NONSHARABLE_CLASS(RUUIDContainer)

	{

public:

	IMPORT_C void Close();

	IMPORT_C void Reset();

	IMPORT_C TInt Count() const;

	IMPORT_C TUUID& operator[](TInt aIndex);

	IMPORT_C const TUUID& operator[](TInt aIndex) const;

	IMPORT_C const TUUID& At(TInt aIndex) const;

	IMPORT_C TBool IsPresent(const TUUID& aUuid) const;

	IMPORT_C TInt Add(const TUUID& aUuid);

private:

	RArray<TUUID> iUUIDs;

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

	};

/**

@publishedAll

@released

An EIR UUID container class. Contains UUIDs and indications of data completeness

*/

NONSHARABLE_CLASS(RExtendedInquiryResponseUUIDContainer)