MIC_StopAutoSamplingAsync

Syntax

#include <nitro/spi.h>
MICResult MIC_StopAutoSamplingAsync(
            MICCallback     callback,
            void*		arg );

Arguments

callback Specifies the pointer to the callback function. This callback is called from within the interrupt handler.
arg Argument to pass to the callback function.

Return Values

Returns the processing result as a MICResult enumerated type. Returns MIC_RESULT_SUCCESS if the asynchronous process starts normally, and some other value if the process fails for some reason.

Description

Asynchronously stops microphone auto-sampling. The function issues a request to the ARM7 to stop auto-sampling and returns control to the caller without waiting for a response. You must use the result argument passed by the user callback function to get the ARM7 processing result. If this function fails, the asynchronous operation is not performed and the user callback function is not called.

This function returns MIC_RESULT_INVALID_COMMAND when the CODEC is running in CODEC-TWL mode because auto-sampling cannot be run at an arbitrary frequency in CODEC-TWL mode. In other words, this function can only be used when the CODEC is running in CODEC-DS mode.

See Also

MIC_StopAutoSampling
MIC_StartAutoSampling
MIC_AdjustAutoSampling

Revision History

2009/05/14 Added the TWL icon and a description related to CODEC.
2008/01/09 Revised a description of differences in behavior due to the CODEC mode.
2007/11/17 Added a description of operations on the TWL platform.
2005/06/27 Added supplementary information stating that the callback is invoked from the interrupt handler.
2005/01/11 Revised Return Values and added functions to See Also.
2004/06/01 Initial version.


CONFIDENTIAL