wm2wirelink.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: WM2WireLink.h 1458 2005-03-22 15:13:45Z ib $
 *
 * This file contains platform-independent routines for communicating with
 * Wolfson codecs.
 *
 * Warning:
 *  This driver is specifically written for Wolfson Codecs. It is not a 
 *  general CODEC device driver.
 *
 *---------------------------------------------------------------------------*/
#ifndef __WM2WIRELINK_H__
#define __WM2WIRELINK_H__

/*
 * Include files
 */
#include "WMTypes.h"

/*
 * Definitions
 */

/* 
 * Wolfson 2 Wire Addresses
 */
#define WM_2WIRE_ADDR_1     0x1A
#define WM_2WIRE_ADDR_2     0x1B


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


/*-----------------------------------------------------------------------------
 * Function:    WM2WirePowerUp
 *
 * 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 driver ID (e.g. WM_DRIVER_TOUCH)
 *      powerSections       The sections to power up.
 *
 * Returns:     WMSTATUS
 *      See WMStatus.h.
 *---------------------------------------------------------------------------*/
WMSTATUS WM2WirePowerUp( WM_DEVICE_HANDLE   hDevice,
                         WM_DRIVER_ID       driverId,
                         WM_POWERFLAG       powerSections
                       );

/*-----------------------------------------------------------------------------
 * Function:    WM2WirePowerDown
 *
 * 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 driver ID (e.g. WM_DRIVER_TOUCH)
 *      powerSections       The sections to power down.
 *
 * Returns:     WMSTATUS
 *      See WMStatus.h.
 *---------------------------------------------------------------------------*/
WMSTATUS WM2WirePowerDown( WM_DEVICE_HANDLE     hDevice,
                           WM_DRIVER_ID         driverId,
                           WM_POWERFLAG         powerSections
                        );

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

/*-----------------------------------------------------------------------------
 * Function:    WM2WireWrite
 *
 * Write the value to the given register.
 *
 * Parameters:
 *      hDevice     handle to the device (from WMOpenDevice)
 *      reg         register to write to
 *      value       value to write
 *
 * Returns:     WMSTATUS
 *      See WMStatus.h
 *---------------------------------------------------------------------------*/
WMSTATUS WM2WireWrite( WM_DEVICE_HANDLE hDevice,
                       WM_REGTYPE reg,
                       WM_REGVAL value
                     );
                           
/*-----------------------------------------------------------------------------
 * Function:    WM2WireReset
 *
 * Reset the registers to default settings.
 *
 * Parameters:
 *      hDevice             handle to the device (from WMOpenDevice)
 *
 * Returns:     WMSTATUS
 *      See WMStatus.h.
 *---------------------------------------------------------------------------*/
WMSTATUS WM2WireReset( WM_DEVICE_HANDLE hDevice );

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

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