piprofiler/plugins/PWRplugin/inc/PwrPlugin.h
author hgs
Fri, 27 Aug 2010 11:37:29 +0300
changeset 42 0ff24a8f6ca2
child 49 7fdc9a71d314
permissions -rw-r--r--
201033
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
42
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). 
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#ifndef BAPPEA_PWR_SAMPLER_H
hgs
parents:
diff changeset
    19
#define BAPPEA_PWR_SAMPLER_H
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
//#define PWR_SAMPLER_BACKLIGHT
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
//#include "PIProfilerConfigInternal.h"
hgs
parents:
diff changeset
    24
hgs
parents:
diff changeset
    25
// system definitions
hgs
parents:
diff changeset
    26
#include <w32std.h>
hgs
parents:
diff changeset
    27
#include <e32std.h>
hgs
parents:
diff changeset
    28
hgs
parents:
diff changeset
    29
#include <e32property.h>
hgs
parents:
diff changeset
    30
#include <HWRMPower.h>
hgs
parents:
diff changeset
    31
#include <HWRMLight.h>
hgs
parents:
diff changeset
    32
hgs
parents:
diff changeset
    33
// user definitions
hgs
parents:
diff changeset
    34
#include <piprofiler/SamplerPluginInterface.h>
hgs
parents:
diff changeset
    35
#include <piprofiler/ProfilerGenericClassesUsr.h>
hgs
parents:
diff changeset
    36
hgs
parents:
diff changeset
    37
// caption definitions
hgs
parents:
diff changeset
    38
_LIT8(KPWRShortName, "pwr");
hgs
parents:
diff changeset
    39
_LIT8(KPWRMediumName, "Power sampler");
hgs
parents:
diff changeset
    40
_LIT8(KPWRLongName, "Power usage sampler");
hgs
parents:
diff changeset
    41
_LIT8(KPWRDescription, "Power sampler: \nSampling power consumption on Nokia S60 devices\nHW dep: N/A\nSW dep: S60 3.0\n");
hgs
parents:
diff changeset
    42
hgs
parents:
diff changeset
    43
// Minimum allowed sampling interval (in ms). 0 means undefined.
hgs
parents:
diff changeset
    44
const TInt KMinSampleInterval = 250;
hgs
parents:
diff changeset
    45
const TInt KReportingPeriodInfinite = 0;
hgs
parents:
diff changeset
    46
hgs
parents:
diff changeset
    47
const TUid KGppPropertyCat={0x20201F70};
hgs
parents:
diff changeset
    48
enum TGppPropertyKeys
hgs
parents:
diff changeset
    49
    {
hgs
parents:
diff changeset
    50
    EGppPropertySyncSampleNumber
hgs
parents:
diff changeset
    51
    };
hgs
parents:
diff changeset
    52
hgs
parents:
diff changeset
    53
const TUid KPwrNotifierUid = { 0x2001E5B9 };
hgs
parents:
diff changeset
    54
class CProfilerPowerListener;
hgs
parents:
diff changeset
    55
hgs
parents:
diff changeset
    56
/*
hgs
parents:
diff changeset
    57
 *
hgs
parents:
diff changeset
    58
 * PWR sampler plug-in definition
hgs
parents:
diff changeset
    59
 *
hgs
parents:
diff changeset
    60
 */
hgs
parents:
diff changeset
    61
hgs
parents:
diff changeset
    62
class CPwrPlugin : public CSamplerPluginInterface
hgs
parents:
diff changeset
    63
{
hgs
parents:
diff changeset
    64
public:
hgs
parents:
diff changeset
    65
    static  CPwrPlugin* NewL(const TUid aImplementationUid, TAny* aInitParams);
hgs
parents:
diff changeset
    66
            ~CPwrPlugin();
hgs
parents:
diff changeset
    67
hgs
parents:
diff changeset
    68
    TInt    ResetAndActivateL(CProfilerSampleStream& aStream);
hgs
parents:
diff changeset
    69
    TInt    StopSampling();
hgs
parents:
diff changeset
    70
    TBool   Enabled() { return iEnabled; }
hgs
parents:
diff changeset
    71
    void    SetEnabled(TBool aEnabled);
hgs
parents:
diff changeset
    72
    TInt    GetSamplerType();
hgs
parents:
diff changeset
    73
hgs
parents:
diff changeset
    74
    TInt    CreateFirstSample();
hgs
parents:
diff changeset
    75
hgs
parents:
diff changeset
    76
    void    GetAttributesL(CArrayFixFlat<TSamplerAttributes>* aAttributes);
hgs
parents:
diff changeset
    77
    TInt    SetAttributesL(TSamplerAttributes aAttributes);
hgs
parents:
diff changeset
    78
    void    InitiateSamplerAttributesL();
hgs
parents:
diff changeset
    79
hgs
parents:
diff changeset
    80
    TInt    ConvertRawSettingsToAttributes(CDesC8ArrayFlat* aSingleSettingArray);
hgs
parents:
diff changeset
    81
hgs
parents:
diff changeset
    82
    TInt    DoSetSamplerSettings(CDesC8ArrayFlat* aAllSettings, TDesC8& aSamplerName, TInt aIndex);
hgs
parents:
diff changeset
    83
    void    SaveSettingToAttributes(const TDesC8& aSetting, TInt aIndex);
hgs
parents:
diff changeset
    84
hgs
parents:
diff changeset
    85
    TUid    Id(TInt aSubId) const;
hgs
parents:
diff changeset
    86
hgs
parents:
diff changeset
    87
    // subsampler settings, i.e. samplers implemented within a plugin
hgs
parents:
diff changeset
    88
    // no sub samplers, from CSamplerPluginInterface
hgs
parents:
diff changeset
    89
    TInt    SubId(TUid aId) const {return KErrNotFound;}
hgs
parents:
diff changeset
    90
    TInt    GetSubSamplers(TDes* aDes){return KErrNotFound;}
hgs
parents:
diff changeset
    91
hgs
parents:
diff changeset
    92
private:
hgs
parents:
diff changeset
    93
            CPwrPlugin();
hgs
parents:
diff changeset
    94
    void    ConstructL();
hgs
parents:
diff changeset
    95
hgs
parents:
diff changeset
    96
private:
hgs
parents:
diff changeset
    97
    TUint8                  iVersion[20];
hgs
parents:
diff changeset
    98
    TPtr8                   iVersionDescriptor;
hgs
parents:
diff changeset
    99
hgs
parents:
diff changeset
   100
    TInt                    iSamplerType;
hgs
parents:
diff changeset
   101
hgs
parents:
diff changeset
   102
    CProfilerPowerListener* iPowerListener;
hgs
parents:
diff changeset
   103
hgs
parents:
diff changeset
   104
    TInt                    iPeriod;
hgs
parents:
diff changeset
   105
    CArrayFixFlat<TSamplerAttributes>* iSamplerAttributes;
hgs
parents:
diff changeset
   106
public:
hgs
parents:
diff changeset
   107
    TUint32*                iSampleTime;
hgs
parents:
diff changeset
   108
};
hgs
parents:
diff changeset
   109
