epoc32/include/assp/omap3530_shared/omap3_mstick.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 // Copyright (c) 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 the License "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 // omap3530/shared/mstick/omap3_mstick.h
    15 //
    16 
    17 #ifndef OMAP3_MSTICK_H
    18 #define OMAP3_MSTICK_H
    19 
    20 #include <e32cmn.h>
    21 
    22 namespace Omap3
    23 {
    24 	namespace MsTick
    25 	{
    26 	/** Start the millisecond timer counting, call from Init3 stage of ASSP */
    27 	IMPORT_C TInt Start();
    28 
    29 	/** Start idle tick supression
    30 	 * @param	aMaxSleepTicks	Maximum number of ticks to sleep for
    31 	 * @return	If >0 the number of ticks that will be suppressed (could be < aMaxSleepTicks)
    32 	 * @return	If ==0 supression was not enabled
    33 	 */
    34 	IMPORT_C TInt SuppressIdleTicks( TInt aMaxSleepTicks );
    35 
    36 	/** End idle supression and restore tick timer to normal operation
    37 	 *
    38 	 * @param	aMaxSleepTicks	Original maximum number of ticks passed to SuppressIdleTicks()
    39 	 * @return	Actual number of ticks since SuppressIdleTickw() was called
    40 	 */
    41 	IMPORT_C TInt EndIdleTickSuppression( TInt aMaxSleepTicks );
    42 	}	// namespace MsTick
    43 }	// namespace Omap3
    44 
    45 
    46 
    47 #endif // define OMAP3_MSTICK_H
    48 
    49