summaryrefslogtreecommitdiffstats
path: root/bsps/arm/atsam/include/libchip/include/pwmc.h
blob: fccfb1555674034951c8d6878873602e0a6a7319 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
/* ---------------------------------------------------------------------------- */
/*                  Atmel Microcontroller Software Support                      */
/*                       SAM Software Package License                           */
/* ---------------------------------------------------------------------------- */
/* Copyright (c) 2015, Atmel Corporation                                        */
/*                                                                              */
/* All rights reserved.                                                         */
/*                                                                              */
/* Redistribution and use in source and binary forms, with or without           */
/* modification, are permitted provided that the following condition is met:    */
/*                                                                              */
/* - Redistributions of source code must retain the above copyright notice,     */
/* this list of conditions and the disclaimer below.                            */
/*                                                                              */
/* Atmel's name may not be used to endorse or promote products derived from     */
/* this software without specific prior written permission.                     */
/*                                                                              */
/* DISCLAIMER:  THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR   */
/* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE   */
/* DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,      */
/* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT */
/* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,  */
/* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    */
/* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING         */
/* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, */
/* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                           */
/* ---------------------------------------------------------------------------- */

/**
 * \file
 *
 * \par Purpose
 *
 * Interface for configuration the Pulse Width Modulation Controller (PWM)
 * peripheral.
 *
 * \par Usage
 *
 *    -# Configures PWM clocks A & B to run at the given frequencies using
 *       \ref PWMC_ConfigureClocks().
 *    -# Configure PWMC channel using \ref PWMC_ConfigureChannel(),
 * \ref PWMC_ConfigureChannelExt()
 *       \ref PWMC_SetPeriod(), \ref PWMC_SetDutyCycle() and
 * \ref PWMC_SetDeadTime().
 *    -# Enable & disable channel using \ref PWMC_EnableChannel() and
 *       \ref PWMC_DisableChannel().
 *    -# Enable & disable the period interrupt for the given PWM channel using
 *       \ref PWMC_EnableChannelIt() and \ref PWMC_DisableChannelIt().
 *    -# Enable & disable the selected interrupts sources on a PWMC peripheral
 *       using  \ref PWMC_EnableIt() and \ref PWMC_DisableIt().
 *    -# Control synchronous channel using \ref PWMC_ConfigureSyncChannel(),
 *       \ref PWMC_SetSyncChannelUpdatePeriod() and
 * \ref PWMC_SetSyncChannelUpdateUnlock().
 *    -# Control PWM override output using \ref PWMC_SetOverrideValue(),
 *       \ref PWMC_EnableOverrideOutput() and \ref PWMC_DisableOverrideOutput().
 *    -# Send data through the transmitter using \ref PWMC_WriteBuffer().
 *
 */

#ifndef _PWMC_
#define _PWMC_

/*----------------------------------------------------------------------------
 *        Headers
 *----------------------------------------------------------------------------*/

#include "chip.h"

#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

/*----------------------------------------------------------------------------
 *        Exported functions
 *----------------------------------------------------------------------------*/

extern void PWMC_ConfigureChannel(
	Pwm *pPwm,
	uint8_t channel,
	uint32_t prescaler,
	uint32_t alignment,
	uint32_t polarity);
extern void PWMC_ConfigureChannelExt(
	Pwm *pPwm,
	uint8_t channel,
	uint32_t prescaler,
	uint32_t alignment,
	uint32_t polarity,
	uint32_t countEventSelect,
	uint32_t DTEnable,
	uint32_t DTHInverte,
	uint32_t DTLInverte);
extern void PWMC_ConfigureClocks(Pwm *pPwm, uint32_t clka, uint32_t clkb,
								 uint32_t mck);
extern void PWMC_SetPeriod(Pwm *pPwm, uint8_t channel, uint16_t period);
extern void PWMC_SetDutyCycle(Pwm *pPwm, uint8_t channel, uint16_t duty);
extern void PWMC_SetDeadTime(Pwm *pPwm, uint8_t channel, uint16_t timeH,
							  uint16_t timeL);
extern void PWMC_ConfigureSyncChannel(Pwm *pPwm,
									   uint32_t channels,
									   uint32_t updateMode,
									   uint32_t requestMode,
									   uint32_t requestComparisonSelect);
extern void PWMC_SetSyncChannelUpdatePeriod(Pwm *pPwm, uint8_t period);
extern void PWMC_SetSyncChannelUpdateUnlock(Pwm *pPwm);
extern void PWMC_EnableChannel(Pwm *pPwm, uint8_t channel);
extern void PWMC_DisableChannel(Pwm *pPwm, uint8_t channel);
extern void PWMC_EnableChannelIt(Pwm *pPwm, uint8_t channel);
extern void PWMC_DisableChannelIt(Pwm *pPwm, uint8_t channel);
extern void PWMC_EnableIt(Pwm *pPwm, uint32_t sources1, uint32_t sources2);
extern void PWMC_DisableIt(Pwm *pPwm, uint32_t sources1, uint32_t sources2);
extern uint8_t PWMC_WriteBuffer(Pwm *pwmc,
								void *buffer,
								uint32_t length);
extern void PWMC_SetOverrideValue(Pwm *pPwm, uint32_t value);
extern void PWMC_EnableOverrideOutput(Pwm *pPwm, uint32_t value,
									   uint32_t sync);
extern void PWMC_OutputOverrideSelection(Pwm *pPwm, uint32_t value);
extern void PWMC_DisableOverrideOutput(Pwm *pPwm, uint32_t value,
										uint32_t sync);
extern void PWMC_SetFaultMode(Pwm *pPwm, uint32_t mode);
extern void PWMC_FaultClear(Pwm *pPwm, uint32_t fault);
extern void PWMC_SetFaultProtectionValue(Pwm *pPwm, uint32_t value);
extern void PWMC_EnableFaultProtection(Pwm *pPwm, uint32_t value);
extern void PWMC_ConfigureComparisonUnit(Pwm *pPwm, uint32_t x,
		uint32_t value, uint32_t mode);
extern void PWMC_ConfigureEventLineMode(Pwm *pPwm, uint32_t x, uint32_t mode);
extern uint32_t PWMC_GetStatus2(Pwm *pPwm);
#ifdef __cplusplus
}
#endif

#endif /* #ifndef _PWMC_ */