git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_AT91SAM3U256_IAR/AT91Lib/peripherals/pwmc/pwmc.h

   1 /* ----------------------------------------------------------------------------\r
   2  *         ATMEL Microcontroller Software Support \r
   3  * ----------------------------------------------------------------------------\r
   4  * Copyright (c) 2008, Atmel Corporation\r
   5  *\r
   6  * All rights reserved.\r
   7  *\r
   8  * Redistribution and use in source and binary forms, with or without\r
   9  * modification, are permitted provided that the following conditions are met:\r
  10  *\r
  11  * - Redistributions of source code must retain the above copyright notice,\r
  12  * this list of conditions and the disclaimer below.\r
  13  *\r
  14  * Atmel's name may not be used to endorse or promote products derived from\r
  15  * this software without specific prior written permission.\r
  16  *\r
  17  * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR\r
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\r
  19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE\r
  20  * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,\r
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\r
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,\r
  23  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\r
  24  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\r
  25  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\r
  26  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
  27  * ----------------------------------------------------------------------------\r
  28  */\r
  29 \r
  30 //------------------------------------------------------------------------------\r
  31 /// \unit\r
  32 ///\r
  33 /// !Purpose\r
  34 ///\r
  35 /// Interface for configuration the Pulse Width Modulation Controller (PWM) peripheral.\r
  36 ///\r
  37 /// !Usage\r
  38 ///\r
  39 ///    -# Configures PWM clocks A & B to run at the given frequencies using\r
  40 ///       PWMC_ConfigureClocks().\r
  41 ///    -# Configure PWMC channel using PWMC_ConfigureChannel(), PWMC_SetPeriod()\r
  42 ///       and PWMC_SetDutyCycle().\r
  43 ///    -# Enable & disable channel using PWMC_EnableChannel() and \r
  44 ///       PWMC_DisableChannel().\r
  45 ///    -# Enable & disable the period interrupt for the given PWM channel using \r
  46 ///       PWMC_EnableChannelIt() and PWMC_DisableChannelIt().\r
  47 ///\r
  48 /// Please refer to the list of functions in the #Overview# tab of this unit\r
  49 /// for more detailed information.\r
  50 //------------------------------------------------------------------------------\r
  51 \r
  52 #ifndef PWMC_H\r
  53 #define PWMC_H\r
  54 \r
  55 //------------------------------------------------------------------------------\r
  56 //         Global functions\r
  57 //------------------------------------------------------------------------------\r
  58 \r
  59 extern void PWMC_ConfigureChannel(\r
  60     unsigned char channel,\r
  61     unsigned int prescaler,\r
  62     unsigned int alignment,\r
  63     unsigned int polarity);\r
  64 \r
  65 extern void PWMC_ConfigureClocks\r
  66     (unsigned int clka,\r
  67      unsigned int clkb,\r
  68      unsigned int mck);\r
  69 \r
  70 extern void PWMC_SetPeriod(unsigned char channel, unsigned short period);\r
  71 \r
  72 extern void PWMC_SetDutyCycle(unsigned char channel, unsigned short duty);\r
  73 \r
  74 extern void PWMC_EnableChannel(unsigned char channel);\r
  75 \r
  76 extern void PWMC_DisableChannel(unsigned char channel);\r
  77 \r
  78 extern void PWMC_EnableChannelIt(unsigned char channel);\r
  79 \r
  80 extern void PWMC_DisableChannelIt(unsigned char channel);\r
  81 \r
  82 #endif //#ifndef PWMC_H\r
  83 \r