backlight.h

Microsoft WinCE 6.0 BSP FINAL release source code for use with the i.MX27ADS TO2 WCE600_FINAL_MX27_S

//------------------------------------------------------------------------------
//
// Copyright (c) Microsoft Corporation.  All rights reserved.
//
//
// Use of this source code is subject to the terms of the Microsoft end-user
// license agreement (EULA) under which you licensed this SOFTWARE PRODUCT.
// If you did not accept the terms of the EULA, you are not authorized to use
// this source code. For a copy of the EULA, please see the LICENSE.RTF on your
// install media.
//
//------------------------------------------------------------------------------
//
// Copyright (C) 2006, Freescale Semiconductor, Inc. All Rights Reserved.
// THIS SOURCE CODE, AND ITS USE AND DISTRIBUTION, IS SUBJECT TO THE TERMS
// AND CONDITIONS OF THE APPLICABLE LICENSE AGREEMENT 
//
//------------------------------------------------------------------------------
//
//  Header:  backlight.h
//
//  Provides definitions for backlight driver on MX27 reference platform.
//
//------------------------------------------------------------------------------
 
#ifndef _DRIVERS_BACKLIGHT_BACKLIGHT_H
#define _DRIVERS_BACKLIGHT_BACKLIGHT_H

//------------------------------------------------------------------------------
// MACRO DEFINITIONS 
//------------------------------------------------------------------------------
#define BKL_FUNCTION_ENTRY() \
    DEBUGMSG(ZONE_FUNCTION, (TEXT("++%s\r\n"), __WFUNCTION__))
#define BKL_FUNCTION_EXIT() \
    DEBUGMSG(ZONE_FUNCTION, (TEXT("--%s\r\n"), __WFUNCTION__))
    
#define ZONE_INFO           DEBUGZONE(0)
#define ZONE_FUNCTION       DEBUGZONE(1)
#define ZONE_WARN           DEBUGZONE(2)
#define ZONE_ERROR          DEBUGZONE(3)
#define ZONE_INIT           DEBUGZONE(4)

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

// Backlight levels
#define BKL_LEVEL_MIN           (0)     // off
#define BKL_LEVEL_MAX           (255)   // 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")

#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")

//------------------------------------------------------------------------------
// 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,
    bklUserInactivityEvent,
    bklLevelChangeEvent,
    bklMaxWaitEvents,
} bklWaitEvent_c;

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

//------------------------------------------------------------------------------
// FUNCTION PROTOTYPES
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
// EXTERN DECLARATIONS
//------------------------------------------------------------------------------

#ifdef __cplusplus
    }
#endif
//------------------------------------------------------------------------------
// CLASS DEFINITIONS
//------------------------------------------------------------------------------

#endif /* _DRIVERS_BACKLIGHT_BACKLIGHT_H */

//------------------------------------------------------------------------------
// END OF FILE
//------------------------------------------------------------------------------