git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@1419 35acf78f-673a-0410-8e92-d51de3d6d3f4

4 files changed, 44 insertions, 319 deletions

diff --git a/os/hal/hal.dox b/os/hal/hal.dox
index fc5514594..9d0055761 100644
--- a/os/hal/hal.dox
+++ b/os/hal/hal.dox
@@ -257,7 +257,7 @@
 

 /**

  * @defgroup CAN CAN Driver

- * @brief Generic ADC Driver.

+ * @brief Generic CAN Driver.

  * @details This module implements a generic ADC driver. The driver implements

  *          a state machine internally:

  * @dot

@@ -287,12 +287,49 @@
 

 /**

  * @defgroup CAN_LLD CAN Low Level Driver

- * @brief @ref HAL low level driver template.

+ * @brief @ref CAN low level driver template.

  *

  * @ingroup CAN

  */

 

 /**

+ * @defgroup PWM PWM Driver

+ * @brief Generic PWM Driver.

+ * @details This module implements a generic PWM driver. The driver implements

+ *          a state machine internally:

+ * @dot

+  digraph example {

+      rankdir="LR";

+      node [shape=circle, fontname=Helvetica, fontsize=8, fixedsize="true", width="0.8", height="0.8"];

+      edge [fontname=Helvetica, fontsize=8];

+      uninit [label="CAN_UNINIT", style="bold"];

+      stop  [label="CAN_STOP\nLow Power"];

+      ready [label="CAN_READY\nClock Enabled"];

+      sleep [label="CAN_SLEEP\nLow Power"];

+      uninit -> stop [label="canObjectInit()"];

+      stop -> stop [label="canStop()"];

+      stop -> ready [label="canStart()"];

+      ready -> stop [label="canStop()"];

+      ready -> ready [label="canReceive()\ncanTransmit()"];

+      ready -> ready [label="canStart()"];

+      ready -> sleep [label="canSleep()"];

+      sleep -> sleep [label="canSleep()"];

+      sleep -> ready [label="canWakeup()"];

+      sleep -> ready [label="wakeup event"];

+  }

+ * @enddot

+ *

+ * @ingroup IO

+ */

+

+/**

+ * @defgroup PWM_LLD PWM Low Level Driver

+ * @brief @ref PWM low level driver template.

+ *

+ * @ingroup PWM

+ */

+

+/**

  * @defgroup MAC MAC Driver

  * @brief Generic MAC driver.

  * @details This module implements a generic interface for MAC (Media

diff --git a/os/hal/platforms/STM32/pwm_lld.c b/os/hal/platforms/STM32/pwm_lld.c
deleted file mode 100644
index 2d49eb6be..000000000
--- a/os/hal/platforms/STM32/pwm_lld.c
+++ /dev/null
@@ -1,174 +0,0 @@
-/*

-    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 STM32/pwm_lld.c

- * @brief STM32 PWM subsystem low level driver header.

- * @addtogroup STM32_PWM

- * @{

- */

-

-#include "ch.h"

-#include "hal.h"

-

-#if CH_HAL_USE_PWM || defined(__DOXYGEN__)

-

-/** @brief PWM1 driver identifier.*/

-#if defined(USE_STM32_PWM1) || defined(__DOXYGEN__)

-PWMDriver PWMD1;

-#endif

-

-/*===========================================================================*/

-/* Low Level Driver exported variables.                                      */

-/*===========================================================================*/

-

-/*===========================================================================*/

-/* Low Level Driver local variables.                                         */

-/*===========================================================================*/

-

-/*===========================================================================*/

-/* Low Level Driver local functions.                                         */

-/*===========================================================================*/

-

-/*===========================================================================*/

-/* Low Level Driver interrupt handlers.                                      */

-/*===========================================================================*/

-

-/*===========================================================================*/

-/* Low Level Driver exported functions.                                      */

-/*===========================================================================*/

-

-/**

- * @brief Low level PWM driver initialization.

- */

