wmi2saudio.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: WMI2SAudio.h 2112 2005-08-31 18:25:18Z ian $
 *
 * This file contains platform-independent routines for controlling
 * audio on Wolfson I2S codecs.
 *
 * Warning:
 *  This driver is specifically written for Wolfson Codecs. It is not a 
 *  general CODEC device driver.
 *
 *---------------------------------------------------------------------------*/
#ifndef __WMI2SAUDIO_H__
#define __WMI2SAUDIO_H__

/*
 * Include files
 */

/*
 * Definitions
 */

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

/*
 * Only provide these if we're doing audio support for WMI2S devices.
 */
#if WM_AUDIO && WMI2S_FAMILY

/*-----------------------------------------------------------------------------
 * Function:    WMI2SEnableStream
 *
 * Called to enable the device to handle the given stream.  This configures
 * the interface and sets the sample rate according to the default values.
 *
 * Parameters:
 *      hDevice         handle to the device (from WMOpenDevice)
 *      stream          The stream to enable
 *
 * Returns:     WMSTATUS
 *      See WMStatus.h.
 *---------------------------------------------------------------------------*/
WMSTATUS WMI2SEnableStream( WM_DEVICE_HANDLE hDevice,
							WM_STREAM_ID     stream
						  );

/*-----------------------------------------------------------------------------
 * Function:    WMI2SDisableStream
 *
 * Called to disable the given stream. This unconfigures the interface.
 *
 * Parameters:
 *      hDevice         handle to the device (from WMOpenDevice)
 *      stream          The stream to enable
 *
 * Returns:     WMSTATUS
 *      See WMStatus.h.
 *---------------------------------------------------------------------------*/
WMSTATUS WMI2SDisableStream( WM_DEVICE_HANDLE hDevice,
							 WM_STREAM_ID     stream
						   );

/*-----------------------------------------------------------------------------
 * Function:    WMI2SSetSampleRate
 *
 * Called to set the sample rate in the audio-specific sections of the chip. 
 *
 * Parameters:
 *      hDevice      handle to the device (from WMOpenDevice)
 *      stream       The stream for which to set the sample rate
 *      sampleRate   The new sample rate.
 *
 * Returns:     WMSTATUS
 *       See WMStatus.h.
 *---------------------------------------------------------------------------*/
WMSTATUS WMI2SSetSampleRate( WM_DEVICE_HANDLE hDevice,
							 WM_STREAM_ID     stream, 
							 WM_SAMPLE_RATE   sampleRate
						   );

/*-----------------------------------------------------------------------------
 * Function:    WMI2SGetSampleRate
 *
 * Returns the sample rate in the audio-specific sections of the chip. 
 *
 * Parameters:
 *      hDevice      handle to the device (from WMOpenDevice)
 *      stream       The stream for which to get the sample rate
 *      pSampleRate  Variable to receive the sample rate
 *
 * Returns:     WMSTATUS
 *       See WMStatus.h.
 *---------------------------------------------------------------------------*/
WMSTATUS WMI2SGetSampleRate( WM_DEVICE_HANDLE hDevice,
							 WM_STREAM_ID     stream, 
							 WM_SAMPLE_RATE   *pSampleRate
						   );

#endif  /* WM_AUDIO && WMI2S_FAMILY */

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

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