pio_8h.html

BlueLab3 bluetooth API 说明文档

  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="csrtypes_8h.html#a9">bool</a> PioSetMicBiasHwEnabled           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="csrtypes_8h.html#a9">bool</a>&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>enable</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Enables/Disables the dedicated mic bias pin. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>enabled</em>&nbsp;</td><td>TRUE to enable to mic bias pin and FALSE to disable it</td></tr>
  </table>
</dl>
Returns TRUE if the mic bias pin was already enabled and FALSE if it was not.<p>
Note that the decicated mic bias pin is only present on some BlueCore variants. Only chips from BC5 onwards have this feature. In addition at least one ADC or DAC on chip must be enabled for the MicBias hardware to operate.<p>
Note that this controls the decicated mic bias pin where as "PioSetMicBias" controls the linear regulator.     </td>
  </tr>
</table>
<a class="anchor" name="a21" doxytag="pio.h::PioGetMicBiasHwEnabled" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="csrtypes_8h.html#a9">bool</a> PioGetMicBiasHwEnabled           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Gets the dedicated mic bias pin state. 
<p>
Returns TRUE if the mic bias pin is enabled and FALSE if it is not.<p>
Note that the decicated mic bias pin is only present on some BlueCore variants. Only chips from BC5 onwards have this feature.     </td>
  </tr>
</table>
<a class="anchor" name="a22" doxytag="pio.h::PioSetMicBiasHwCurrent" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="csrtypes_8h.html#a9">bool</a> PioSetMicBiasHwCurrent           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="csrtypes_8h.html#a4">uint16</a>&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>current</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Sets the current driven out through the mic bias pin. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>current</em>&nbsp;</td><td>Valid values are in the range 0..15</td></tr>
  </table>
</dl>
Returns TRUE if the value passed was within the valid range else returns FALSE.<p>
For BC5-MM the values map as follows.<p>
Value Current<p>
0 0.32 mA<p>
1 0.40 mA<p>
2 0.48 mA<p>
3 0.56 mA<p>
4 0.64 mA<p>
5 0.72 mA<p>
6 0.80 mA<p>
7 0.88 mA<p>
8 0.97 mA<p>
9 1.05 mA<p>
10 1.13 mA<p>
11 1.21 mA<p>
12 1.29 mA<p>
13 1.37 mA<p>
14 1.45 mA<p>
15 1.53 mA     </td>
  </tr>
</table>
<a class="anchor" name="a23" doxytag="pio.h::PioGetMicBiasHwCurrent" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="csrtypes_8h.html#a4">uint16</a> PioGetMicBiasHwCurrent           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Gets the existing value set for the mic bias pin current. 
<p>
Returns a value in the range 0..15     </td>
  </tr>
</table>
<a class="anchor" name="a24" doxytag="pio.h::PioSetMicBiasHwVoltage" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="csrtypes_8h.html#a9">bool</a> PioSetMicBiasHwVoltage           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="csrtypes_8h.html#a4">uint16</a>&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>voltage</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Sets the voltage driven out through the mic bias pin. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>current</em>&nbsp;</td><td>Valid values are in the range 0..15</td></tr>
  </table>
</dl>
Returns TRUE if the value passed was within the valid range, else returns FALSE;<p>
For BC5-MM the values map as follows.<p>
Value Voltage<p>
0 1.72 v<p>
1 1.77 v<p>
2 1.83 v<p>
3 1.89 v<p>
4 1.97 v<p>
5 2.03 v<p>
6 2.12 v<p>
7 2.20 v<p>
8 2.34 v<p>
9 2.44 v<p>
10 2.58 v<p>
11 2.71 v<p>
12 2.92 v<p>
13 3.10 v<p>
14 3.34 v<p>
15 3.60 v     </td>
  </tr>
</table>
<a class="anchor" name="a25" doxytag="pio.h::PioGetMicBiasHwVoltage" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="csrtypes_8h.html#a4">uint16</a> PioGetMicBiasHwVoltage           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">void&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Gets the existing value set for the mic bias pin voltage. 
<p>
Returns a value in the range 0..15     </td>
  </tr>
</table>
<a class="anchor" name="a26" doxytag="pio.h::PioSetAudioLDORegulator" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void PioSetAudioLDORegulator           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="csrtypes_8h.html#a9">bool</a>&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>enabled</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Enable or disable the audio linear regulator. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>enabled</em>&nbsp;</td><td>Enable(TRUE) or Disable(FALSE).</td></tr>
  </table>
</dl>
Some BlueCore variants have a separate linear regulator to power the audio hardware. This trap allows the application to disable that regulator.     </td>
  </tr>
</table>
<a class="anchor" name="a27" doxytag="pio.h::PioSetBtLDORegulator" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void PioSetBtLDORegulator           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="csrtypes_8h.html#a9">bool</a>&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>enabled</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>