Remove unneeded doxygen tags.
[bertos.git] / bertos / drv / pwm.h
index 8bc2bba46464a3baabbd870b11fd2706f22d0024..db00b62a293ebd35baa419944f9595b93c212a82 100644 (file)
  * Copyright 2005 Develer S.r.l. (http://www.develer.com/)
  * -->
  *
- * \version $Id$
  *
- * \brief PWM driver (interface)
+ * \brief Pulse Width Modulation (PWM) driver.
  *
- * \version $Id$
  * \author Francesco Sacchi <batt@develer.com>
  * \author Daniele Basile <asterix@develer.com>
+ *
+ * $WIZ$ module_name = "pwm"
+ * $WIZ$ module_configuration = "bertos/cfg/cfg_pwm.h"
+ * $WIZ$ module_hw = "bertos/hw/pwm_map.h"
+ * $WIZ$ module_supports = "not avr and not cm3"
  */
 
 #ifndef DRV_PWM_H
@@ -50,8 +53,8 @@
 #include <cfg/compiler.h>
 
 #define PWM_MAX_DUTY              ((pwm_duty_t)0xFFFF)
-#define PWM_MAX_PERIOD            0xFFFF
-#define PWM_MAX_PERIOD_LOG2           16
+#define PWM_MAX_PERIOD                         0xFFFF
+#define PWM_MAX_PERIOD_LOG2                        16
 
 /**
  * PWM type define.
@@ -71,16 +74,19 @@ INLINE void pwm_setPolarity(PwmDev dev, bool pol)
 
 void pwm_setDuty(PwmDev dev, pwm_duty_t duty);
 void pwm_setFrequency(PwmDev dev, pwm_freq_t freq);
+void pwm_setPolarity(PwmDev dev, bool pol);
 void pwm_enable(PwmDev dev, bool state);
 void pwm_init(void);
 
-/**
+/*
  * Test function prototypes.
  *
  * See pwm_test.c for implemntation of these functions.
  */
-int pwm_testRun(void);
-int pwm_testSetUp(void);
+void pwm_testRun(void);
+int pwm_testSetup(void);
+/* For backward compatibility */
+#define pwm_testSetUp() pwm_testSetup()
 int pwm_testTearDown(void);
 
 #endif /* DRV_PWM_H */