-void pwm_lld_init(void) {

-

-#if USE_STM32_PWM1

-  /* TIM1 reset, ensures reset state in order to avoid trouble with JTAGs.*/

-  RCC->APB2RSTR = RCC_APB2RSTR_TIM1RST;

-  RCC->APB2RSTR = 0;

-

-  /* Driver initialization.*/

-  pwmObjectInit(&PWMD1);

-#endif

-

-}

-

-/**

- * @brief Configures and activates the PWM peripheral.

- *

- * @param[in] pwmp pointer to the @p PWMDriver object

- */

-void pwm_lld_start(PWMDriver *pwmp) {

-

-  if (pwmp->pd_state == PWM_STOP) {

-    /* Clock activation.*/

-#if USE_STM32_PWM1

-    if (&PWMD1 == pwmp) {

-      NVICEnableVector(TIM1_CC_IRQn, STM32_PWM1_IRQ_PRIORITY);

-      RCC->APB2ENR |= RCC_APB2ENR_TIM1EN;

-    }

-#endif

-  }

-  /* Configuration.*/

-}

-

-/**

- * @brief Deactivates the PWM peripheral.

- *

- * @param[in] pwmp pointer to the @p PWMDriver object

- */

-void pwm_lld_stop(PWMDriver *pwmp) {

-

-  /* If in ready state then disables the PWM clock.*/

-  if (pwmp->pd_state == PWM_READY) {

-#if USE_STM32_PWM1

-    if (&PWMD1 == pwmp) {

-      NVICDisableVector(TIM1_CC_IRQn);

-      RCC->APB2ENR &= ~RCC_APB2ENR_TIM1EN;

-    }

-#endif

-  }

-}

-

-/**

- * @brief Determines whatever the PWM channel is already enabled.

- *
- * @param[in] pwmp      pointer to the @p PWMDriver object

- * @param[in] channel   PWM channel identifier

- *

- * @return The PWM channel status.

- * @retval FALSE the channel is not enabled.

- * @retval TRUE the channel is enabled.
- */

-bool_t pwm_lld_is_enabled(PWMDriver *pwmp, pwmchannel_t channel) {

-

-  return FALSE;

-}

-

-/**

- * @brief Enables a callback mode for the specified PWM channel.

- * @details The callback mode must be set before starting a PWM channel.

- *

- * @param[in] pwmp      pointer to the @p PWMDriver object

- * @param[in] channel   PWM channel identifier

- * @param[in] edge      output edge mode

- * @param[in] callback  the callback function

- */

-void pwm_lld_set_callback(PWMDriver *pwmp, pwmchannel_t channel,

-                          pwmedge_t edge, pwmcallback_t callback) {

-

-  if (edge == PWM_NONE) {

-    /* Callback disable.*/

-    pwmp->pd_callbacks[channel] = NULL;

-  }

-  else {

-    /* Callback enable.*/

-    pwmp->pd_callbacks[channel] = callback;

-  }

-}

-

-/**

- * @brief Enables a PWM channel.

- *

- * @param[in] pwmp      pointer to the @p PWMDriver object

- * @param[in] channel   PWM channel identifier

- * @param[in] width     PWM pulse width as clock pulses number

- */

-void pwm_lld_enable_channel(PWMDriver *pwmp,

-                            pwmchannel_t channel,

-                            pwmcnt_t width) {

-

-}

-

-/**

- * @brief Disables a PWM channel.

- * @details The channel is disabled and its output line returned to the

- *          idle state.

- *

- * @param[in] pwmp      pointer to the @p PWMDriver object

- * @param[in] channel   PWM channel identifier

- */

-void pwm_lld_disable_channel(PWMDriver *pwmp, pwmchannel_t channel) {

-

-}

-

-#endif /* CH_HAL_USE_PWM */

-

-/** @} */

diff --git a/os/hal/platforms/STM32/pwm_lld.h b/os/hal/platforms/STM32/pwm_lld.h
deleted file mode 100644
index 92119a74c..000000000
--- a/os/hal/platforms/STM32/pwm_lld.h
+++ /dev/null
@@ -1,138 +0,0 @@
-/*

-    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 STM32/pwm_lld.h

- * @brief STM32 PWM subsystem low level driver header.

- * @addtogroup STM32_PWM

- * @{

- */

-

