wmwavepdd.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 may only be used or
 * copied in accordance with the terms of the Wolfson Microelectronic plc's
 * non-disclosure agreement (NDA). 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 the NDA, 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: WMWavepdd.h 2468 2005-11-29 13:03:53Z fb $
 *
 * The PDD (Platform Dependent Driver) is responsible for
 * communicating with the audio circuit to start and stop playback
 * and/or recording and initialize and deinitialize the circuits.
 *
 * Warning:
 *  This driver is specifically written for Wolfson Codecs. It is not a 
 *  general CODEC device driver.
 *
 *---------------------------------------------------------------------------*/
#ifndef __WMWAVEPDD_H__
#define __WMWAVEPDD_H__

/*
 * Include files
 */

/*
 * Definitions
 */

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

/*-----------------------------------------------------------------------------
 * Function:    PmControlMessage
 *
 * Handles power managment IOCTL messages.
 *
 * Parameters:
 *		dwCode	    I/0 control code for the function to support. 
 *                  The following IOCTLs are supported:
 *                  IOCTL_POWER_CAPABILITIES
 *                  IOCTL_POWER_QUERY
 *                  IOCTL_POWER_SET
 *                  IOCTL_POWER_GET
 *     pBufIn       Pointer to the input structure.
 *     dwLenIn      Specifies the size, in bytes, of the input structure.
 *     pBufOut      Pointer to the output structure.
 *     dwLenOut     Specifies the size, in bytes, of the output structure.
 *     pdwActualOut Number of bytes passed back in the pBufOut buffer.
 *
 * Returns:     BOOL
 *		TRUE indicates success. FALSE indicates failure
 *---------------------------------------------------------------------------*/
BOOL PmControlMessage ( DWORD  dwCode,
                        PBYTE  pBufIn,
                        DWORD  dwLenIn,
                        PBYTE  pBufOut,
                        DWORD  dwLenOut,
                        PDWORD pdwActualOut
                      );

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

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