wmplatformssp.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: WMPlatformSSP.h 1286 2005-02-21 15:24:11Z ian $
 *
 * Functionality for configuring and using Synchronous Serial Protocol (SSP)
 * serial ports.
 *
 * Warning:
 *  This driver is specifically written for Wolfson Codecs. It is not a 
 *  general CODEC device driver.
 *
 *---------------------------------------------------------------------------*/
#ifndef __WMPLATFORMSSP_H__
#define __WMPLATFORMSSP_H__

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

#if WM_AUDIO && WM_VOICE

/*
 * Definitions
 */

/*
 * Function prototypes
 */
#ifdef __cplusplus
extern "C" {
#endif
    
/*-----------------------------------------------------------------------------
 * Function:    WMPlatformSSPInit
 *
 * Initialise the platform specific part of the SSP interface.
 *
 * Parameters:
 *      hDevice     handle to the device (from WMOpenDevice)
 *
 * Returns:     none
 *---------------------------------------------------------------------------*/
void WMPlatformSSPInit( WM_DEVICE_HANDLE hDevice );
    
/*-----------------------------------------------------------------------------
 * Function:    WMPlatformSSPEnable
 *
 * Platform specific code for initialising and opening the SSP Serial Port 2
 * as a slave.
 *
 * Parameters:
 *      hDevice     handle to the device (from WMOpenDevice)
 *
 * Returns:     WMSTATUS
 *      See WMStatus.h
 *---------------------------------------------------------------------------*/
void WMPlatformSSPEnable( WM_DEVICE_HANDLE hDevice );
    
/*-----------------------------------------------------------------------------
 * Function:    WMPlatformSSPDisable
 *
 * Disable the SSP serial port.
 *
 * Parameters:
 *      hDevice     handle to the device (from WMOpenDevice)
 *
 * Returns:     none
 *---------------------------------------------------------------------------*/
void WMPlatformSSPDisable( WM_DEVICE_HANDLE hDevice );

/*-----------------------------------------------------------------------------
 * Function:    WMPlatformSSPStart
 *
 * Start the SSP serial port.
 *
 * Parameters:
 *      hDevice     handle to the device (from WMOpenDevice)
 *
 * Returns:     none
 *---------------------------------------------------------------------------*/
void WMPlatformSSPStart( WM_DEVICE_HANDLE hDevice );

/*-----------------------------------------------------------------------------
 * Function:    WMPlatformSSPStop
 *
 * Stop the SSP serial port.
 *
 * Parameters:
 *      hDevice     handle to the device (from WMOpenDevice)
 *
 * Returns:     none
 *---------------------------------------------------------------------------*/
void WMPlatformSSPStop( WM_DEVICE_HANDLE hDevice );

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

#endif /* WM_AUDIO && WM_VOICE */

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