Sophie

Sophie

distrib > Fedora > 13 > i386 > media > os > by-pkgid > 73443d16ffe49ffcb4131bf0d8d1b044 > files > 104

avr-libc-docs-1.6.7-2.fc13.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
    <title>avr-libc: &lt;avr/power.h&gt;: Power Reduction Management</title>
    <link href="dox.css" rel="stylesheet" type="text/css">
  </head>
<body>
<center>
<table width="80%">
  <tr>
    <td align="left"><a href="http://www.nongnu.org/avr-libc/">AVR Libc Home Page</a></td>
    <td align="center" colspan=4><img src="avrs.png" alt="AVRs" align="middle" border="0"></td>
    <td align="right"><a href="https://savannah.nongnu.org/projects/avr-libc/">AVR Libc Development Pages</a></td>
  </tr>
  <tr>
    <td align="center" width="13%"><a href="index.html">Main Page</a></td>
    <td align="center" width="13%"><a href="pages.html">User Manual</a></td>
    <td align="center" width="13%"><a href="modules.html">Library Reference</a></td>
    <td align="center" width="13%"><a href="FAQ.html">FAQ</a></td>
    <td align="center" width="13%"><a href="globals.html">Alphabetical Index</a></td>
    <td align="center" width="13%"><a href="group__demos.html">Example Projects</a></td>
  </tr>
