1.1.4.4.2 DRV_WM8904_Close Function

void DRV_WM8904_Close( DRV_Handle handle )

Summary

Closes an opened-instance of the WM8904 driver

Description

This routine closes an opened-instance of the WM8904 driver, invalidating the handle. Any buffers in the driver queue that were submitted by this client will be removed. After calling this routine, the handle passed in "handle" must not be used with any of the remaining driver routines. A new handle must be obtained by calling DRV_WM8904_Open before the caller may use the driver again

Preconditions

The DRV_WM8904_Initialize routine must have been called for the specified WM8904 driver instance.

DRV_WM8904_Open must have been called to obtain a valid opened device handle.

Parameters

ParametersDescription
handleA valid open-instance handle, returned from the driver's open routine

Returns

None.

Remarks

Usually there is no need for the driver client to verify that the Close operation has completed. The driver will abort any ongoing operations when this routine is called.

Example

DRV_HANDLE handle; _// Returned from DRV_WM8904_Open_

DRV_WM8904_Close(handle);

C

void DRV_WM8904_Close(const DRV_HANDLE handle);