hgs
parents:
diff changeset
   110
#ifdef PWR_SAMPLER_BACKLIGHT
hgs
parents:
diff changeset
   111
class CProfilerPowerListener : public MHWRMBatteryPowerObserver, public MHWRMLightObserver
hgs
parents:
diff changeset
   112
#else
hgs
parents:
diff changeset
   113
class CProfilerPowerListener : public MHWRMBatteryPowerObserver
hgs
parents:
diff changeset
   114
#endif
hgs
parents:
diff changeset
   115
{
hgs
parents:
diff changeset
   116
public:
hgs
parents:
diff changeset
   117
    static  CProfilerPowerListener* NewL(CPwrPlugin* aSampler);
hgs
parents:
diff changeset
   118
            ~CProfilerPowerListener();
hgs
parents:
diff changeset
   119
hgs
parents:
diff changeset
   120
private:
hgs
parents:
diff changeset
   121
            CProfilerPowerListener(CPwrPlugin* aSampler);
hgs
parents:
diff changeset
   122
    void    ConstructL();
hgs
parents:
diff changeset
   123
hgs
parents:
diff changeset
   124
public:
hgs
parents:
diff changeset
   125
    TInt    StartL(const TDesC8& aBuf);
hgs
parents:
diff changeset
   126
    TInt    Stop();
hgs
parents:
diff changeset
   127
    TInt    DisplayNotifierL(const TDesC& aLine1, const TDesC& aLine2, const TDesC& aButton1, const TDesC& aButton2);
hgs
parents:
diff changeset
   128
hgs
parents:
diff changeset
   129
    // From MHWRMBatteryPowerObserver
hgs
parents:
diff changeset
   130
    virtual void PowerMeasurement(TInt aErr, CHWRMPower::TBatteryPowerMeasurementData& aMeasurement);
hgs
parents:
diff changeset
   131
#ifdef PWR_SAMPLER_BACKLIGHT
hgs
parents:
diff changeset
   132
    // From MHWRMLightObserver
hgs
parents:
diff changeset
   133
    virtual void LightStatusChanged(TInt aTarget, CHWRMLight::TLightStatus aStatus);
hgs
parents:
diff changeset
   134
#endif
hgs
parents:
diff changeset
   135
hgs
parents:
diff changeset
   136
private:
hgs
parents:
diff changeset
   137
    void    Sample();
hgs
parents:
diff changeset
   138
hgs
parents:
diff changeset
   139
public:
hgs
parents:
diff changeset
   140
    TInt                    iPwrSamplingPeriod;
hgs
parents:
diff changeset
   141
    TInt                    iSampleStartTime;
hgs
parents:
diff changeset
   142
    // Value that is read from Central Repository and restored after sampling
hgs
parents:
diff changeset
   143
    TInt                    iOriginalReportingPeriod;
hgs
parents:
diff changeset
   144
hgs
parents:
diff changeset
   145
private:
hgs
parents:
diff changeset
   146
hgs
parents:
diff changeset
   147
#ifdef PWR_SAMPLER_BACKLIGHT
hgs
parents:
diff changeset
   148
    TUint8                  iSample[13];
hgs
parents:
diff changeset
   149
#else
hgs
parents:
diff changeset
   150
    TUint8                  iSample[12];
hgs
parents:
diff changeset
   151
#endif
hgs
parents:
diff changeset
   152
hgs
parents:
diff changeset
   153
    TUint16                 iNominalCapa;
hgs
parents:
diff changeset
   154
    TUint16                 iVoltage;
hgs
parents:
diff changeset
   155
    TUint16                 iCurrent;
hgs
parents:
diff changeset
   156
hgs
parents:
diff changeset
   157
    CPwrPlugin*             iSampler;
hgs
parents:
diff changeset
   158
    CHWRMPower*             iPowerAPI;
hgs
parents:
diff changeset
   159
hgs
parents:
diff changeset
   160
#ifdef PWR_SAMPLER_BACKLIGHT
hgs
parents:
diff changeset
   161
    CHWRMLight*             iLightAPI;
hgs
parents:
diff changeset
   162
    CHWRMLight::TLightStatus iBackLightStatus;
hgs
parents:
diff changeset
   163
#endif
hgs
parents:
diff changeset
   164
};
hgs
parents:
diff changeset
   165
hgs
parents:
diff changeset
   166
#endif
hgs
parents:
diff changeset
   167