MIC_StopAutoSampling

Syntax

#include <nitro/spi.h>
MICResult MIC_StopAutoSampling( void );

Arguments

None.

Return Values

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

Description

Stops microphone auto-sampling. The function issues a request to ARM7 to stop auto-sampling, waits for ARM7 to respond and returns the process result. This is the synchronous version of the MIC_StopAutoSamplingAsync function.

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.

Note

This function waits for a PXI interrupt for synchronization purposes. Do not call it when PXI interrupts are prohibited.

See Also

MIC_StopAutoSamplingAsync
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/03/08 Standardized the Japanese notation of the term for "interrupt."
2005/01/11 Revised Return Values and added functions to See Also.
2004/06/01 Initial version.


CONFIDENTIAL