wmplatformtests.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: WMPlatformTests.h 1567 2005-04-15 14:41:19Z fb $
 *
 * Tests for the WMAudio interfaces which hit platform registers directly.
 *
 *
 * Warning:
 *  This driver is specifically written for Wolfson Codecs. It is not a 
 *  general CODEC device driver.
 *
 * ---------------------------------------------------------------------------*/
#ifndef __WMPLATFORMTESTS_H__
#define __WMPLATFORMTESTS_H__

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

/*
 * Only build this if we are asked to.
 */

/*
 * Global definitions
 */

/*
 * Private data
 */

/*
 * Function prototypes
 */
#ifdef __cplusplus
extern "C" {
#endif
/*-----------------------------------------------------------------------------
 * Function:    WMTestPlatformAudio
 *
 * Wolfson platform audio tests - plays sound via the various DACs hitting the 
 * platform registers directly.
 *
 * Parameters:
 *      hDevice     handle to the device (from WMOpenDevice)
 *
 * Returns:     WM_BOOL
 *      TRUE if it passed, FALSE if it failed in a way it could detect.
 *---------------------------------------------------------------------------*/
WM_BOOL WMTestPlatformAudio( WM_DEVICE_HANDLE hDevice );

/*-----------------------------------------------------------------------------
 * Function:    WMTestHiFiDACDirect
 *
 * Plays a sound directly to the HIFI DAC, hitting the controller registers
 * directly (i.e. not using DMA).
 *
 * Parameters:
 *      hDevice     handle to the device (from WMOpenDevice)
 *
 * Returns:     WM_BOOL
 *      TRUE if it passed, FALSE if it failed in a way it could detect.
 *---------------------------------------------------------------------------*/
WM_BOOL WMTestHiFiDACDirect( WM_DEVICE_HANDLE hDevice );

/*-----------------------------------------------------------------------------
 * Function:    WMTestMonoDACDirect
 *
 * Plays a sound directly to the Mono DAC, hitting the controller registers
 * directly (i.e. not using DMA).
 *
 * Parameters:
 *      hDevice     handle to the device (from WMOpenDevice)
 *
 * Returns:     WM_BOOL
 *      TRUE if it passed, FALSE if it failed in a way it could detect.
 *---------------------------------------------------------------------------*/
WM_BOOL WMTestMonoDACDirect( WM_DEVICE_HANDLE hDevice );

/*-----------------------------------------------------------------------------
 * Function:    WMTestVoiceDACDirect
 *
 * Plays a sound directly to the Voice DAC, hitting the controller registers
 * directly (i.e. not using DMA).
 *
 * Parameters:
 *      hDevice     handle to the device (from WMOpenDevice)
 *
 * Returns:     WM_BOOL
 *      TRUE if it passed, FALSE if it failed in a way it could detect.
 *---------------------------------------------------------------------------*/
WM_BOOL WMTestVoiceDACDirect( WM_DEVICE_HANDLE hDevice );

/*-----------------------------------------------------------------------------
 * Function:    WMTestHiFiDACDMADirect
 *
 * Plays a sound directly to the HIFI DAC, using direct control of the
 * DMA buffers.
 *
 * Parameters:
 *      hDevice     handle to the device (from WMOpenDevice)
 *
 * Returns:     WM_BOOL
 *      TRUE if it passed, FALSE if it failed in a way it could detect.
 *---------------------------------------------------------------------------*/
WM_BOOL WMTestHiFiDACDMADirect( WM_DEVICE_HANDLE hDevice );

/*-----------------------------------------------------------------------------
 * Function:    WMTestMonoDACDMADirect
 *
 * Plays a sound directly to the Mono (AUX) DAC, using direct control of the
 * DMA buffers.
 *
 * Parameters:
 *      hDevice     handle to the device (from WMOpenDevice)
 *
 * Returns:     WM_BOOL
 *      TRUE if it passed, FALSE if it failed in a way it could detect.
 *---------------------------------------------------------------------------*/
WM_BOOL WMTestMonoDACDMADirect( WM_DEVICE_HANDLE hDevice );

/*-----------------------------------------------------------------------------
 * Function:    WMTestVoiceDACDMADirect
 *
 * Plays a sound directly to the Voice DAC, using direct control of the
 * DMA buffers.
 *
 * Parameters:
 *      hDevice     handle to the device (from WMOpenDevice)
 *
 * Returns:     WM_BOOL
 *      TRUE if it passed, FALSE if it failed in a way it could detect.
 *---------------------------------------------------------------------------*/
WM_BOOL WMTestVoiceDACDMADirect( WM_DEVICE_HANDLE hDevice );

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

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