aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/templates/pwm_lld.h
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2009-12-07 16:13:01 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2009-12-07 16:13:01 +0000
commit0b8fd860fa71b35bfe0a242471d3bc4b56c93089 (patch)
treebef2e30c56b7f7e99e6d0aa6ddf7ca7459ce0f1a /os/hal/templates/pwm_lld.h
parentf1aa994420693645eb0ea371017170b465f86ef2 (diff)
downloadChibiOS-0b8fd860fa71b35bfe0a242471d3bc4b56c93089.tar.gz
ChibiOS-0b8fd860fa71b35bfe0a242471d3bc4b56c93089.tar.bz2
ChibiOS-0b8fd860fa71b35bfe0a242471d3bc4b56c93089.zip
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@1381 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/hal/templates/pwm_lld.h')
-rw-r--r--os/hal/templates/pwm_lld.h105
1 files changed, 105 insertions, 0 deletions
diff --git a/os/hal/templates/pwm_lld.h b/os/hal/templates/pwm_lld.h
new file mode 100644
index 000000000..8e57830f6
--- /dev/null
+++ b/os/hal/templates/pwm_lld.h
@@ -0,0 +1,105 @@
+/*
+ ChibiOS/RT - Copyright (C) 2006-2007 Giovanni Di Sirio.
+
+ This file is part of ChibiOS/RT.
+
+ ChibiOS/RT is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 3 of the License, or
+ (at your option) any later version.
+
+ ChibiOS/RT is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/**
+ * @file templates/pwm_lld.h
+ * @brief PWM Driver subsystem low level driver header template
+ * @addtogroup PWM_LLD
+ * @{
+ */
+
+#ifndef _PWM_LLD_H_
+#define _PWM_LLD_H_
+
+/*===========================================================================*/
+/* Driver constants. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Driver pre-compile time settings. */
+/*===========================================================================*/
+
+/**
+ * @brief Number of PWM channels per PWM driver.
+ */
+#if !defined(PWM_CHANNELS) || defined(__DOXYGEN__)
+#define PWM_CHANNELS 1
+#endif
+
+/*===========================================================================*/
+/* Driver data structures and types. */
+/*===========================================================================*/
+
+/**
+ * @brief PWM channel type.
+ */
+typedef uint8_t pwmchannel_t;
+
+/**
+ * @brief PWM counter type.
+ */
+typedef uint16_t pwmcnt_t;
+
+/**
+ * @brief Driver configuration structure.
+ * @note It could be empty on some architectures.
+ */
+typedef struct {
+
+} PWMConfig;
+
+/**
+ * @brief Structure representing an PWM driver.
+ */
+typedef struct {
+ /**
+ * @brief Driver state.
+ */
+ pwmstate_t pd_state;
+ /**
+ * @brief Current configuration data.
+ */
+ const PWMConfig *pd_config;
+ /* End of the mandatory fields.*/
+} PWMDriver;
+
+/*===========================================================================*/
+/* External declarations. */
+/*===========================================================================*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+ void pwm_lld_init(void);
+ void pwm_lld_start(PWMDriver *pwmp);
+ void pwm_lld_stop(PWMDriver *pwmp);
+ bool_t pwm_lld_is_enabled(PWMDriver *pwmp, pwmchannel_t channel);
+ void pwm_lld_set_callback(PWMDriver *pwmp, pwmchannel_t channel,
+ pwmedge_t edge, pwmcallback_t callback);
+ void pwm_lld_enable_channel(PWMDriver *pwmp,
+ pwmchannel_t channel,
+ pwmcnt_t width);
+ void pwm_lld_disable_channel(PWMDriver *pwmp, pwmchannel_t channel);
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* _PWM_LLD_H_ */
+
+/** @} */