git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_M7_SAMV71_Xplained/libchip_samv7/include/pwmc.h

   1 /* ----------------------------------------------------------------------------\r
   2  *         SAM Software Package License\r
   3  * ----------------------------------------------------------------------------\r
   4  * Copyright (c) 2011, 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  * \file\r
  32  *\r
  33  * \par Purpose\r
  34  *\r
  35  * Interface for configuration the Pulse Width Modulation Controller (PWM) peripheral.\r
  36  *\r
  37  * \par Usage\r
  38  *\r
  39  *    -# Configures PWM clocks A & B to run at the given frequencies using\r
  40  *       \ref PWMC_ConfigureClocks().\r
  41  *    -# Configure PWMC channel using \ref PWMC_ConfigureChannel(), \ref PWMC_ConfigureChannelExt()\r
  42  *       \ref PWMC_SetPeriod(), \ref PWMC_SetDutyCycle() and \ref PWMC_SetDeadTime().\r
  43  *    -# Enable & disable channel using \ref PWMC_EnableChannel() and\r
  44  *       \ref PWMC_DisableChannel().\r
  45  *    -# Enable & disable the period interrupt for the given PWM channel using\r
  46  *       \ref PWMC_EnableChannelIt() and \ref PWMC_DisableChannelIt().\r
  47  *    -# Enable & disable the selected interrupts sources on a PWMC peripheral\r
  48  *       using  \ref PWMC_EnableIt() and \ref PWMC_DisableIt().\r
  49  *    -# Control syncronous channel using \ref PWMC_ConfigureSyncChannel(),\r
  50  *       \ref PWMC_SetSyncChannelUpdatePeriod() and \ref PWMC_SetSyncChannelUpdateUnlock().\r
  51  *    -# Control PWM override output using \ref PWMC_SetOverrideValue(),\r
  52  *       \ref PWMC_EnableOverrideOutput() and \ref PWMC_DisableOverrideOutput().\r
  53  *    -# Send data through the transmitter using \ref PWMC_WriteBuffer().\r
  54  *\r
  55  */\r
  56 \r
  57 #ifndef _PWMC_\r
  58 #define _PWMC_\r
  59 \r
  60 /*----------------------------------------------------------------------------\r
  61  *        Headers\r
  62  *----------------------------------------------------------------------------*/\r
  63 \r
  64 #include "chip.h"\r
  65 \r
  66 #include <stdint.h>\r
  67 \r
  68 #ifdef __cplusplus\r
  69  extern "C" {\r
  70 #endif\r
  71 \r
  72 /*----------------------------------------------------------------------------\r
  73  *        Exported functions\r
  74  *----------------------------------------------------------------------------*/\r
  75 \r
  76 extern void PWMC_ConfigureChannel(\r
  77     Pwm* pPwm,\r
  78     uint8_t channel,\r
  79     uint32_t prescaler,\r
  80     uint32_t alignment,\r
  81     uint32_t polarity);\r
  82 extern void PWMC_ConfigureChannelExt(\r
  83     Pwm* pPwm,\r
  84     uint8_t channel,\r
  85     uint32_t prescaler,\r
  86     uint32_t alignment,\r
  87     uint32_t polarity,\r
  88     uint32_t countEventSelect,\r
  89     uint32_t DTEnable,\r
  90     uint32_t DTHInverte,\r
  91     uint32_t DTLInverte);\r
  92 extern void PWMC_ConfigureClocks(Pwm* pPwm, uint32_t clka, uint32_t clkb, uint32_t mck);\r
  93 extern void PWMC_SetPeriod( Pwm* pPwm, uint8_t channel, uint16_t period);\r
  94 extern void PWMC_SetDutyCycle( Pwm* pPwm, uint8_t channel, uint16_t duty);\r
  95 extern void PWMC_SetDeadTime( Pwm* pPwm, uint8_t channel, uint16_t timeH, uint16_t timeL);\r
  96 extern void PWMC_ConfigureSyncChannel( Pwm* pPwm,\r
  97     uint32_t channels,\r
  98     uint32_t updateMode,\r
  99     uint32_t requestMode,\r
 100     uint32_t requestComparisonSelect);\r
 101 extern void PWMC_SetSyncChannelUpdatePeriod( Pwm* pPwm, uint8_t period);\r
 102 extern void PWMC_SetSyncChannelUpdateUnlock( Pwm* pPwm );\r
 103 extern void PWMC_EnableChannel( Pwm* pPwm, uint8_t channel);\r
 104 extern void PWMC_DisableChannel( Pwm* pPwm, uint8_t channel);\r
 105 extern void PWMC_EnableChannelIt( Pwm* pPwm, uint8_t channel);\r
 106 extern void PWMC_DisableChannelIt( Pwm* pPwm, uint8_t channel);\r
 107 extern void PWMC_EnableIt( Pwm* pPwm, uint32_t sources1, uint32_t sources2);\r
 108 extern void PWMC_DisableIt( Pwm* pPwm, uint32_t sources1, uint32_t sources2);\r
 109 extern uint8_t PWMC_WriteBuffer(Pwm *pwmc,\r
 110     void *buffer,\r
 111     uint32_t length);\r
 112 extern void PWMC_SetOverrideValue( Pwm* pPwm, uint32_t value);\r
 113 extern void PWMC_EnableOverrideOutput( Pwm* pPwm, uint32_t value, uint32_t sync);\r
 114 extern void PWMC_OutputOverrideSelection( Pwm* pPwm, uint32_t value );\r
 115 extern void PWMC_DisableOverrideOutput( Pwm* pPwm, uint32_t value, uint32_t sync);\r
 116 extern void PWMC_SetFaultMode( Pwm* pPwm, uint32_t mode);\r
 117 extern void PWMC_FaultClear( Pwm* pPwm, uint32_t fault);\r
 118 extern void PWMC_SetFaultProtectionValue( Pwm* pPwm, uint32_t value);\r
 119 extern void PWMC_EnableFaultProtection( Pwm* pPwm, uint32_t value);\r
 120 extern void PWMC_ConfigureComparisonUnit( Pwm* pPwm, uint32_t x, uint32_t value, uint32_t mode);\r
 121 extern void PWMC_ConfigureEventLineMode( Pwm* pPwm, uint32_t x, uint32_t mode);\r
 122 extern uint32_t PWMC_GetStatus2( Pwm* pPwm);\r
 123 #ifdef __cplusplus\r
 124 }\r
 125 #endif\r
 126 \r
 127 #endif /* #ifndef _PWMC_ */\r
 128 \r