bluetooth/btstack/linkmgr/roleswitchhelper.h
author hgs
Wed, 13 Oct 2010 16:20:29 +0300
changeset 51 20ac952a623c
parent 48 22de2e391156
permissions -rw-r--r--
201040_02
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
48
hgs
parents:
diff changeset
     1
// Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     2
// All rights reserved.
hgs
parents:
diff changeset
     3
// This component and the accompanying materials are made available
hgs
parents:
diff changeset
     4
// under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     5
// which accompanies this distribution, and is available
hgs
parents:
diff changeset
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     7
//
hgs
parents:
diff changeset
     8
// Initial Contributors:
hgs
parents:
diff changeset
     9
// Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    10
//
hgs
parents:
diff changeset
    11
// Contributors:
hgs
parents:
diff changeset
    12
//
hgs
parents:
diff changeset
    13
// Description:
hgs
parents:
diff changeset
    14
//
hgs
parents:
diff changeset
    15
hgs
parents:
diff changeset
    16
#ifndef ROLESWITCHHELPER_H
hgs
parents:
diff changeset
    17
#define ROLESWITCHHELPER_H
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
#include <bt_sock.h>
hgs
parents:
diff changeset
    20
#include <bluetooth/hci/hciutil.h> 
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
#include "debug.h"
hgs
parents:
diff changeset
    23
#include "linkutil.h"
hgs
parents:
diff changeset
    24
#include "physicallinkhelper.h"
hgs
parents:
diff changeset
    25
#include "physicallinks.h"
hgs
parents:
diff changeset
    26
hgs
parents:
diff changeset
    27
// watchdog for first half of the SM including:
hgs
parents:
diff changeset
    28
// DisablingLPM, DisablingEncryption, RoleSwitch
hgs
parents:
diff changeset
    29
const TUint KTimeoutRoleSwitch =   3000000;  // 3 s; 
hgs
parents:
diff changeset
    30
hgs
parents:
diff changeset
    31
// watchdog for EnablingEncryption
hgs
parents:
diff changeset
    32
const TUint KTimeoutOneCommand =   2000000;  // 2 s;
hgs
parents:
diff changeset
    33
 
hgs
parents:
diff changeset
    34
class TRoleSwitcherState;
hgs
parents:
diff changeset
    35
hgs
parents:
diff changeset
    36
NONSHARABLE_CLASS(CRoleSwitcher) : public CPhysicalLinkHelper
hgs
parents:
diff changeset
    37
	{
hgs
parents:
diff changeset
    38
	friend class TRoleSwitcherState;
hgs
parents:
diff changeset
    39
	friend class TRSStateIdle;
hgs
parents:
diff changeset
    40
	friend class TRSStateDisablingLPM;
hgs
parents:
diff changeset
    41
	friend class TRSStateDisablingEncryption;
hgs
parents:
diff changeset
    42
	friend class TRSStateChangingRole;
hgs
parents:
diff changeset
    43
	friend class TRSStateChangingRoleWithEPR;
hgs
parents:
diff changeset
    44
	friend class TRSStateEnablingEncryption;
hgs
parents:
diff changeset
    45
hgs
parents:
diff changeset
    46
public:
hgs
parents:
diff changeset
    47
	static CRoleSwitcher* NewL(CPhysicalLinksManager& aLinkMgr, CPhysicalLink& aLink, TBTBasebandRole aRole);
hgs
parents:
diff changeset
    48
	~CRoleSwitcher();
hgs
parents:
diff changeset
    49
hgs
parents:
diff changeset
    50
	virtual void StartHelper();
hgs
parents:
diff changeset
    51
	
hgs
parents:
diff changeset
    52
	inline TBool IsEncryptionDisabledForRoleSwitch() const;
hgs
parents:
diff changeset
    53
	inline TBTBasebandRole RequestedRole() const;
hgs
parents:
diff changeset
    54
hgs
parents:
diff changeset
    55
	TSglQueLink   iQLink;
hgs
parents:
diff changeset
    56
hgs
parents:
diff changeset
    57
private:
hgs
parents:
diff changeset
    58
	CRoleSwitcher(CPhysicalLinksManager& aLinkMgr, CPhysicalLink& aLink, TBTBasebandRole aRole);
hgs
parents:
diff changeset
    59
	void ConstructL(); 
hgs
parents:
diff changeset
    60
	
hgs
parents:
diff changeset
    61
	virtual void TimerExpired();
hgs
parents:
diff changeset
    62
	virtual void HandleError(TInt aError);
hgs
parents:
diff changeset
    63
	virtual void EventReceived(TBTBasebandEventNotification& aEvent);
hgs
parents:
diff changeset
    64
hgs
parents:
diff changeset
    65
	void DisableEncryption();
hgs
parents:
diff changeset
    66
	void ChangeRole();
hgs
parents:
diff changeset
    67
	void EnableEncryption();
hgs
parents:
diff changeset
    68
	void SaveEncryption();
hgs
parents:
diff changeset
    69
	
hgs
parents:
diff changeset
    70
	void LogRoleSwitchSuccessful(TBTBasebandEventNotification& aEvent) const;
hgs
parents:
diff changeset
    71
hgs
parents:
diff changeset
    72
	TBool					iIsEncrypted;
hgs
parents:
diff changeset
    73
	TBool					iIsActive;  // LinkMode
hgs
parents:
diff changeset
    74
	TBool					iAddedToLinkMgr;
hgs
parents:
diff changeset
    75
	TBTBasebandRole			iRole;  // Requested role    
hgs
parents:
diff changeset
    76
	TRoleSwitcherState*		iState;
hgs
parents:
diff changeset
    77
	TBool					iIsEncryptionDisabledForRoleSwitch;             
hgs
parents:
diff changeset
    78
	};
