MIC_AdjustAutoSampling

Syntax

#include <nitro/spi.h>
MICResult MIC_AdjustAutoSampling( u32 rate );

Arguments

rate Sampling rate. Directly specifies ARM7 CPU timer cycles.
Can also be selected from the MICSamplingRate enumerated type.

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

Synchronously adjusts the sampling rate of the microphone's auto-sampling. This function issues an auto-sampling adjustment request to ARM7, waits for a response from ARM7, and returns the process result. This is the synchronous version of the MIC_AdjustAutoSamplingAsync function. This is only valid when auto-sampling has already begun. The CPU timer cycle is updated when the ARM7 receives the request, not earlier.

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_AdjustAutoSamplingAsync
MIC_StartAutoSampling
MIC_StopAutoSampling

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 Initial version.


CONFIDENTIAL