1 /*

     2 * Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

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

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:

    15 *

    16 */

    17 

    18 

    19 

    20 

    21 /**

    22  @file

    23  @internalTechnology 

    24 */

    25 

    26 #ifndef HWRMPRIVATECRKEYS_H

    27 #define HWRMPRIVATECRKEYS_H

    28 

    29 //  INCLUDES

    30 //#include "HWRMInternalCRKeys.h"

    31 

    32 // CONSTANTS

    33 const TUid KCRUidHWRMSettings = {0x10205043};

    34 

    35 // HWRM Settings API keys

    36 

    37 /**

    38 * Timeout in milliseconds for HWRM plugin calls. 

    39 *

    40 * Must have a positive value.

    41 */

    42 const TUint32 KHWRMPluginTimeout     = 0x00000001;

    43 

    44 /**

    45 * Stores audio server SID. All vibra profile setting checks

    46 * in all vibra calls from that client are bypassed.

    47 */

    48 const TUint32 KHWRMAudioVibraSID     = 0x00000002;

    49 

    50 /**

    51 * Stores HWRM local variation flags bitmask:

    52 * Bit 1: KHWRMInternalSettingsChargerBlockVibra

    53 */

    54 const TUint32 KHWRMInternalSettings  = 0x00000003;

    55 

    56 /** 

    57 * Defines bit 1 in KHWRMInternalSettings. 

    58 * If this bit is 1, vibra will be blocked by charger 

    59 * (I.e. all StartVibraL calls will return KErrLocked if charger is connected). 

    60 * If this bit is 0, charger doesn't affect vibra. By default this is 1.

    61 * Note when changing this value, that DOS side might have some low level vibra blocks,

    62 * which this key doesn't affect. The value should reflect those blocks if they exist.

    63 */

    64 const TInt KHWRMInternalSettingsChargerBlockVibra = 0x01;  // 2^0

    65 

    66 /** 

    67 * Defines bit 2 in KHWRMInternalSettings. 

    68 * If this bit is 1, tactile feedback vibration will be blocked by charger 

    69 * (I.e. all PulseL calls will return KErrLocked if charger is connected). 

    70 * If this bit is 0, charger doesn't affect feedback vibration. By default this is 1.

    71 * Note when changing this value, that DOS side might have some low level vibra blocks,

    72 * which this key doesn't affect. The value should reflect those blocks if they exist.

    73 */

    74 const TInt KHWRMInternalSettingsChargerBlockFeedback = 0x02;  // 2^1

    75 

    76 /** 

    77 * Defines bit 3 in KHWRMInternalSettings. 

    78 * If this bit is 1, tactile feedback vibration will be blocked by accessories 

    79 * (accessory server or other component is responsible for setting KHWRMAccessoryVibraBlocked). 

    80 * If this bit is 0, accessories do not affect feedback vibration. By default this is 1.

    81 * Note when changing this value, that DOS side might have some low level vibra blocks,

    82 * which this key doesn't affect. The value should reflect those blocks if they exist.

    83 */

    84 const TInt KHWRMInternalSettingsAccessoryBlockFeedback = 0x04;  // 2^2

    85 

    86 /** 

    87 * Defines bit 4 in KHWRMInternalSettings. 

    88 * If this bit is 1, tactile feedback vibration will be blocked by cooling off period. 

    89 * (I.e. all PulseL calls will return KErrLocked if vibra is cooling off). 

    90 * If this bit is 0, cooling off period doesn't affect vibra. By default this is 1.

    91 */

    92 const TInt KHWRMInternalSettingsCoolOffBlockFeedback = 0x08;  // 2^3

    93 

    94 /** 

    95 * Defines bit 5 in KHWRMInternalSettings. 

    96 * If this bit is 1, HWRM does not generate separate start and stop commands to control 

    97 * tactile feedback pulse requests (i.e. when client app uses PulseVibraL API), but instead

    98 * it sends new pulse command to plugin. It is hence on licensee's responsibility to control 

    99 * vibra start and stop. Licensee implementation should handle pulse requests in such a way, that

   100 * if there is ongoing vibration when pulse request arrives, pulse request should just overlap

   101 * with ongoing vibration, not to stop it. If this cannot be done, bit should be configured as 0. 

   102 * If this bit is 0, HWRM does generate start and stop commands to plugin also in case of 

   103 * PulseVibraL call as it does for StartVibraL calls. By default this is 1.

   104 */

   105 const TInt KHWRMInternalSettingsDeviceSupportsPulse = 0x10;  // 2^4

   106 

   107 

   108 /**

   109 * HWRM process priority

   110 *

   111 * Value must correspond to enumerated values in TProcessPriority enumeration.

   112 * Legal values are from the range EPriorityLow-EPriorityHigh. Default value EPriorityForeground.

   113 */

   114 const TUint32 KHWRMPriority  = 0x00000004;

   115 

   116 

   117 // MACROS

   118 // None

   119 

   120 // DATA TYPES

   121 // None

   122 

   123 // FUNCTION PROTOTYPES

   124 // None

   125 

   126 // FORWARD DECLARATIONS

   127 // None

   128 

   129 // CLASS DECLARATION

   130 // 

   131 

   132 #endif  // HWRMPRIVATECRKEYS_H

   133             

   134 // End of File