1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<HTML>
3
4<HEAD>
5<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 8.0.0.0 for Windows">
7<META http-equiv="Content-Style-Type" content="text/css">
8<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
9<TITLE>MIC_AdjustAutoSampling</TITLE>
10</HEAD>
11
12<BODY>
13
14<H1 align="left">MIC_AdjustAutoSampling <img src="../../image/NTR.gif"><img src="../../image/TWL.gif"></H1>
15
16<H2>Syntax</H2>
17<DL>
18  <DD>
19<CODE>#include &lt;nitro/spi.h&gt;</CODE><BR>
20  <PRE><CODE><A href="MICResult.html">MICResult</A> MIC_AdjustAutoSampling( u32 rate );</CODE></PRE>
21  </DD>
22</DL>
23
24<H2>Arguments</H2>
25<TABLE border="1" width="100%">
26  <TBODY>
27    <TR>
28<TD width="300"><EM><STRONG><FONT face="Courier New">rate</FONT></STRONG></EM></TD>
29<TD width="700">Sampling rate. Directly specifies ARM7 CPU timer cycles.<br>Can also be selected from the <A href="MICSamplingRate.html"><CODE>MICSamplingRate</CODE></A> enumerated type.</TD>
30    </TR>
31  </TBODY>
32</TABLE>
33
34<H2>Return Values</H2>
35<P>
36Returns the processing result as a <A href="MICResult.html"><CODE>MICResult</CODE></A> enumerated type. Returns <CODE>MIC_RESULT_SUCCESS</CODE> if processing completes successfully, and some other value if the process fails for some reason.
37</P>
38
39<H2>Description</H2>
40<P>
41Synchronously 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 <A href="MIC_AdjustAutoSamplingAsync.html"><CODE>MIC_AdjustAutoSamplingAsync</CODE></A> 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.
42</P>
43<P>
44This function returns <CODE>MIC_RESULT_INVALID_COMMAND</CODE> 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.
45</P>
46
47<H2>Note</H2>
48<P>
49<FONT color=red>This function waits for a PXI interrupt for synchronization purposes. Do not call it when PXI interrupts are prohibited.</FONT>
50</P>
51
52<H2>See Also</H2>
53<P>
54<a href="MIC_AdjustAutoSamplingAsync.html"><CODE>MIC_AdjustAutoSamplingAsync</CODE></a><BR> <a href="MIC_StartAutoSampling.html"><CODE>MIC_StartAutoSampling</CODE></a><BR> <a href="MIC_StopAutoSampling.html"><CODE>MIC_StopAutoSampling</CODE></a>
55</P>
56
57<H2>Revision History</H2>
58<P>
592009/05/14 Added the TWL icon and a description related to CODEC. <BR>2008/01/09 Revised a description of differences in behavior due to the CODEC mode. <BR>2007/11/17 Added a description of operations on the TWL platform. <BR>2005/03/08 Standardized the Japanese notation of the term for &quot;interrupt.&quot; <br>2005/01/11 Initial version.<BR>
60</P>
61<hr><p>CONFIDENTIAL</p></body>
62</HTML>
63