summaryrefslogtreecommitdiffstats
path: root/bsps/arm/atsam/include/libchip/include/pwmc.h
diff options
context:
space:
mode:
authorChris Johns <chrisj@rtems.org>2017-12-23 18:18:56 +1100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2018-01-25 08:45:26 +0100
commit2afb22b7e1ebcbe40373ff7e0efae7d207c655a9 (patch)
tree44759efe9374f13200a97e96d91bd9a2b7e5ce2a /bsps/arm/atsam/include/libchip/include/pwmc.h
parentMAINTAINERS: Add myself to Write After Approval. (diff)
downloadrtems-2afb22b7e1ebcbe40373ff7e0efae7d207c655a9.tar.bz2
Remove make preinstall
A speciality of the RTEMS build system was the make preinstall step. It copied header files from arbitrary locations into the build tree. The header files were included via the -Bsome/build/tree/path GCC command line option. This has at least seven problems: * The make preinstall step itself needs time and disk space. * Errors in header files show up in the build tree copy. This makes it hard for editors to open the right file to fix the error. * There is no clear relationship between source and build tree header files. This makes an audit of the build process difficult. * The visibility of all header files in the build tree makes it difficult to enforce API barriers. For example it is discouraged to use BSP-specifics in the cpukit. * An introduction of a new build system is difficult. * Include paths specified by the -B option are system headers. This may suppress warnings. * The parallel build had sporadic failures on some hosts. This patch removes the make preinstall step. All installed header files are moved to dedicated include directories in the source tree. Let @RTEMS_CPU@ be the target architecture, e.g. arm, powerpc, sparc, etc. Let @RTEMS_BSP_FAMILIY@ be a BSP family base directory, e.g. erc32, imx, qoriq, etc. The new cpukit include directories are: * cpukit/include * cpukit/score/cpu/@RTEMS_CPU@/include * cpukit/libnetworking The new BSP include directories are: * bsps/include * bsps/@RTEMS_CPU@/include * bsps/@RTEMS_CPU@/@RTEMS_BSP_FAMILIY@/include There are build tree include directories for generated files. The include directory order favours the most general header file, e.g. it is not possible to override general header files via the include path order. The "bootstrap -p" option was removed. The new "bootstrap -H" option should be used to regenerate the "headers.am" files. Update #3254.
Diffstat (limited to 'bsps/arm/atsam/include/libchip/include/pwmc.h')
-rw-r--r--bsps/arm/atsam/include/libchip/include/pwmc.h137
1 files changed, 137 insertions, 0 deletions
diff --git a/bsps/arm/atsam/include/libchip/include/pwmc.h b/bsps/arm/atsam/include/libchip/include/pwmc.h
new file mode 100644
index 0000000000..fccfb15556
--- /dev/null
+++ b/bsps/arm/atsam/include/libchip/include/pwmc.h
@@ -0,0 +1,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_ */
+