hgs
parents:
diff changeset
    79
hgs
parents:
diff changeset
    80
//--------------------------------------------------
hgs
parents:
diff changeset
    81
// STATE FACTORY
hgs
parents:
diff changeset
    82
//--------------------------------------------------
hgs
parents:
diff changeset
    83
hgs
parents:
diff changeset
    84
/**
hgs
parents:
diff changeset
    85
   Factory for the RoleSwitcher states
hgs
parents:
diff changeset
    86
hgs
parents:
diff changeset
    87
   The states are flyweight classes
hgs
parents:
diff changeset
    88
**/
hgs
parents:
diff changeset
    89
NONSHARABLE_CLASS(CRoleSwitcherStateFactory) : public CBase
hgs
parents:
diff changeset
    90
	{
hgs
parents:
diff changeset
    91
public:
hgs
parents:
diff changeset
    92
	static CRoleSwitcherStateFactory* NewL();
hgs
parents:
diff changeset
    93
hgs
parents:
diff changeset
    94
	enum TRoleSwitcherStates
hgs
parents:
diff changeset
    95
		{
hgs
parents:
diff changeset
    96
		EIdle,
hgs
parents:
diff changeset
    97
		EDisablingLPM,
hgs
parents:
diff changeset
    98
		EDisablingEncryption,
hgs
parents:
diff changeset
    99
		EChangingRole,
hgs
parents:
diff changeset
   100
		EChangingRoleWithEPR,
hgs
parents:
diff changeset
   101
		EEnablingEncryption,
hgs
parents:
diff changeset
   102
		// Note that we don't need a state to enable LPM again
hgs
parents:
diff changeset
   103
		// as this will happen implicitly when we close our 
hgs
parents:
diff changeset
   104
		// proxy SAP.
hgs
parents:
diff changeset
   105
	// *** keep next one last ***
hgs
parents:
diff changeset
   106
		ERoleSwitcherMaxState,
hgs
parents:
diff changeset
   107
		};
hgs
parents:
diff changeset
   108
	
hgs
parents:
diff changeset
   109
	TRoleSwitcherState& GetState(TRoleSwitcherStates aState);
hgs
parents:
diff changeset
   110
	TInt StateIndex(const TRoleSwitcherState* aState) const;
hgs
parents:
diff changeset
   111
	
hgs
parents:
diff changeset
   112
private:
hgs
parents:
diff changeset
   113
	CRoleSwitcherStateFactory();
hgs
parents:
diff changeset
   114
	void ConstructL();
hgs
parents:
diff changeset
   115
	TFixedArray<TRoleSwitcherState*, ERoleSwitcherMaxState> iStates;
hgs
parents:
diff changeset
   116
	};
hgs
parents:
diff changeset
   117
hgs
parents:
diff changeset
   118
hgs
parents:
diff changeset
   119
hgs
parents:
diff changeset
   120
//--------------------------------------------------
hgs
parents:
diff changeset
   121
// STATES, base 
hgs
parents:
diff changeset
   122
//--------------------------------------------------
hgs
parents:
diff changeset
   123
