wmplatformi2s.h

WM9713 audio codec driver for WinCE 5.0

/*-----------------------------------------------------------------------------
 * 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: WMPlatformI2S.h 1585 2005-04-19 11:41:25Z fb $
 *
 * Functionality for configuring and using Inter-IC Sound (I2S) audio.
 *
 * Warning:
 *  This driver is specifically written for Wolfson Codecs. It is not a 
 *  general CODEC device driver.
 *
 *---------------------------------------------------------------------------*/
#ifndef __WMPLATFORMI2S_H__
#define __WMPLATFORMI2S_H__

/*
 * Include files
 */
#include "WMStatus.h"
#include "WMDeviceContext.h"

#if WM_I2S

/*
 * Definitions
 */

/*
 * Function prototypes
 */
#ifdef __cplusplus
extern "C" {
#endif
    
/*-----------------------------------------------------------------------------
 * Function:    WMPlatformI2SInit
 *
 * Initialise the platform specific part of the I2S interface.
 *
 * Parameters:
 *      hDevice     handle to the device (from WMOpenDevice)
 *
 * Returns:     WMSTATUS
 *      See WMStatus.h
 *---------------------------------------------------------------------------*/
WMSTATUS WMPlatformI2SInit( WM_DEVICE_HANDLE hDevice );
    
/*-----------------------------------------------------------------------------
 * Function:    WMPlatformI2SShutdown
 *
 * Shutdown the I2S interface.
 *
 * Parameters:
 *      hDevice     handle to the device (from WMOpenDevice)
 *
 * Returns:     none
 *---------------------------------------------------------------------------*/
void WMPlatformI2SShutdown( WM_DEVICE_HANDLE hDevice );

/*-----------------------------------------------------------------------------
 * Function:    WMPlatformI2SSetSampleRate
 *
 * Set the sample rate for the I2S interface, when the I2S controller is the
 * master.
 *
 * Parameters:
 *      hDevice     handle to the device (from WMOpenDevice)
 *      sampleRate  the requested sample rate
 *
 * Returns:     WMSTATUS
 *       See WMStatus.h.
 *---------------------------------------------------------------------------*/
WMSTATUS WMPlatformI2SSetSampleRate( WM_DEVICE_HANDLE hDevice, 
                                     WM_SAMPLE_RATE sampleRate  
                                   );

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

#endif /* WM_I2S */

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