wminternaltests.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: WMInternalTests.h 2086 2005-08-18 08:50:08Z ian $
 *
 * There are various static functions and macros contained within files which
 * cannot be tested externally.  The way we test these is to have one or more
 * test functions in those files which test this internal code.  These functions
 * can then be called from test code in other modules (e.g. in the APITest code).
 * 
 * This file declares the various private test functions, and the main jacket
 * function which calls all the other tests.
 *
 *
 * Warning:
 *  This driver is specifically written for Wolfson Codecs. It is not a 
 *  general CODEC device driver.
 *
 * ---------------------------------------------------------------------------*/
#ifndef __WMINTERNALSTESTS_H__
#define __WMINTERNALSTESTS_H__

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

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

/*
 * Global definitions
 */

/*
 * Private data
 */

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

/*-----------------------------------------------------------------------------
 * Function:    WMTestInternals
 *
 * This is the main jacket function which calls all the other internal test
 * functions.  It should be updated every time a new internal test function is
 * written.
 *
 * Parameters:
 *      hDevice     device handle to use
 *
 * Returns:     WM_BOOL
 *      TRUE iff it worked.
 *---------------------------------------------------------------------------*/
WM_BOOL WMTestInternals( WM_DEVICE_HANDLE hDevice );

/*-----------------------------------------------------------------------------
 * Function:    WMTestAudioStreamInternals
 *
 * This function tests the internal code in WMAudioStream.c.
 *
 * Parameters:
 *      hDevice     device handle to use
 *
 * Returns:     WM_BOOL
 *      TRUE iff it worked.
 *---------------------------------------------------------------------------*/
WM_BOOL WMTestAudioStreamInternals( WM_DEVICE_HANDLE hDevice );

/*-----------------------------------------------------------------------------
 * Function:    WMTest8753Internals
 *
 * This function tests the internal code in WM8753Audio.c.
 *
 * Parameters:
 *      hDevice     device handle to use
 *
 * Returns:     WM_BOOL
 *      TRUE iff it worked.
 *---------------------------------------------------------------------------*/
WM_BOOL WMTest8753Internals( WM_DEVICE_HANDLE hDevice );

/*-----------------------------------------------------------------------------
 * Function:    WMTestPlatformInternals
 *
 * This is the main jacket function which calls all the other internal test
 * functions for the platform layer.  It should be updated every time a new
 * platform-layer internal test function is written.
 *
 * Parameters:
 *      hDevice     device handle to use
 *
 * Returns:     WM_BOOL
 *      TRUE iff it worked.
 *---------------------------------------------------------------------------*/
WM_BOOL WMTestPlatformInternals( WM_DEVICE_HANDLE hDevice );

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

#endif  /* WM_TESTING */

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