Robobo
pwmc.h
Go to the documentation of this file.
1 /* ----------------------------------------------------------------------------
2  * SAM Software Package License
3  * ----------------------------------------------------------------------------
4  * Copyright (c) 2011-2012, Atmel Corporation
5  *
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following condition is met:
10  *
11  * - Redistributions of source code must retain the above copyright notice,
12  * this list of conditions and the disclaimer below.
13  *
14  * Atmel's name may not be used to endorse or promote products derived from
15  * this software without specific prior written permission.
16  *
17  * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR
18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
20  * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,
21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
23  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
24  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
25  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
26  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  * ----------------------------------------------------------------------------
28  */
29 
57 #ifndef _PWMC_
58 #define _PWMC_
59 
60 /*----------------------------------------------------------------------------
61  * Headers
62  *----------------------------------------------------------------------------*/
63 
64 #include "../chip.h"
65 
66 #include <stdint.h>
67 
68 #ifdef __cplusplus
69  extern "C" {
70 #endif
71 
72 /*----------------------------------------------------------------------------
73  * Exported functions
74  *----------------------------------------------------------------------------*/
75 
76 extern void PWMC_ConfigureChannel( Pwm* pPwm, uint32_t ul_channel, uint32_t prescaler, uint32_t alignment, uint32_t polarity ) ;
77 extern void PWMC_ConfigureChannelExt( Pwm* pPwm, uint32_t ul_channel, uint32_t prescaler, uint32_t alignment, uint32_t polarity,
78  uint32_t countEventSelect, uint32_t DTEnable, uint32_t DTHInverte, uint32_t DTLInverte ) ;
79 
80 extern void PWMC_ConfigureClocks(uint32_t clka, uint32_t clkb, uint32_t mck ) ;
81 extern void PWMC_SetPeriod( Pwm* pPwm, uint32_t ul_channel, uint16_t period ) ;
82 extern void PWMC_SetDutyCycle( Pwm* pPwm, uint32_t ul_channel, uint16_t duty ) ;
83 extern void PWMC_SetDeadTime( Pwm* pPwm, uint32_t ul_channel, uint16_t timeH, uint16_t timeL ) ;
84 extern void PWMC_ConfigureSyncChannel( Pwm* pPwm, uint32_t ul_channels, uint32_t updateMode, uint32_t requestMode, uint32_t requestComparisonSelect ) ;
85 extern void PWMC_SetSyncChannelUpdatePeriod( Pwm* pPwm, uint8_t period ) ;
86 extern void PWMC_SetSyncChannelUpdateUnlock( Pwm* pPwm ) ;
87 extern void PWMC_EnableChannel( Pwm* pPwm, uint32_t ul_channel ) ;
88 extern void PWMC_DisableChannel( Pwm* pPwm, uint32_t ul_channel ) ;
89 extern void PWMC_EnableChannelIt( Pwm* pPwm, uint32_t ul_channel ) ;
90 extern void PWMC_DisableChannelIt( Pwm* pPwm, uint32_t ul_channel ) ;
91 extern void PWMC_EnableIt( Pwm* pPwm, uint32_t sources1, uint32_t sources2 ) ;
92 extern void PWMC_DisableIt( Pwm* pPwm, uint32_t sources1, uint32_t sources2 ) ;
93 extern uint8_t PWMC_WriteBuffer(Pwm *pwmc, void *buffer, uint32_t length ) ;
94 extern void PWMC_SetOverrideValue( Pwm* pPwm, uint32_t value ) ;
95 extern void PWMC_EnableOverrideOutput( Pwm* pPwm, uint32_t value, uint32_t sync ) ;
96 extern void PWMC_DisableOverrideOutput( Pwm* pPwm, uint32_t value, uint32_t sync ) ;
97 extern void PWMC_SetFaultMode( Pwm* pPwm, uint32_t mode ) ;
98 extern void PWMC_FaultClear( Pwm* pPwm, uint32_t fault ) ;
99 extern void PWMC_SetFaultProtectionValue( Pwm* pPwm, uint32_t value ) ;
100 extern void PWMC_EnableFaultProtection( Pwm* pPwm, uint32_t ul_channel, uint32_t value ) ;
101 extern void PWMC_ConfigureComparisonUnit( Pwm* pPwm, uint32_t x, uint32_t value, uint32_t mode ) ;
102 extern void PWMC_ConfigureEventLineMode( Pwm* pPwm, uint32_t x, uint32_t mode ) ;
103 
104 #ifdef __cplusplus
105 }
106 #endif
107 
108 #endif /* #ifndef _PWMC_ */
109 
void PWMC_FaultClear(Pwm *pPwm, uint32_t fault)
PWM fault clear.
Definition: pwmc.c:526
void PWMC_EnableIt(Pwm *pPwm, uint32_t sources1, uint32_t sources2)
Enables the selected interrupts sources on a PWMC peripheral.
Definition: pwmc.c:416
void PWMC_EnableChannel(Pwm *pPwm, uint32_t ul_channel)
Enables the given PWM ul_channel.
Definition: pwmc.c:371
void PWMC_DisableIt(Pwm *pPwm, uint32_t sources1, uint32_t sources2)
Disables the selected interrupts sources on a PWMC peripheral.
Definition: pwmc.c:428
void PWMC_DisableOverrideOutput(Pwm *pPwm, uint32_t value, uint32_t sync)
Disalbe override output.
Definition: pwmc.c:500
void PWMC_ConfigureEventLineMode(Pwm *pPwm, uint32_t x, uint32_t mode)
Configure event line mode.
Definition: pwmc.c:609
void PWMC_SetFaultProtectionValue(Pwm *pPwm, uint32_t value)
Set PWM fault protection value.
Definition: pwmc.c:536
void PWMC_SetPeriod(Pwm *pPwm, uint32_t ul_channel, uint16_t period)
Sets the period value used by a PWM ul_channel.
Definition: pwmc.c:246
void PWMC_ConfigureChannelExt(Pwm *pPwm, uint32_t ul_channel, uint32_t prescaler, uint32_t alignment, uint32_t polarity, uint32_t countEventSelect, uint32_t DTEnable, uint32_t DTHInverte, uint32_t DTLInverte)
Configures PWM a ul_channel with the given parameters, extend configure function. ...
Definition: pwmc.c:180
void PWMC_SetDutyCycle(Pwm *pPwm, uint32_t ul_channel, uint16_t duty)
Sets the duty cycle used by a PWM ul_channel. This function writes directly to the CDTY register if t...
Definition: pwmc.c:270
void PWMC_SetOverrideValue(Pwm *pPwm, uint32_t value)
Set PWM output override value.
Definition: pwmc.c:472
void PWMC_DisableChannelIt(Pwm *pPwm, uint32_t ul_channel)
Disables the period interrupt for the given PWM ul_channel.
Definition: pwmc.c:405
Definition: component_pwm.h:51
void PWMC_SetSyncChannelUpdateUnlock(Pwm *pPwm)
Sets synchronous channels update unlock.
Definition: pwmc.c:359
void PWMC_DisableChannel(Pwm *pPwm, uint32_t ul_channel)
Disables the given PWM ul_channel.
Definition: pwmc.c:385
void PWMC_SetSyncChannelUpdatePeriod(Pwm *pPwm, uint8_t period)
Sets the update period of the synchronous channels. This function writes directly to the SCUP registe...
Definition: pwmc.c:334
void PWMC_EnableOverrideOutput(Pwm *pPwm, uint32_t value, uint32_t sync)
Enalbe override output.
Definition: pwmc.c:483
void PWMC_EnableChannelIt(Pwm *pPwm, uint32_t ul_channel)
Enables the period interrupt for the given PWM ul_channel.
Definition: pwmc.c:395
void PWMC_ConfigureComparisonUnit(Pwm *pPwm, uint32_t x, uint32_t value, uint32_t mode)
Configure comparison unit.
Definition: pwmc.c:587
void PWMC_SetFaultMode(Pwm *pPwm, uint32_t mode)
Set PWM fault mode.
Definition: pwmc.c:516
void PWMC_SetDeadTime(Pwm *pPwm, uint32_t ul_channel, uint16_t timeH, uint16_t timeL)
Sets the dead time used by a PWM ul_channel. This function writes directly to the DT register if the ...
Definition: pwmc.c:297
void PWMC_ConfigureClocks(uint32_t clka, uint32_t clkb, uint32_t mck)
Configures PWM clocks A & B to run at the given frequencies.
Definition: pwmc.c:211
uint8_t PWMC_WriteBuffer(Pwm *pwmc, void *buffer, uint32_t length)
Sends the contents of buffer through a PWMC peripheral, using the PDC to take care of the transfer...
Definition: pwmc.c:445
void PWMC_ConfigureSyncChannel(Pwm *pPwm, uint32_t ul_channels, uint32_t updateMode, uint32_t requestMode, uint32_t requestComparisonSelect)
Configures Syncronous ul_channel with the given parameters. Beware: At this time, the channels should...
Definition: pwmc.c:322
void PWMC_ConfigureChannel(Pwm *pPwm, uint32_t ul_channel, uint32_t prescaler, uint32_t alignment, uint32_t polarity)
Configures PWM a ul_channel with the given parameters, basic configure function.
Definition: pwmc.c:146
void PWMC_EnableFaultProtection(Pwm *pPwm, uint32_t ul_channel, uint32_t value)
Enable PWM fault protection.
Definition: pwmc.c:546