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.
williamr@4
     1
// Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@4
     2
// All rights reserved.
williamr@4
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of the License "Eclipse Public License v1.0"
williamr@4
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4
     7
//
williamr@4
     8
// Initial Contributors:
williamr@4
     9
// Nokia Corporation - initial contribution.
williamr@4
    10
//
williamr@4
    11
// Contributors:
williamr@4
    12
//
williamr@4
    13
// Description:
williamr@4
    14
// omap3530/shared/mstick/omap3_mstick.h
williamr@4
    15
//
williamr@4
    16
williamr@4
    17
#ifndef OMAP3_MSTICK_H
williamr@4
    18
#define OMAP3_MSTICK_H
williamr@4
    19
williamr@4
    20
#include <e32cmn.h>
williamr@4
    21
williamr@4
    22
namespace Omap3
williamr@4
    23
{
williamr@4
    24
	namespace MsTick
williamr@4
    25
	{
williamr@4
    26
	/** Start the millisecond timer counting, call from Init3 stage of ASSP */
williamr@4
    27
	IMPORT_C TInt Start();
williamr@4
    28
williamr@4
    29
	/** Start idle tick supression
williamr@4
    30
	 * @param	aMaxSleepTicks	Maximum number of ticks to sleep for
williamr@4
    31
	 * @return	If >0 the number of ticks that will be suppressed (could be < aMaxSleepTicks)
williamr@4
    32
	 * @return	If ==0 supression was not enabled
williamr@4
    33
	 */
williamr@4
    34
	IMPORT_C TInt SuppressIdleTicks( TInt aMaxSleepTicks );
williamr@4
    35
williamr@4
    36
	/** End idle supression and restore tick timer to normal operation
williamr@4
    37
	 *
williamr@4
    38
	 * @param	aMaxSleepTicks	Original maximum number of ticks passed to SuppressIdleTicks()
williamr@4
    39
	 * @return	Actual number of ticks since SuppressIdleTickw() was called
williamr@4
    40
	 */
williamr@4
    41
	IMPORT_C TInt EndIdleTickSuppression( TInt aMaxSleepTicks );
williamr@4
    42
	}	// namespace MsTick
williamr@4
    43
}	// namespace Omap3
williamr@4
    44
williamr@4
    45
williamr@4
    46
williamr@4
    47
#endif // define OMAP3_MSTICK_H
williamr@4
    48
williamr@4
    49