-#ifndef _PWM_LLD_H_

-#define _PWM_LLD_H_

-

-#if CH_HAL_USE_PWM || defined(__DOXYGEN__)

-

-/*===========================================================================*/

-/* Driver constants.                                                         */

-/*===========================================================================*/

-

-/**

- * @brief Number of PWM channels per PWM driver.
- */

-#define PWM_CHANNELS                4

-

-/*===========================================================================*/

-/* Driver pre-compile time settings.                                         */

-/*===========================================================================*/

-

-/**

- * @brief PWM1 driver enable switch.

- * @details If set to @p TRUE the support for PWM1 is included.

- * @note The default is @p TRUE.

- */

-#if !defined(USE_STM32_PWM1) || defined(__DOXYGEN__)

-#define USE_STM32_PWM1              TRUE

-#endif

-

-/**

- * @brief PWM1 interrupt priority level setting.

- * @note @p BASEPRI_KERNEL >= @p STM32_PWM1_IRQ_PRIORITY > @p PRIORITY_PENDSV.

- */

-#if !defined(STM32_PWM1_IRQ_PRIORITY) || defined(__DOXYGEN__)

-#define STM32_PWM1_IRQ_PRIORITY     0x80

-#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.*/

-  /**

-   * @brief Bit mask of the enabled channels.
-   */

-  uint32_t                  pd_enabled_channels;

-  /**

-   * @brief Callback pointers.
-   */

-  pwmcallback_t             pd_callbacks[PWM_CHANNELS];

-} PWMDriver;

-

-/*===========================================================================*/

-/* External declarations.                                                    */

-/*===========================================================================*/

-

-/** @cond never*/

-#if defined(USE_STM32_PWM1)

-extern PWMDriver PWMD1;

-#endif

-

-#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

-/** @endcond*/

-

-#endif /* CH_HAL_USE_PWM */

-

-#endif /* _PWM_LLD_H_ */

-

-/** @} */

diff --git a/os/various/shell.c b/os/various/shell.c
index 8ba101d01..c069b7fcb 100644
--- a/os/various/shell.c
+++ b/os/various/shell.c
@@ -129,7 +129,7 @@ static bool_t cmdexec(const ShellCommand *scp, BaseChannel *chp,
 /**

  * @brief Shell thread function.

  *
- * @param[in] p pointer to an @p BaseChannel object
+ * @param[in] p pointer to a @p BaseChannel object
  * @return Termination reason.

  * @retval RDY_OK terminated by command.

  * @retval RDY_RESET terminated by reset condition on the I/O channel.
@@ -200,7 +200,7 @@ void shellInit(void) {
 /**

  * @brief Spawns a new shell.

  *
- * @param[in] chp pointer to an @p BaseChannel object
+ * @param[in] scp pointer to a @p ShellConfig object
  * @param[in] size size of the shell working area to be allocated

  * @param[in] prio the priority level for the new shell

  *

@@ -215,7 +215,7 @@ Thread *shellCreate(const ShellConfig *scp, size_t size, tprio_t prio) {
 /**

  * @brief Prints a string.

  *
- * @param[in] chp pointer to an @p BaseChannel object

+ * @param[in] chp pointer to a @p BaseChannel object

  * @param[in] msg pointer to the string
  */

 void shellPrint(BaseChannel *chp, const char *msg) {

@@ -227,7 +227,7 @@ void shellPrint(BaseChannel *chp, const char *msg) {
 /**

  * @brief Prints a string with a final newline.

  *

- * @param[in] chp pointer to an @p BaseChannel object

+ * @param[in] chp pointer to a @p BaseChannel object

  * @param[in] msg pointer to the string

  */

 void shellPrintLine(BaseChannel *chp, const char *msg) {

@@ -239,7 +239,7 @@ void shellPrintLine(BaseChannel *chp, const char *msg) {
 /**

  * @brief Reads a whole line from the input channel.

  *
- * @param[in] chp pointer to an @p BaseChannel object

+ * @param[in] chp pointer to a @p BaseChannel object

  * @param[in] line pointer to the line buffer
  * @param[in] size buffer maximum length

  *