wm97power.h

pxa270平台 windows mobile 5.2 wm9713 触摸屏+音频驱动

/*-----------------------------------------------------------------------------
 * Copyright (c) Wolfson Microelectronics plc.  All rights reserved.
 *
 * This software as well as any related documentation is furnished under 
 * license and may only be used or copied in accordance with the terms of the 
 * license. The information in this file is furnished for informational use 
 * only, is subject to change without notice, and should not be construed as 
 * a commitment by Wolfson Microelectronics plc. Wolfson Microelectronics plc
 * assumes no responsibility or liability for any errors or inaccuracies that
 * may appear in this document or any software that may be provided in
 * association with this document. 
 *
 * Except as permitted by such license, no part of this document may be 
 * reproduced, stored in a retrieval system, or transmitted in any form or by 
 * any means without the express written consent of Wolfson Microelectronics plc. 
 *
 * $Id: WM97Power.h 3998 2006-10-03 13:00:37Z fb $
 *
 * This file contains functionality for controlling power on AC97 codecs.
 *
 * Warning:
 *  This driver is specifically written for Wolfson Codecs. It is not a 
 *  general CODEC device driver.
 *
 *---------------------------------------------------------------------------*/
#ifndef __WM97POWER_H__
#define __WM97POWER_H__

/*
 * Include files
 */

/*
 * Definitions
 */

/*
 * Function prototypes
 */
#ifdef __cplusplus
extern "C" {
#endif

/*
 * Only provide these if we're supporting Wolfson AC97 devices.
 */
#if WM_AC97

/*-----------------------------------------------------------------------------
 * Function:    WM97PowerInit
 *
 * Initalise the driver in a low power state.
 *
 * Parameters:
 *      hDevice             handle to the device (from WMOpenDevice)
 *      driverId            The device ID (e.g. WM_DRIVER_TOUCH)
 *
 * Returns:     WMSTATUS
 *        See WMStatus.h.
 *---------------------------------------------------------------------------*/
WMSTATUS WM97PowerInit( WM_DEVICE_HANDLE  hDevice,
                        WM_DRIVER_ID      driverId
                      );

/*-----------------------------------------------------------------------------
 * Function:    WM97PowerUp
 *
 * Called to power up the specific sections of the chip on behalf of this
 * driver.
 *
 * Parameters:
 *      hDevice             handle to the device (from WMOpenDevice)
 *      driverId               The device ID (e.g. WM_DRIVER_TOUCH)
 *      powerSections       The sections to power up.
 *
 * Returns:     WMSTATUS
 *        See WMStatus.h.
 *---------------------------------------------------------------------------*/
WMSTATUS WM97PowerUp( WM_DEVICE_HANDLE  hDevice,
                      WM_DRIVER_ID      driverId,
                      WM_POWERFLAG      powerSections
                    );

/*-----------------------------------------------------------------------------
 * Function:    WM97PowerDown
 *
 * Called to power down the specific sections of the chip on behalf of this
 * driver.  Note if the driver can tell that the sections are still in use
 * by another driver they will not actually be powered down.
 *
 * Parameters:
 *      hDevice             handle to the device (from WMOpenDevice)
 *      driverId               The device ID (e.g. WM_DRIVER_TOUCH)
 *      powerSections       The sections to power down.
 *
 * Returns:     WMSTATUS
 *      See WMStatus.h.
 *---------------------------------------------------------------------------*/
WMSTATUS WM97PowerDown( WM_DEVICE_HANDLE	hDevice,
                        WM_DRIVER_ID        driverId,
                        WM_POWERFLAG        powerSections
                      );

/*-----------------------------------------------------------------------------
 * Function:    WM97GetCurrentPower
 *
 * Returns the current power state by looking at the register.
 *
 * Parameters:
 *      hDevice             handle to the device (from WMOpenDevice)
 *
 * Returns:     WM_POWERFLAG
 *      The current power state.
 *---------------------------------------------------------------------------*/
WM_POWERFLAG WM97GetCurrentPower( WM_DEVICE_HANDLE hDevice );

#endif /* WM_AC97 */

#ifdef __cplusplus
}   /* extern "C" */
#endif

#endif  /* __WM97POWER_H__ */
/*------------------------------ END OF FILE ---------------------------------*/