hgs
parents:
diff changeset
   124
NONSHARABLE_CLASS(TRoleSwitcherState)
hgs
parents:
diff changeset
   125
	{
hgs
parents:
diff changeset
   126
public:
hgs
parents:
diff changeset
   127
	TRoleSwitcherState(CRoleSwitcherStateFactory& aFactory);
hgs
parents:
diff changeset
   128
	
hgs
parents:
diff changeset
   129
	virtual void Enter(CRoleSwitcher& aContext) const;
hgs
parents:
diff changeset
   130
	virtual void Exit(CRoleSwitcher& aContext) const;
hgs
parents:
diff changeset
   131
hgs
parents:
diff changeset
   132
	virtual void Start(CRoleSwitcher& aContext) const;
hgs
parents:
diff changeset
   133
	virtual void EventReceived(CRoleSwitcher& aContext, TBTBasebandEventNotification& aEvent) const;
hgs
parents:
diff changeset
   134
	virtual void Error(CRoleSwitcher& aContext, TInt aErr) const;
hgs
parents:
diff changeset
   135
	virtual void TimerExpired(CRoleSwitcher& aContext) const;
hgs
parents:
diff changeset
   136
hgs
parents:
diff changeset
   137
protected:
hgs
parents:
diff changeset
   138
	// Exits old state, sets the new state, and enters it.
hgs
parents:
diff changeset
   139
	void ChangeState(CRoleSwitcher& aContext, CRoleSwitcherStateFactory::TRoleSwitcherStates aState) const;
hgs
parents:
diff changeset
   140
	void PanicInState(TLinkPanic aPanic) const;
hgs
parents:
diff changeset
   141
	
hgs
parents:
diff changeset
   142
protected:
hgs
parents:
diff changeset
   143
	CRoleSwitcherStateFactory& iFactory;
hgs
parents:
diff changeset
   144
#ifdef __FLOG_ACTIVE
hgs
parents:
diff changeset
   145
	TBuf<48> iName;
hgs
parents:
diff changeset
   146
#endif
hgs
parents:
diff changeset
   147
	};
hgs
parents:
diff changeset
   148
hgs
parents:
diff changeset
   149
hgs
parents:
diff changeset
   150
//--------------------------------------------------
hgs
parents:
diff changeset
   151
// STATES 
hgs
parents:
diff changeset
   152
//--------------------------------------------------
hgs
parents:
diff changeset
   153
hgs
parents:
diff changeset
   154
NONSHARABLE_CLASS(TRSStateIdle) : public TRoleSwitcherState
hgs
parents:
diff changeset
   155
	{
hgs
parents:
diff changeset
   156
public:
hgs
parents:
diff changeset
   157
	TRSStateIdle(CRoleSwitcherStateFactory& aFactory);
hgs
parents:
diff changeset
   158
hgs
parents:
diff changeset
   159
	virtual void Enter(CRoleSwitcher& aContext) const;
hgs
parents:
diff changeset
   160
	virtual void Start(CRoleSwitcher& aContext) const;
hgs
parents:
diff changeset
   161
	};
hgs
parents:
diff changeset
   162
hgs
parents:
diff changeset
   163
hgs
parents:
diff changeset
   164
NONSHARABLE_CLASS(TRSStateDisablingLPM) : public TRoleSwitcherState
hgs
parents:
diff changeset
   165
	{
hgs
parents:
diff changeset
   166
public:
hgs
parents:
diff changeset
   167
	TRSStateDisablingLPM(CRoleSwitcherStateFactory& aFactory);
hgs
parents:
diff changeset
   168
hgs
parents:
diff changeset
   169
	virtual void Enter(CRoleSwitcher& aContext) const;
hgs
parents:
diff changeset
   170
	virtual void EventReceived(CRoleSwitcher& aContext, TBTBasebandEventNotification& aEvent) const;
hgs
parents:
diff changeset
   171
	};
hgs
parents:
diff changeset
   172
hgs
parents:
diff changeset
   173
NONSHARABLE_CLASS(TRSStateDisablingEncryption) : public TRoleSwitcherState
hgs
parents:
diff changeset
   174
	{
hgs
parents:
diff changeset
   175
public:
hgs
parents:
diff changeset
   176
	TRSStateDisablingEncryption(CRoleSwitcherStateFactory& aFactory);
hgs
parents:
diff changeset
   177
hgs
parents:
diff changeset
   178
	virtual void Enter(CRoleSwitcher& aContext) const;
hgs
parents:
diff changeset
   179
	virtual void EventReceived(CRoleSwitcher& aContext, TBTBasebandEventNotification& aEvent) const;
hgs
parents:
diff changeset
   180
	virtual void TimerExpired(CRoleSwitcher& aContext) const;
hgs
parents:
diff changeset
   181
	};
