aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/platforms/STM32/pwm_lld.h
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2010-07-27 10:31:19 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2010-07-27 10:31:19 +0000
commit79b97b0f60aa6d99667a6bb4d402c420cb6d856e (patch)
tree4943d621333fe3ec88d921d90deb4925bd362be9 /os/hal/platforms/STM32/pwm_lld.h
parentb91f48eb105c753ef877752f8dde2c6bbbfea36e (diff)
downloadChibiOS-79b97b0f60aa6d99667a6bb4d402c420cb6d856e.tar.gz
ChibiOS-79b97b0f60aa6d99667a6bb4d402c420cb6d856e.tar.bz2
ChibiOS-79b97b0f60aa6d99667a6bb4d402c420cb6d856e.zip
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2094 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/hal/platforms/STM32/pwm_lld.h')
-rw-r--r--os/hal/platforms/STM32/pwm_lld.h55
1 files changed, 28 insertions, 27 deletions
diff --git a/os/hal/platforms/STM32/pwm_lld.h b/os/hal/platforms/STM32/pwm_lld.h
index 4249a8514..8605bb314 100644
--- a/os/hal/platforms/STM32/pwm_lld.h
+++ b/os/hal/platforms/STM32/pwm_lld.h
@@ -18,8 +18,9 @@
*/
/**
- * @file STM32/pwm_lld.h
- * @brief STM32 PWM subsystem low level driver header.
+ * @file STM32/pwm_lld.h
+ * @brief STM32 PWM subsystem low level driver header.
+ *
* @addtogroup STM32_PWM
* @{
*/
@@ -34,7 +35,7 @@
/*===========================================================================*/
/**
- * @brief Number of PWM channels per PWM driver.
+ * @brief Number of PWM channels per PWM driver.
*/
#define PWM_CHANNELS 4
@@ -43,64 +44,64 @@
/*===========================================================================*/
/**
- * @brief PWM1 driver enable switch.
+ * @brief PWM1 driver enable switch.
* @details If set to @p TRUE the support for PWM1 is included.
- * @note The default is @p TRUE.
+ * @note The default is @p TRUE.
*/
#if !defined(USE_STM32_PWM1) || defined(__DOXYGEN__)
#define USE_STM32_PWM1 TRUE
#endif
/**
- * @brief PWM2 driver enable switch.
+ * @brief PWM2 driver enable switch.
* @details If set to @p TRUE the support for PWM2 is included.
- * @note The default is @p TRUE.
+ * @note The default is @p TRUE.
*/
#if !defined(USE_STM32_PWM2) || defined(__DOXYGEN__)
#define USE_STM32_PWM2 TRUE
#endif
/**
- * @brief PWM3 driver enable switch.
+ * @brief PWM3 driver enable switch.
* @details If set to @p TRUE the support for PWM3 is included.
- * @note The default is @p TRUE.
+ * @note The default is @p TRUE.
*/
#if !defined(USE_STM32_PWM3) || defined(__DOXYGEN__)
#define USE_STM32_PWM3 TRUE
#endif
/**
- * @brief PWM4 driver enable switch.
+ * @brief PWM4 driver enable switch.
* @details If set to @p TRUE the support for PWM4 is included.
- * @note The default is @p TRUE.
+ * @note The default is @p TRUE.
*/
#if !defined(USE_STM32_PWM4) || defined(__DOXYGEN__)
#define USE_STM32_PWM4 TRUE
#endif
/**
- * @brief PWM1 interrupt priority level setting.
+ * @brief PWM1 interrupt priority level setting.
*/
#if !defined(STM32_PWM1_IRQ_PRIORITY) || defined(__DOXYGEN__)
#define STM32_PWM1_IRQ_PRIORITY 7
#endif
/**
- * @brief PWM2 interrupt priority level setting.
+ * @brief PWM2 interrupt priority level setting.
*/
#if !defined(STM32_PWM2_IRQ_PRIORITY) || defined(__DOXYGEN__)
#define STM32_PWM2_IRQ_PRIORITY 7
#endif
/**
- * @brief PWM3 interrupt priority level setting.
+ * @brief PWM3 interrupt priority level setting.
*/
#if !defined(STM32_PWM3_IRQ_PRIORITY) || defined(__DOXYGEN__)
#define STM32_PWM3_IRQ_PRIORITY 7
#endif
/**
- * @brief PWM4 interrupt priority level setting.
+ * @brief PWM4 interrupt priority level setting.
*/
#if !defined(STM32_PWM4_IRQ_PRIORITY) || defined(__DOXYGEN__)
#define STM32_PWM4_IRQ_PRIORITY 7
@@ -119,18 +120,18 @@
/*===========================================================================*/
/**
- * @brief PWM channel type.
+ * @brief PWM channel type.
*/
typedef uint8_t pwmchannel_t;
/**
- * @brief PWM counter type.
+ * @brief PWM counter type.
*/
typedef uint16_t pwmcnt_t;
/**
- * @brief PWM driver channel configuration structure.
- * @note It could be empty on some architectures.
+ * @brief PWM driver channel configuration structure.
+ * @note It could be empty on some architectures.
*/
typedef struct {
/**
@@ -139,22 +140,22 @@ typedef struct {
pwmmode_t pcc_mode;
/**
* @brief Channel callback pointer.
- * @details This callback is invoked on the channel compare event. If set to
- * @p NULL then the callback is disabled.
+ * @note This callback is invoked on the channel compare event. If set to
+ * @p NULL then the callback is disabled.
*/
pwmcallback_t pcc_callback;
/* End of the mandatory fields.*/
} PWMChannelConfig;
/**
- * @brief PWM driver configuration structure.
- * @note It could be empty on some architectures.
+ * @brief PWM driver configuration structure.
+ * @note It could be empty on some architectures.
*/
typedef struct {
/**
* @brief Periodic callback pointer.
- * @details This callback is invoked on PWM counter reset. If set to
- * @p NULL then the callback is disabled.
+ * @note This callback is invoked on PWM counter reset. If set to
+ * @p NULL then the callback is disabled.
*/
pwmcallback_t pc_callback;
/**
@@ -172,13 +173,13 @@ typedef struct {
uint16_t pc_arr;
/**
* @brief TIM CR2 register initialization data.
- * @note The value of this field should normally be equal to zero.
+ * @note The value of this field should normally be equal to zero.
*/
uint16_t pc_cr2;
} PWMConfig;
/**
- * @brief Structure representing a PWM driver.
+ * @brief Structure representing a PWM driver.
*/
typedef struct {
/**