bthci/bthci2/hctl/interface/HctlPowerInterface.h
changeset 0 29b1cd4cb562
equal deleted inserted replaced
-1:000000000000 0:29b1cd4cb562
       
     1 // Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // under the terms of "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 //
       
    15 
       
    16 /**
       
    17  @file
       
    18  @publishedPartner
       
    19  @released
       
    20 */
       
    21 
       
    22 #ifndef HCTLPOWERINTERFACE_H
       
    23 #define HCTLPOWERINTERFACE_H
       
    24 
       
    25 #include <bluetooth/hci/hcitypes.h>		// for TBTPowerState
       
    26 
       
    27 /**
       
    28 The UID of the power interface.
       
    29 */
       
    30 const TInt KHCTLPowerInterfaceUid = 0x102797ab;
       
    31 
       
    32 /**
       
    33 Mixin for the power interface.
       
    34 
       
    35 This interface is to be accessable via the core HCTL plugin API.
       
    36 @see CHCTLBase::Interface(TUid)
       
    37 
       
    38 It provides an example route by which the Core HCI could tell the HCTL to
       
    39 make controller power state requests.
       
    40 */ 
       
    41 class MHCTLPowerInterface
       
    42 	{
       
    43 public:
       
    44 	/**
       
    45 	Request snap shot of current power state
       
    46 	
       
    47 	@param aPowerState On/Off @see TBTPowerState
       
    48 	@return Error Code
       
    49 	*/
       
    50 	virtual TInt MhpiGetPower(TBTPowerState& aPowerState) = 0;
       
    51 
       
    52 	/**
       
    53 	Request change to power state
       
    54 	
       
    55 	@param aPowerState On/Off @see TBTPowerState
       
    56 	@return Error Code
       
    57 	*/
       
    58 	virtual TInt MhpiSetPower(TBTPowerState aPowerState) = 0;
       
    59 	};
       
    60 
       
    61 #endif //HCTLPOWERINTERFACE_H