hgs
parents:
diff changeset
   182
hgs
parents:
diff changeset
   183
NONSHARABLE_CLASS(TRSStateChangingRole) : public TRoleSwitcherState
hgs
parents:
diff changeset
   184
	{
hgs
parents:
diff changeset
   185
public:
hgs
parents:
diff changeset
   186
	TRSStateChangingRole(CRoleSwitcherStateFactory& aFactory);
hgs
parents:
diff changeset
   187
hgs
parents:
diff changeset
   188
	virtual void Enter(CRoleSwitcher& aContext) const;
hgs
parents:
diff changeset
   189
	virtual void EventReceived(CRoleSwitcher& aContext, TBTBasebandEventNotification& aEvent) const;
hgs
parents:
diff changeset
   190
	virtual void TimerExpired(CRoleSwitcher& aContext) const;
hgs
parents:
diff changeset
   191
	};
hgs
parents:
diff changeset
   192
hgs
parents:
diff changeset
   193
NONSHARABLE_CLASS(TRSStateChangingRoleWithEPR) : public TRoleSwitcherState
hgs
parents:
diff changeset
   194
	{
hgs
parents:
diff changeset
   195
public:
hgs
parents:
diff changeset
   196
	TRSStateChangingRoleWithEPR(CRoleSwitcherStateFactory& aFactory);
hgs
parents:
diff changeset
   197
hgs
parents:
diff changeset
   198
	virtual void Enter(CRoleSwitcher& aContext) const;
hgs
parents:
diff changeset
   199
	virtual void EventReceived(CRoleSwitcher& aContext, TBTBasebandEventNotification& aEvent) const;
hgs
parents:
diff changeset
   200
	virtual void TimerExpired(CRoleSwitcher& aContext) const;
hgs
parents:
diff changeset
   201
	};
hgs
parents:
diff changeset
   202
hgs
parents:
diff changeset
   203
NONSHARABLE_CLASS(TRSStateEnablingEncryption) : public TRoleSwitcherState
hgs
parents:
diff changeset
   204
	{
hgs
parents:
diff changeset
   205
public:
hgs
parents:
diff changeset
   206
	TRSStateEnablingEncryption(CRoleSwitcherStateFactory& aFactory);
hgs
parents:
diff changeset
   207
hgs
parents:
diff changeset
   208
	virtual void Enter(CRoleSwitcher& aContext) const;
hgs
parents:
diff changeset
   209
	virtual void Exit(CRoleSwitcher& aContext) const;   
hgs
parents:
diff changeset
   210
	virtual void EventReceived(CRoleSwitcher& aContext, TBTBasebandEventNotification& aEvent) const;
hgs
parents:
diff changeset
   211
	virtual void TimerExpired(CRoleSwitcher& aContext) const;
hgs
parents:
diff changeset
   212
	};
hgs
parents:
diff changeset
   213
hgs
parents:
diff changeset
   214
#ifdef __FLOG_ACTIVE
hgs
parents:
diff changeset
   215
#define STATENAME(x)  iName=_L(x)
hgs
parents:
diff changeset
   216
#else
hgs
parents:
diff changeset
   217
#define STATENAME(x)
hgs
parents:
diff changeset
   218
#endif
hgs
parents:
diff changeset
   219
hgs
parents:
diff changeset
   220
inline TBTBasebandRole CRoleSwitcher::RequestedRole() const
hgs
parents:
diff changeset
   221
	{
hgs
parents:
diff changeset
   222
	return iRole;
hgs
parents:
diff changeset
   223
	}
hgs
parents:
diff changeset
   224
hgs
parents:
diff changeset
   225
inline TBool CRoleSwitcher::IsEncryptionDisabledForRoleSwitch() const
hgs
parents:
diff changeset
   226
	{
hgs
parents:
diff changeset
   227
	return iIsEncryptionDisabledForRoleSwitch;
hgs
parents:
diff changeset
   228
	}
hgs
parents:
diff changeset
   229
hgs
parents:
diff changeset
   230
#endif /* ROLESWITCHHELPER_H */