</table>
</center>
<hr width="80%">
<!-- Generated by Doxygen 1.6.1 -->
<div class="contents">
<h1>&lt;avr/power.h&gt;: Power Reduction Management</h1><table border="0" cellpadding="0" cellspacing="0">
</table>
<div class="fragment"><pre class="fragment"><span class="preprocessor"> #include &lt;<a class="code" href="power_8h.html">avr/power.h</a>&gt;</span>
</pre></div><p>Many AVRs contain a Power Reduction Register (PRR) or Registers (PRRx) that allow you to reduce power consumption by disabling or enabling various on-board peripherals as needed.</p>
<p>There are many macros in this header file that provide an easy interface to enable or disable on-board peripherals to reduce power. See the table below.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>Not all AVR devices have a Power Reduction Register (for example the ATmega128). On those devices without a Power Reduction Register, these macros are not available.</dd>
<dd>
Not all AVR devices contain the same peripherals (for example, the LCD interface), or they will be named differently (for example, USART and USART0). Please consult your device's datasheet, or the header file, to find out which macros are applicable to your device.</dd></dl>
<p><a class="anchor" id="avr_powermacros"></a> <small> </p>
<center> <table border="3" cellspacing="3" cellpadding="3">
<tr>
<td width="10%"><p><b>Power Macro</b> </p>
</td><td width="15%"><p><b>Description</b> </p>
</td><td width="75%"><p><b>Applicable for device</b> </p>
<p></p>
</td></tr>
<tr>
<td><p>power_adc_enable() </p>
</td><td><p>Enable the Analog to Digital Converter module. </p>
</td><td><p>ATmega640, ATmega1280, ATmega1281, ATmega128RFA1, ATmega2560, ATmega2561, AT90USB646, AT90USB647, AT90USB1286, AT90USB1287, AT90PWM1, AT90PWM2, AT90PWM2B, AT90PWM3, AT90PWM3B, AT90PWM216, AT90PWM316, ATmega165, ATmega165P, ATmega325, ATmega3250, ATmega645, ATmega6450, ATmega169, ATmega169P, ATmega329, ATmega3290, ATmega649, ATmega6490, ATmega164P, ATmega324P, ATmega644, ATmega48, ATmega88, ATmega168, ATtiny24, ATtiny44, ATtiny84, ATtiny25, ATtiny45, ATtiny85, ATtiny261, ATtiny461, ATtiny861 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_adc_disable() </p>
</td><td><p>Disable the Analog to Digital Converter module. </p>
</td><td><p>ATmega640, ATmega1280, ATmega1281, ATmega128RFA1, ATmega2560, ATmega2561, AT90USB646, AT90USB647, AT90USB1286, AT90USB1287, AT90PWM1, AT90PWM2, AT90PWM2B, AT90PWM3, AT90PWM3B, AT90PWM216, AT90PWM316, ATmega165, ATmega165P, ATmega325, ATmega3250, ATmega645, ATmega6450, ATmega169, ATmega169P, ATmega329, ATmega3290, ATmega649, ATmega6490, ATmega164P, ATmega324P, ATmega644, ATmega48, ATmega88, ATmega168, ATtiny24, ATtiny44, ATtiny84, ATtiny25, ATtiny45, ATtiny85, ATtiny261, ATtiny461, ATtiny861 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_lcd_enable() </p>
</td><td><p>Enable the LCD module. </p>
</td><td><p>ATmega169, ATmega169P, ATmega329, ATmega3290, ATmega649, ATmega6490 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_lcd_disable(). </p>
</td><td><p>Disable the LCD module. </p>
</td><td><p>ATmega169, ATmega169P, ATmega329, ATmega3290, ATmega649, ATmega6490 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_psc0_enable() </p>
</td><td><p>Enable the Power Stage Controller 0 module. </p>
</td><td><p>AT90PWM1, AT90PWM2, AT90PWM2B, AT90PWM3, AT90PWM3B </p>
<p></p>
</td></tr>
<tr>
<td><p>power_psc0_disable() </p>
</td><td><p>Disable the Power Stage Controller 0 module. </p>
</td><td><p>AT90PWM1, AT90PWM2, AT90PWM2B, AT90PWM3, AT90PWM3B </p>
<p></p>
</td></tr>
<tr>
<td><p>power_psc1_enable() </p>
</td><td><p>Enable the Power Stage Controller 1 module. </p>
</td><td><p>AT90PWM1, AT90PWM2, AT90PWM2B, AT90PWM3, AT90PWM3B </p>
<p></p>
</td></tr>
<tr>
<td><p>power_psc1_disable() </p>
</td><td><p>Disable the Power Stage Controller 1 module. </p>
</td><td><p>AT90PWM1, AT90PWM2, AT90PWM2B, AT90PWM3, AT90PWM3B </p>
<p></p>
</td></tr>
<tr>
<td><p>power_psc2_enable() </p>
</td><td><p>Enable the Power Stage Controller 2 module. </p>
</td><td><p>AT90PWM1, AT90PWM2, AT90PWM2B, AT90PWM3, AT90PWM3B </p>
<p></p>
</td></tr>
<tr>
<td><p>power_psc2_disable() </p>
</td><td><p>Disable the Power Stage Controller 2 module. </p>
</td><td><p>AT90PWM1, AT90PWM2, AT90PWM2B, AT90PWM3, AT90PWM3B </p>
<p></p>
</td></tr>
<tr>
<td><p>power_spi_enable() </p>
</td><td><p>Enable the Serial Peripheral Interface module. </p>
</td><td><p>ATmega640, ATmega1280, ATmega1281, ATmega128RFA1, ATmega2560, ATmega2561, AT90USB646, AT90USB647, AT90USB1286, AT90USB1287, AT90PWM1, AT90PWM2, AT90PWM2B, AT90PWM3, AT90PWM3B, AT90PWM216, AT90PWM316, ATmega165, ATmega165P, ATmega325, ATmega3250, ATmega645, ATmega6450, ATmega169, ATmega169P, ATmega329, ATmega3290, ATmega649, ATmega6490, ATmega164P, ATmega324P, ATmega644, ATmega48, ATmega88, ATmega168 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_spi_disable() </p>
</td><td><p>Disable the Serial Peripheral Interface module. </p>
</td><td><p>ATmega640, ATmega1280, ATmega1281, ATmega128RFA1, ATmega2560, ATmega2561, AT90USB646, AT90USB647, AT90USB1286, AT90USB1287, AT90PWM1, AT90PWM2, AT90PWM2B, AT90PWM3, AT90PWM3B, AT90PWM216, AT90PWM316, ATmega165, ATmega165P, ATmega325, ATmega3250, ATmega645, ATmega6450, ATmega169, ATmega169P, ATmega329, ATmega3290, ATmega649, ATmega6490, ATmega164P, ATmega324P, ATmega644, ATmega48, ATmega88, ATmega168 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_timer0_enable() </p>
</td><td><p>Enable the Timer 0 module. </p>
</td><td><p>ATmega640, ATmega1280, ATmega1281, ATmega128RFA1, ATmega2560, ATmega2561, AT90USB646, AT90USB647, AT90USB1286, AT90USB1287, AT90PWM1, AT90PWM216, AT90PWM316, AT90PWM2, AT90PWM2B, AT90PWM3, AT90PWM3B, ATmega165, ATmega165P, ATmega325, ATmega3250, ATmega645, ATmega6450, ATmega164P, ATmega324P, ATmega644, ATmega406, ATmega48, ATmega88, ATmega168, ATtiny24, ATtiny44, ATtiny84, ATtiny25, ATtiny45, ATtiny85, ATtiny261, ATtiny461, ATtiny861 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_timer0_disable() </p>
</td><td><p>Disable the Timer 0 module. </p>
</td><td><p>ATmega640, ATmega1280, ATmega1281, ATmega128RFA1, ATmega2560, ATmega2561, AT90USB646, AT90USB647, AT90USB1286, AT90USB1287, AT90PWM1, AT90PWM2, AT90PWM2B, AT90PWM3, AT90PWM3B, AT90PWM216, AT90PWM316, ATmega165, ATmega165P, ATmega325, ATmega3250, ATmega645, ATmega6450, ATmega164P, ATmega324P, ATmega644, ATmega406, ATmega48, ATmega88, ATmega168, ATtiny24, ATtiny44, ATtiny84, ATtiny25, ATtiny45, ATtiny85, ATtiny261, ATtiny461, ATtiny861 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_timer1_enable() </p>
</td><td><p>Enable the Timer 1 module. </p>
</td><td><p>ATmega640, ATmega1280, ATmega1281, ATmega128RFA1, ATmega2560, ATmega2561, AT90USB646, AT90USB647, AT90USB1286, AT90USB1287, AT90PWM1, AT90PWM2, AT90PWM2B, AT90PWM3, AT90PWM3B, AT90PWM216, AT90PWM316, ATmega165, ATmega165P, ATmega325, ATmega3250, ATmega645, ATmega6450, ATmega169, ATmega169P, ATmega329, ATmega3290, ATmega649, ATmega6490, ATmega164P, ATmega324P, ATmega644, ATmega406, ATmega48, ATmega88, ATmega168, ATtiny24, ATtiny44, ATtiny84, ATtiny25, ATtiny45, ATtiny85, ATtiny261, ATtiny461, ATtiny861 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_timer1_disable() </p>
</td><td><p>Disable the Timer 1 module. </p>
</td><td><p>ATmega640, ATmega1280, ATmega1281, ATmega128RFA1, ATmega2560, ATmega2561, AT90USB646, AT90USB647, AT90USB1286, AT90USB1287, AT90PWM1, AT90PWM2, AT90PWM2B, AT90PWM3, AT90PWM3B, AT90PWM216, AT90PWM316, ATmega165, ATmega165P, ATmega325, ATmega3250, ATmega645, ATmega6450, ATmega169, ATmega169P, ATmega329, ATmega3290, ATmega649, ATmega6490, ATmega164P, ATmega324P, ATmega644, ATmega406, ATmega48, ATmega88, ATmega168, ATtiny24, ATtiny44, ATtiny84, ATtiny25, ATtiny45, ATtiny85, ATtiny261, ATtiny461, ATtiny861 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_timer2_enable() </p>
</td><td><p>Enable the Timer 2 module. </p>
</td><td><p>ATmega640, ATmega1280, ATmega1281, ATmega128RFA1, ATmega2560, ATmega2561, AT90USB646, AT90USB647, AT90USB1286, AT90USB1287, ATmega164P, ATmega324P, ATmega644, ATmega48, ATmega88, ATmega168 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_timer2_disable() </p>
</td><td><p>Disable the Timer 2 module. </p>
</td><td><p>ATmega640, ATmega1280, ATmega1281, ATmega128RFA1, ATmega2560, ATmega2561, AT90USB646, AT90USB647, AT90USB1286, AT90USB1287, ATmega164P, ATmega324P, ATmega644, ATmega48, ATmega88, ATmega168 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_timer3_enable() </p>
</td><td><p>Enable the Timer 3 module. </p>
</td><td><p>ATmega640, ATmega1280, ATmega1281, ATmega128RFA1, ATmega2560, ATmega2561, AT90USB646, AT90USB647, AT90USB1286, AT90USB1287 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_timer3_disable() </p>
</td><td><p>Disable the Timer 3 module. </p>
</td><td><p>ATmega640, ATmega1280, ATmega1281, ATmega128RFA1, ATmega2560, ATmega2561, AT90USB646, AT90USB647, AT90USB1286, AT90USB1287 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_timer4_enable() </p>
</td><td><p>Enable the Timer 4 module. </p>
</td><td><p>ATmega640, ATmega1280, ATmega1281, ATmega128RFA1, ATmega2560, ATmega2561 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_timer4_disable() </p>
</td><td><p>Disable the Timer 4 module. </p>
</td><td><p>ATmega640, ATmega1280, ATmega1281, ATmega128RFA1, ATmega2560, ATmega2561 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_timer5_enable() </p>
</td><td><p>Enable the Timer 5 module. </p>
</td><td><p>ATmega640, ATmega1280, ATmega1281, ATmega128RFA1, ATmega2560, ATmega2561 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_timer5_disable() </p>
</td><td><p>Disable the Timer 5 module. </p>
</td><td><p>ATmega640, ATmega1280, ATmega1281, ATmega128RFA1, ATmega2560, ATmega2561 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_twi_enable() </p>
</td><td><p>Enable the Two Wire Interface module. </p>
</td><td><p>ATmega640, ATmega1280, ATmega1281, ATmega128RFA1, ATmega2560, ATmega2561, AT90USB646, AT90USB647, AT90USB1286, AT90USB1287, ATmega164P, ATmega324P, ATmega644, ATmega406, ATmega48, ATmega88, ATmega168 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_twi_disable() </p>
</td><td><p>Disable the Two Wire Interface module. </p>
</td><td><p>ATmega640, ATmega1280, ATmega1281, ATmega128RFA1, ATmega2560, ATmega2561, AT90USB646, AT90USB647, AT90USB1286, AT90USB1287, ATmega164P, ATmega324P, ATmega644, ATmega406, ATmega48, ATmega88, ATmega168 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_usart_enable() </p>
</td><td><p>Enable the USART module. </p>
</td><td><p>AT90PWM2, AT90PWM2B, AT90PWM3, AT90PWM3B </p>
<p></p>
</td></tr>
<tr>
<td><p>power_usart_disable() </p>
</td><td><p>Disable the USART module. </p>
</td><td><p>AT90PWM2, AT90PWM2B, AT90PWM3, AT90PWM3B </p>
<p></p>
</td></tr>
<tr>
<td><p>power_usart0_enable() </p>
</td><td><p>Enable the USART 0 module. </p>
</td><td><p>ATmega640, ATmega1280, ATmega1281, ATmega128RFA1, ATmega2560, ATmega2561, ATmega165, ATmega165P, ATmega325, ATmega3250, ATmega645, ATmega6450, ATmega169, ATmega169P, ATmega329, ATmega3290, ATmega649, ATmega6490, ATmega164P, ATmega324P, ATmega644, ATmega48, ATmega88, ATmega168 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_usart0_disable() </p>
</td><td><p>Disable the USART 0 module. </p>
</td><td><p>ATmega640, ATmega1280, ATmega1281, ATmega128RFA1, ATmega2560, ATmega2561, ATmega165, ATmega165P, ATmega325, ATmega3250, ATmega645, ATmega6450, ATmega169, ATmega169P, ATmega329, ATmega3290, ATmega649, ATmega6490, ATmega164P, ATmega324P, ATmega644, ATmega48, ATmega88, ATmega168 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_usart1_enable() </p>
</td><td><p>Enable the USART 1 module. </p>
</td><td><p>ATmega640, ATmega1280, ATmega1281, ATmega128RFA1, ATmega2560, ATmega2561, AT90USB646, AT90USB647, AT90USB1286, AT90USB1287, ATmega164P, ATmega324P </p>
<p></p>
</td></tr>
<tr>
<td><p>power_usart1_disable() </p>
</td><td><p>Disable the USART 1 module. </p>
</td><td><p>ATmega640, ATmega1280, ATmega1281, ATmega128RFA1, ATmega2560, ATmega2561, AT90USB646, AT90USB647, AT90USB1286, AT90USB1287, ATmega164P, ATmega324P </p>
<p></p>
</td></tr>
<tr>
<td><p>power_usart2_enable() </p>
</td><td><p>Enable the USART 2 module. </p>
</td><td><p>ATmega640, ATmega1280, ATmega1281, ATmega2560, ATmega2561 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_usart2_disable() </p>
</td><td><p>Disable the USART 2 module. </p>
</td><td><p>ATmega640, ATmega1280, ATmega1281, ATmega2560, ATmega2561 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_usart3_enable() </p>
</td><td><p>Enable the USART 3 module. </p>
</td><td><p>ATmega640, ATmega1280, ATmega1281, ATmega2560, ATmega2561 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_usart3_disable() </p>
</td><td><p>Disable the USART 3 module. </p>
</td><td><p>ATmega640, ATmega1280, ATmega1281, ATmega2560, ATmega2561 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_usb_enable() </p>
</td><td><p>Enable the USB module. </p>
</td><td><p>AT90USB646, AT90USB647, AT90USB1286, AT90USB1287 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_usb_disable() </p>
</td><td><p>Disable the USB module. </p>
</td><td><p>AT90USB646, AT90USB647, AT90USB1286, AT90USB1287 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_usi_enable() </p>
</td><td><p>Enable the Universal Serial Interface module. </p>
</td><td><p>ATtiny24, ATtiny44, ATtiny84, ATtiny25, ATtiny45, ATtiny85, ATtiny261, ATtiny461, ATtiny861 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_usi_disable() </p>
</td><td><p>Disable the Universal Serial Interface module. </p>
</td><td><p>ATtiny24, ATtiny44, ATtiny84, ATtiny25, ATtiny45, ATtiny85, ATtiny261, ATtiny461, ATtiny861 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_vadc_enable() </p>
</td><td><p>Enable the Voltage ADC module. </p>
</td><td><p>ATmega406 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_vadc_disable() </p>
</td><td><p>Disable the Voltage ADC module. </p>
</td><td><p>ATmega406 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_all_enable() </p>
</td><td><p>Enable all modules. </p>
</td><td><p>ATmega640, ATmega1280, ATmega1281, ATmega128RFA1, ATmega2560, ATmega2561, AT90USB646, AT90USB647, AT90USB1286, AT90USB1287, AT90PWM1, AT90PWM2, AT90PWM2B, AT90PWM3, AT90PWM3B, AT90PWM216, AT90PWM316, ATmega165, ATmega165P, ATmega325, ATmega3250, ATmega645, ATmega6450, ATmega169, ATmega169P, ATmega329, ATmega3290, ATmega649, ATmega6490, ATmega164P, ATmega324P, ATmega644, ATmega406, ATmega48, ATmega88, ATmega168, ATtiny24, ATtiny44, ATtiny84, ATtiny25, ATtiny45, ATtiny85, ATtiny261, ATtiny461, ATtiny861 </p>
<p></p>
</td></tr>
<tr>
<td><p>power_all_disable() </p>
</td><td><p>Disable all modules. </p>
</td><td><p>ATmega640, ATmega1280, ATmega1281, ATmega128RFA1, ATmega2560, ATmega2561, AT90USB646, AT90USB647, AT90USB1286, AT90USB1287, AT90PWM1, AT90PWM2, AT90PWM2B, AT90PWM3, AT90PWM3B, AT90PWM216, AT90PWM316, ATmega165, ATmega165P, ATmega325, ATmega3250, ATmega645, ATmega6450, ATmega169, ATmega169P, ATmega329, ATmega3290, ATmega649, ATmega6490, ATmega164P, ATmega324P, ATmega644, ATmega406, ATmega48, ATmega88, ATmega168, ATtiny24, ATtiny44, ATtiny84, ATtiny25, ATtiny45, ATtiny85, ATtiny261, ATtiny461, ATtiny861  </p>
</td></tr>
</table>
</center><p> </small></p>
<p>Some of the newer AVRs contain a System Clock Prescale Register (CLKPR) that allows you to decrease the system clock frequency and the power consumption when the need for processing power is low. Below are two macros and an enumerated type that can be used to interface to the Clock Prescale Register.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>Not all AVR devices have a Clock Prescale Register. On those devices without a Clock Prescale Register, these macros are not available.</dd></dl>
<div class="fragment"><pre class="fragment"><span class="keyword">typedef</span> <span class="keyword">enum</span>
{
    clock_div_1 = 0,
    clock_div_2 = 1,
    clock_div_4 = 2,
    clock_div_8 = 3,
    clock_div_16 = 4,
    clock_div_32 = 5,
    clock_div_64 = 6,
    clock_div_128 = 7,
    clock_div_256 = 8,
    clock_div_1_rc = 15, <span class="comment">// ATmega128RFA1 only</span>
} clock_div_t;
</pre></div><p> Clock prescaler setting enumerations.</p>
<div class="fragment"><pre class="fragment"> clock_prescale_set(x) 
</pre></div><p> Set the clock prescaler register select bits, selecting a system clock division setting. They type of x is clock_div_t.</p>
<div class="fragment"><pre class="fragment"> clock_prescale_get() 
</pre></div><p> Gets and returns the clock prescaler register setting. The return type is clock_div_t. </p>
</div>

<hr width="80%">
<p><center>Automatically generated by Doxygen 1.6.1 on 30 Nov 2009.</center></p>

</body>
</html>