backlight.h

freescale i.mx31 BSP CE5.0全部源码

//------------------------------------------------------------------------------
//
//  Copyright (C) 2005, Freescale Semiconductor, Inc. All Rights Reserved
//  THIS SOURCE CODE IS CONFIDENTIAL AND PROPRIETARY AND MAY NOT
//  BE USED OR DISTRIBUTED WITHOUT THE WRITTEN PERMISSION OF
//  Freescale Semiconductor, Inc.
//
//------------------------------------------------------------------------------
//
// Copyright (C) 2003-2004, MOTOROLA, INC. All Rights Reserved
// THIS SOURCE CODE IS CONFIDENTIAL AND PROPRIETARY AND MAY NOT
// BE USED OR DISTRIBUTED WITHOUT THE WRITTEN PERMISSION OF
// MOTOROLA, INC.
//
// Copyright (C) 2005, Freescale Semiconductor, Inc. All Rights Reserved
// THIS SOURCE CODE IS CONFIDENTIAL AND PROPRIETARY AND MAY NOT
// BE USED OR DISTRIBUTED WITHOUT THE WRITTEN PERMISSION OF
// FREESCALE SEMICONDUCTOR, INC.
//
//  File:		backlight.h
//  Purpose:	Definitions for backlight driver module
//
//  Notes:
//
//------------------------------------------------------------------------------


#ifndef _BACKLIGHT_H
#define _BACKLIGHT_H

//------------------------------------------------------------------------------
// MACRO DEFINITIONS 

#ifdef DEBUG
#define BKL_DEBUG_MSG	0
#define BKL_ERROR_MSG	0
#endif

// Default backlight timeout in sec
#define BKL_DEFAULT_TIMEOUT		(60)	// sec

// Backlight levels
#define BKL_LEVEL_MIN			(0)		// off
#define BKL_LEVEL_MAX           (15)   // full on
#define BKL_LEVEL_DEFAULT		((BKL_LEVEL_MAX - BKL_LEVEL_MIN) / 2)

// Registry to Backlight Control Panel settings
#define REG_PATH        			TEXT("ControlPanel\\Backlight")

// Microsoft timeout settings
#define BATT_TIMEOUT_SUBKEY			TEXT("BatteryTimeout")
#define AC_TIMEOUT_SUBKEY			TEXT("ACTimeout")

// Power Class
#define POWER_CLASS_SUBKEY 			TEXT("IClass")

#if (!defined(PPC) && !defined(TPC))
// Microsoft enable backlight time out registry from WinCE 
// advanced backlight dialog
#define BATT_USEBATT_SUBKEY			TEXT("UseBattery")
#define AC_USEEXT_SUBKEY			TEXT("UseExt")
#endif

// OEM backlight level settings
#define BATT_LEVEL_SUBKEY			TEXT("BattBacklightLevel")
#define AC_LEVEL_SUBKEY				TEXT("ACBacklightLevel")

// Registry to Power Manager's user activity indicator event
#define USER_ACTIVITY_EVENT_REG_PATH	L"SYSTEM\\GWE"
#define USER_ACTIVITY_EVENT_KEY			L"ActivityEvent"

//------------------------------------------------------------------------------
// ENUMERATIONS AND STRUCTURES 

#ifdef __cplusplus
extern "C" {
#endif

typedef struct _bklSettings {
	DWORD	dwBattTimeout;	// in sec
	DWORD	dwACTimeout;		// in sec
	BOOL	fBattTimeoutEnable;	// 0 false, 1 true
	BOOL	fACTimeoutEnable;	// 0 false, 1 true
	BOOL	fBattBacklightOnUser;	// 1 enable backlight on user activity
	BOOL	fACBacklightOnUser; // 1 enable backlight on user activity
	DWORD	dwBattBacklightLevel;
	DWORD	dwACBacklightLevel;
} bklSettings_t;
	
// ids of events waited on by interrupt thread
typedef enum _bklWaitEvents {
	bklControlPanelEvent,
	bklPowerNotificationEvent,
	bklUserActivityExistEvent,
	bklLevelChangeEvent,
	bklMaxWaitEvents,
} bklWaitEvent_c;

// backlight specific error codes
typedef enum _bklErrRegOpen {
	bklErrNone,
	bklErrRegOpen,
	bklErrGetBattTimeout,
	bklErrGetACTimeout,
	bklErrGetBattTimeoutEn,
	bklErrGetACTimeoutEn,
	bklErrGetBattOnUserEn,
	bklErrGetACOnUserEn,
	bklErrGetBattLevel,
	bklErrGetACLevel,
} bklErr_c;


#ifdef __cplusplus
	}
#endif

#endif // _BACKLIGHT_H